@webref/css 6.23.0 → 7.0.0-alpha

package/CHANGELOG.md

@@ -7,6 +7,23 @@ Webref adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
 applied to data. A new major version is released whenever a breaking change is
 made to the data structure.
 
+## v7.0.0 - 2025-06
+
+CSS extracts are now consolidated into a single file.
+
+### Breaking changes
+
+- A single consolidated `css.json` file replaces CSS extracts per spec.
+
+### How to upgrade
+
+In version 6, `listAll()` resolved with an object where the keys were spec shortnames, and the values mostly matched the structure of the consolidated object that the function now returns. On top of the consolidation itself, main differences are:
+- Functions and types were merged in a `values` category in version 6, they now appear in separate `functions` and `types` categories.
+- Functions and types that were scoped to another CSS feature appeared nested under that CSS feature in version 6. They now appear directly under `functions` and `types` with a `for` key that contains the name of the scoping feature.
+- The shortname of the spec (or specs) that defines a feature is no longer readily available (but note the `href` key targets the defining spec). If you need the specs' shortnames, please [raise an issue](https://github.com/w3c/webref/issues) to describe your use case.
+- The consolidation removes duplicates, merging extended definitions into a single feature. The definition from the latest spec level is used when a feature is defined in more than one level. If you need the definition from earlier levels, please [raise an issue](https://github.com/w3c/webref/issues) to describe your needs!
+- Some of the possible values that a CSS feature could take appeared nested under that feature definition in a `values` key in version 6. Such values are no longer reported in the new version: they were confusing in any case because they did not cover the whole range of values that a feature could take, and could contain values that were not atomic keyword values. Values could be re-introduced when CSS specs are more systematic about them. In the meantime, you will need to parse the feature's syntax (the `value` key) to extract keyword values.
+
 
 ## v6.0.0 - 2022-11-28
 

package/README.md

@@ -1,46 +1,61 @@
 # CSS definitions of the web platform
 
-This package contains CSS property definitions scraped from the latest versions of web platform specifications in [webref](https://github.com/w3c/webref), with fixes applied to ensure ([almost](#guarantees)) all CSS value definitions can be parsed with [CSSTree](https://github.com/csstree/csstree).
+This package contains a consolidated list of CSS features defined across specs, scraped from the latest versions of web platform specifications in [webref](https://github.com/w3c/webref). Fixes are applied to ensure that [guarantees](#guarantees) hold, including the ability to parse syntaxes associated with CSS features with [CSSTree](https://github.com/csstree/csstree).
+
+**Important:** If you're migrating from version 6, see the [changelog](CHANGELOG.md) for "How to upgrade" considerations.
 
 # API
 
-The async `listAll()` method resolves with an object where the keys are spec shortnames, and the values are the data for that spec. Example:
+The async `listAll()` method resolves with an object that contains lists of features grouped by feature type: `atrules`, `functions`, `properties`, `selectors` and `types`. Example:
 
 ```js
 const css = require('@webref/css');
 
-const parsedFiles = await css.listAll();
-for (const [shortname, data] of Object.entries(parsedFiles)) {
-  // do something with the json object
+const { atrules, functions, properties, selectors, types } = await css.listAll();
+
+for (const feature of functions) {
+  // do something with the object that describes the CSS function
 }
 ```
 
-CSS fragments that appear in the objects, in other words the contents of the `properties[].value`, `properties[].newValues`, `atrules[].value`, `atrules[].descriptors[].value`, `selectors[].value` and `values[].value` properties can be parsed with the [CSSTree Value Definition Syntax parser](https://github.com/csstree/csstree/blob/master/docs/definition-syntax.md#value-definition-syntax). Example:
+Each CSS feature is described by:
+- a `name` key that contains the name of the feature
+- an `href` key that contains the URL (with a fragment) of the CSS spec that defines the feature
+
+Many CSS features also have a `value` key that describes the syntax of the feature, as defined in the spec. This syntax can be parsed with the [CSSTree Value Definition Syntax parser](https://github.com/csstree/csstree/blob/master/docs/definition-syntax.md#value-definition-syntax). Example:
 
 ```js
 const css = require('@webref/css');
 const { definitionSyntax } = require('css-tree');
 
-const parsedFiles = await css.listAll();
-for (const [shortname, data] of Object.entries(parsedFiles)) {
-  for (const property of data.properties) {
-    if (property.value) {
-      try {
-        const ast = definitionSyntax.parse(property.value);
-        // do something with the ast
-      }
-      catch {
-        // one of the few value definitions that cannot yet be parsed by CSSTree
-      }
-    }
+const { properties } = await css.listAll();
+for (const property of properties) {
+  if (!property.value) {
+    continue;
   }
+  const ast = definitionSyntax.parse(property.value);
+  // do something with the abstract syntax tree
 }
 ```
 
+Additional keys may be set depending on the type of the CSS feature. For example:
+
+- At-rules have a `descriptors` key that contains the list of descriptors defined for the given at-rule.
+- Functions and types that are scoped to a property or other feature have a `for` key that contains the name of the scoping property or other feature.
+- Properties have a `styleDeclaration` key that contains the list of IDL attribute names that the property generates. A number of other keys may be set to describe the property's initial value, animation type and other parameters.
+
+Additional notes:
+- Type names are enclosed in `<>`. For example: `<frequency-percentage>`.
+- When a feature is defined across different levels in the same spec series, the definition from the latest level is used.
+- When a property is extended with new values in different specs, `href` links to the base definition and `value` is the union (using `|`) of the syntaxes of the base and extended definitions.
+- When new descriptors are defined for an at-rule in different specs, `descriptors` contains the merged list of known descriptors.
+- When specs define the syntax of an at-rule in terms of `<declaration-list>` or `<declaration-rule-list>`, the `value` key contains an "expanded" syntax that leverages the syntax of the at-rule's descriptors.
+
 # Guarantees
 
 The following guarantees are provided by this package:
-- All values in CSS files can be parsed by the version of [CSSTree](https://github.com/csstree/csstree) used in `peerDependencies` in `package.json`.
-- No duplicate definitions of entries in CSS files provided that CSS extracts of [delta specs](https://github.com/w3c/browser-specs/#seriescomposition) are not taken into account (such extracts end with `-n.json`, where `n` is a level number). The term "entries" includes CSS properties, at-rules, selectors, types and functions. Please note that specs may still extend entries defined elsewhere (to define new values for CSS properties, or new selectors for at-rules).
-- CSS extracts contain a base definition of all CSS properties that get extended by other CSS property definitions (those for which `newValues` is set).
-- All entries in CSS files that do not extend a base definition link back to their actual definition in the spec. In other words, all entries under `properties[]`, `properties[].values[]`, `selectors[]`, `atrules[]` and `values[]` have an `href` key that contains an absolute URL with fragment, except properties that that have a `newValues` key, at-rules that neither have a `prose` nor a `value` key, and definitions of a [delta spec](https://github.com/w3c/browser-specs/#seriescomposition) that completely override a definition in a previous level.
+- All syntax values (the `value` keys) can be parsed by the version of [CSSTree](https://github.com/csstree/csstree) set in `peerDependencies` in `package.json`.
+- Feature names (the `name` keys) are unique per type provided that the `for` key is also taken into account for functions and types.
+- All features have an `href` key that targets the CSS spec that defines the feature. When the feature is extended across CSS specs, this URL targets the base definition.
+
+*Note:* there is no guarantee that functions, properties and types referenced by other constructs actually exist. The grammar is known to be incomplete.