Skip to content

v2.0.0

Choose a tag to compare

View all tags
@rviscomi rviscomi released this 25 Nov 21:49
· 8 commits to main since this release
v2.0.0
8bcc780
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

⚠️ Breaking Changes

Programmatic API Restructuring

The library has been refactored to provide a more direct and modern API. The previous version exported modules as namespaces, whereas v2.0.0 exports functions and constants directly.

Before (v1):

import { rules, validation } from '@rviscomi/capo.js';

const weight = rules.getWeight(element);
const isValid = validation.isValidElement(element);

After (v2):

import { getWeight, isValidElement, BrowserAdapter } from '@rviscomi/capo.js';

const adapter = new BrowserAdapter();
const weight = getWeight(element, adapter);
const isValid = isValidElement(element, adapter);

Removal of WebPageTest and BigQuery Support

Support for WebPageTest and BigQuery has been removed from the core library to reduce maintenance burden and focus on the core analysis engine.

Removal of Capo.js Snippet

The standalone Capo.js snippet has been removed. Users are encouraged to use the Chrome extension or the programmatic API.

🚀 New Features & Improvements

New Adapter System

Capo.js now supports a flexible adapter system, allowing it to run on different DOM implementations.

  • Built-in adapter: The BrowserAdapter is provided for standard browser DOM environments.
  • Custom adapters: Consumers can implement their own adapters by extending the base AdapterInterface class. This enables Capo.js to work with different parsers (like JSDOM or ASTs), unlocking its use in static analysis tools.

New Validation Rules

  • Font preload missing crossorigin: Capo.js now validates that font preloads include the crossorigin attribute.

Virtual Console

The demo page now includes a virtual console, making it easier to see Capo output right in the docs, without needing to open the browser console.

🛠️ Internal Improvements

  • Refactored Core Logic: Core analysis logic has been moved to a dedicated analyzer and adapter-based architecture.
  • Improved Test Coverage: Significant increase in test coverage with new integration and unit tests.
  • Modernized Build Tooling: Updated dependencies and build configuration.

For detailed migration instructions, refer to the Migration Guide.

Full Changelog: v.1.5.3...v2.0.0

Assets 2
Loading