This file documents breaking changes introduced in major releases of Reffy. Minor and patch release notes are currently only documented in Git commits.
Reffy adheres to Semantic Versioning.
- Bump minimal supported version of Node.js from v20.12.1 to v20.18.1 (#1717)
Required by dependency on Undici, although note this dependency is only for tests (devDependencies in package.json).
- Bump undici from 6.21.0 to 7.0.0 (#1716)
- Bump puppeteer from 23.8.0 to 23.9.0 (#1711)
- Bump rollup from 4.26.0 to 4.27.4 (#1713)
- Bump respec from 35.1.2 to 35.2.0 (#1714)
- Bump web-specs from 3.26.0 to 3.28.0 (#1715)
- Bump cross-spawn from 7.0.3 to 7.0.6 (#1710)
- Switch to ECMAScript modules (#1628)
Reffy now exports values using ECMAScript modules. This creates two breaking changes:
- If your code needs to import values from Reffy, you will need to switch to ECMAScript modules too, or use a dynamic import.
- The exported
getSchemaValidationFunctionis now asynchronous.
The change does not affect the command-line interface.
- Bump minimal supported version of Node.js from v18 to v20.12.1 (#1590)
Required by dependency on ReSpec, although note this dependency is only for tests (devDependencies in package.json).
- Reduce crawler load on servers (#1587, #1581)
- Include data-xref-type as another hint for autolinks (#1585)
- Skip requests on SVG and CSS resources (#1588)
- Fix Puppeteer instance teardown (#1586)
- Bump respec from 35.0.2 to 35.1.0 (#1583)
- Bump ajv from 8.15.0 to 8.16.0 (#1580)
- Differentiate automatic links from others in link extractors (#1518, #1519, #1520)
This changes the structure of links extracts generated by Reffy to split links into an autolinks object that contains the list of links to external specs automatically generated by the spec authoring tool, and a rawlinks object that contains the list of links that editors created manually. No other change introduced. If you were not relying on the structure of links extracts, this update does not break anything!
- Bump undici from 6.8.0 to 6.9.0 (#1514)
- Bump puppeteer from 22.4.1 to 22.6.0 (#1517)
- Make Reffy skip discontinued specs by default (#1341)
Specs in browser-specs will be more consistently preserved in the list, even when they get abandoned or replaced by other proposals, so that browser-specs can act as a useful source for Specref. Reffy will no longer crawl specs that have a "discontinued" standing in browser-specs. At the time of the change, this affects 5 specs, which used to be crawled by default, and no longer are: DOM-Level-2-Style, selectors-non-element-1, tracking-dnt, wpub-ann, wpub.
- Bump action versions in job (#1342)
- [tests] Adapt to mock headers structure (#1343)
- Bump rollup from 3.26.2 to 3.27.0 (#1345)
- Bump semver from 7.5.3 to 7.5.4 (#1330)
- Bump respec from 34.1.4 to 34.1.6 (#1339)
- Bump webidl2 from 24.4.0 to 24.4.1 (#1332)
- Bump puppeteer from 20.8.0 to 20.9.0 (#1338)
- Bump web-specs from 2.63.0 to 2.65.0 (#1346)
- Bump minimal supported version of Node.js from v14 to v18 (#1271)
Required by dependency on ReSpec, although note this dependency is only for tests (devDependencies in package.json). The crawler itself should continue to run under previous versions of Node for now but this may not last!
- Bump respec from 32.8.0 to 34.0.1 (#1270). This triggers the need to bump the minimal supported version of Node.js.
- Bump puppeteer from 19.9.1 to 19.10.1 (#1267)
- Bump rollup from 3.20.4 to 3.20.7 (#1266)
- Bump semver from 7.4.0 to 7.5.0 (#1264)
- Events: Skip asides in "fire an event" phrasing (#1269)
- Skip non-published specs when
--releaseoption is set (#1214)
The change is breaking in that a crawl on released versions of specs no longer
contains info about specs that do not have a released version. For example,
specs that only exist as living standards such as WHATWG specs are no longer
crawled when the --release option is set. The --release option is typically
used to run a crawl that completes a crawl on the nightly versions of specs.
Goal of the change is to avoid crawling specs that are already in the nightly
crawl.
Crawl results are unaltered otherwise. Tools that use Reffy should only need to
update their logic if they expect a --release crawl to also yield info about
non-released specs.
- ECMAScript spec: Fix dfn scoping and abstract op extraction (#1217)
- Drop legacyValue extraction logic (#1218)
- Encode URI fragments (#1216)
This new major version modifies and completes the CSS extraction logic. See #1117 for details.
No other change was made, meaning breaking and non-breaking changes only affect CSS extracts.
- Arrays are now used throughout instead of indexed objects.
- Function names are no longer enclosed in
<and>because they are not defined in specs with these characters (as opposed to types). Beware though, references to functions in value syntax do use enclosing<and>characters. - The property
valuespacesat the root level is now namedvalues. An array is used there as well. Thevaluesproperty lists bothfunctionandtypedefinitions that are not namespaced to anything in particular (it used to also contain namespaced definitions).
- Selectors are now reported under a
selectorsproperty at the root level. - Possible values that some definition may take are now reported under a
valuesproperty directly within the definition. - Functions and types that are namespaced to some other definition are included
in the list of
valuesof that definition. - Anomalies detected in the spec are now reported under a
warningsproperty at the root of the extract. Four types of anomalies are reported:- Missing definition: when a production rule was found but when the spec
does not include a corresponding
<dfn>(or when that<dfn>does not have adata-dfn-typeattribute that identifies a CSS construct) - Duplicate definition: when the spec defines the same term twice.
- Unmergeable definition: when the spec defines the same property twice and both definitions cannot be merged.
- Dangling value: when the spec defines a CSS "value" definition
(
value,functionortype) for something and that something cannot be found in the spec
- Missing definition: when a production rule was found but when the spec
does not include a corresponding
- To distinguish between
function,typeandvaluedefinitions listed in avaluesproperty, definitions that appear in avaluesproperty have atypeproperty.
- Only namespaced values associated with a definition are listed under its
valuesproperty. Non-namespaced values are not. For instance,<quote>is not listed as a value of the<content-list>type, even though its value syntax references it. This is to avoid duplicating constructs in the extracts. - Values are only listed under the deepest definition to which they apply. For
instance,
open-quoteis only listed as a value of<quote>but neither as a value of the<content-list>type that references<quote>nor as a value of thecontentproperty that references<content-list>. This is also to avoid duplicating constructs in the extracts. - Some of the extracts contain things that may look weird at first, but that is
"by design". For instance, CSS Will
change defines a
<custom-ident>valueconstruct whose actual value is the<custom-ident>typeconstruct defined in CSS Values. Having both a namespacedvalueand a non-namespaced<type>is somewhat common in CSS specs.
Links extracts were restructured to keep original links. See #1055 for details.
- Links extracts now use an object with an
anchorsproperty that lists the said anchors, instead of being listed directly as an array.
CSS extracts were restructured to report at-rules and move descriptors under the at-rule they are for. See #1033 for details.
- The former
descriptorsproperty that appeared at the root level of the extract no longer exists. The same info can be found under the newatrulesproperty.
- At-rules defined by the specification are now reported under an
atrulesproperty at the root level.
This new version splits crawl into a processing step and a post-processing step. See #1015 for details.
- Reffy no longer completes CSS extracts per default to add generated IDL
attributes and add properties defined in prose. Run the crawler with the
csscompletepost-processing module to get the same result. Note thecsscompletemodule will look atdfnsextracts to add properties defined in prose. In other words, command line should include something like:--module dfns --post csscomplete(or not mention--moduleat all as Reffy runs all crawl modules by default) - Reffy no longer outputs parsed CSS structures to the console when CSS extraction runs. This was not used anywhere. It would be trivial to do this in a post-processing module if that seems needed.
- Reffy no longer produces "idlparsed" and "idlnames" extracts per default. Run
the crawler with the
idlparsedandidlnamespost-processing modules. Theidlparsedmodule needsidlextracts to run. Theidlnamesmodule needsidlparsedextracts to run. In other words, command line should include something like:--module idl --post idlparsed --post idlnames(or not mention--moduleat all as Reffy runs all crawl modules by default) - Reffy saves events extracts to an
eventsfolder again (instead ofspec-events). Events extraction and events merging should be viewed as a beta feature for now, likely to be improved in future versions of Reffy.
Major version release triggered by the major bump of web-specs that changes
the semantics of the seriesComposition property, reported in the crawl.
See w3c/browser-specs#535 for
details.
New major version released following the recent commit that separates the raw IDL and the parsed IDL structure in the in-memory model of a crawled spec. See commit 747df3c for details.
- No change to generated extracts but the spec object returned by the
expandCrawlResultsfunction is slightly different. The parsed IDL structure used to be found underspec.idland the raw IDL inspec.idl.idl. The parsed IDL structure now appears underspec.idlparsedand the raw IDL inspec.idl.
- New tool: parsed IDL generator (in
src/cli)
- Serialize Puppeteer setup/teardowns
- Improve network interception test logic