Add logic to create @webref/css package #115

tidoust · 2021-03-03T16:47:35Z

Code follows the same structure as for the @webref/idl package. Tests make sure that all CSS fragments can be parsed with the Value Definition Syntax parser of CSSTree.

Note that this is not yet the case, there are 10 cases with syntax errors that require the creation of dedicated patches, not included in this pull request.

Actually, I realize that I don't know how to generate patch files. @foolip, what's the best way to do that?

I kept the logic in the index.js file simple and in particular it does not have any logic to actually parse the CSS fragments. I just put an example in the README. Let me know if you believe the parseAll function should also create parsedValue properties.

Related discussion in #111, also in Reffy in w3c/reffy#494

Code follows the same structure as for the `@webref/idl` package. Tests make sure that all CSS fragments can be parsed with the Value Definition Syntax parser of CSSTree. Note that this is not yet the case, there are 10 cases with syntax errors that require the creation of dedicated patches, not included in this commit.

The patches cover obvious grammar issues.

The patches cover constructs that the parser does not yet support and/or that the Value Definition Syntax should be clearer about.

tidoust · 2021-03-04T16:19:47Z

@foolip, I believe that's now ready to merge.

I completed the pull request with CSS patches. Some of them are needed because the parser does not support certain constructs that could nevertheless be legit, see discussion in w3c/reffy#494 (comment)

I would address the possible addition of CSSOM generated IDL, discussed in #111 (comment), separately.

foolip · 2021-03-04T16:27:22Z

@tidoust I'm out this week so please feel free to merge and release the first version without waiting for me!

ed/csspatches/css-tables.json.patch

dontcallmedom · 2021-03-04T16:40:34Z

ed/csspatches/fill-stroke.json.patch

+Subject: [PATCH] Separate stacked combinators
+
+The parser does not support stacked combinators, see discussion in:
+https://github.com/w3c/reffy/issues/494#issuecomment-790713119


I'm a bit reluctant to integrate patches that target the parser limitations rather than spec bugs; or more specifically, I don't like the idea of packaging/releasing wrongly-fixed spec data

I'm reluctant too but what alternative do you suggest while this gets sorted out?
Drop the value fields? Drop the properties? Drop the files?

patch the parser :)

I don't think I'll have the bandwidth to look into that in the next few days, but please do :)

Could we drop this patch and initially not guarantee that everything is possible to parse?

having started to look into patching the parser, I agree that this sounds like the best path forward to get something already useful out sooner rather than later

I dropped the patches. Tests ignore the problematic entries for the time being.

- Bikeshed fixed for css-backgrounds - PR merged for css-tables

The README links to the Web IDL patches documentation for details on how to create and maintain the patches.

foolip

Looking forward to seeing this published :)

packages/css/index.js

packages/css/README.md

test/css/validate.js

test/css/all.js

packages/prepare.js

packages/css/README.md

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

foolip · 2021-03-10T10:00:07Z

Trying to write some code to solve foolip/mdn-bcd-collector#705, I wrote what could become consistency tests:
9ea71c1

The output of that and the many manually added valuespaces could form a burndown list of what needs to be fixed in specs and possibly in Reffy to extract something that's consistent. A good example is that https://drafts.csswg.org/css-shapes-1/#typedef-basic-shape doesn't define the syntax as "<inset()> | <circle()> | <ellipse()> | <polygon()> | <path()>" but merely has a list of allowed values.

packages/css/README.md

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

The problematic entries are explicitly listed in the tests for now. Hopefully, we'll be able to drop this (and the caveat in the README) soon.

I was using a locally patched version of CSSTree so did not notice that one...

tidoust · 2021-03-10T11:41:02Z

Trying to write some code to solve foolip/mdn-bcd-collector#705, I wrote what could become consistency tests:
9ea71c1

The output of that and the many manually added valuespaces could form a burndown list of what needs to be fixed in specs and possibly in Reffy to extract something that's consistent. A good example is that https://drafts.csswg.org/css-shapes-1/#typedef-basic-shape doesn't define the syntax as "<inset()> | <circle()> | <ellipse()> | <polygon()> | <path()>" but merely has a list of allowed values.

We did not maintain that list, which is now likely outdated, but we had done a similar exercise in Reffy with a list of missing value definitions.

tidoust · 2021-03-10T11:43:34Z

I believe I integrated the feedback received. @foolip, how does that look now?

foolip

LGTM % nits

foolip · 2021-03-10T13:02:15Z

packages/css/README.md

@@ -0,0 +1,43 @@
+# 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).


Do we still have this guarantee? If not this and the guarantees section below needs updating.

That is why I added the "(almost)" with a link to the guarantees section, which explains that there remains a handful of exceptions in practice.

packages/css/README.md

test/css/all.js

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Code follows the same structure as for the `@webref/idl` package. Tests make sure that all CSS fragments can be parsed with the Value Definition Syntax parser of CSSTree. A couple of CSS patches need to be applied to the extracts to fix value definitions. Tests currently only guarantee that the value definitions can be parsed with CSSTree, with the exception of a handful value definitions that are a priori valid but that cannot be parsed with the CSSTree parser for the time being, see discussion in: w3c/reffy#494 (comment) Co-authored-by: Philip Jägenstedt <philip@foolip.org>

tidoust requested a review from foolip March 3, 2021 16:47

tidoust added 2 commits March 4, 2021 16:12

Add first series of CSS patches

a006a93

The patches cover obvious grammar issues.

Add final series of CSS patches

bc06d56

The patches cover constructs that the parser does not yet support and/or that the Value Definition Syntax should be clearer about.

dontcallmedom reviewed Mar 4, 2021

View reviewed changes

ed/csspatches/css-tables.json.patch Outdated Show resolved Hide resolved

dontcallmedom reviewed Mar 4, 2021

View reviewed changes

tidoust and others added 4 commits March 4, 2021 18:31

Update link to PR in CSS tables patch

0262e11

Merge branch 'master' into package-css

0e03377

Drop two now useless CSS patches

d5ebbdd

- Bikeshed fixed for css-backgrounds - PR merged for css-tables

Add README for CSS patches

6110035

The README links to the Web IDL patches documentation for details on how to create and maintain the patches.

dontcallmedom mentioned this pull request Mar 8, 2021

[css-values] Stacked modifiers in definitions w3c/csswg-drafts#6085

Closed

Delete svg-markers.json.patch

a488c80

foolip reviewed Mar 9, 2021

View reviewed changes

tidoust and others added 9 commits March 10, 2021 10:10

Update packages/css/index.js

65cfd86

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Update packages/css/README.md

8e16910

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Update test/css/validate.js

8fca0b0

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Update test/css/validate.js

413d21e

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Update test/css/validate.js

ab4e239

Update packages/prepare.js

0d6ed20

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Update packages/prepare.js

850aa70

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Update packages/css/README.md

a0023da

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Drop parseAll, fix async tests

00db259

Update README.md

9f2c651

foolip reviewed Mar 10, 2021

View reviewed changes

packages/css/README.md Outdated Show resolved Hide resolved

tidoust added 3 commits March 10, 2021 11:42

Make sure keys exist, use doesNotThrow

7a211e4

Rename validate.js to parse.js

da89c28

Drop conditional on patchDir presence

6dfa109

tidoust and others added 2 commits March 10, 2021 11:55

Merge branch 'package-css' of github.com:w3c/webref into package-css

0a2d79e

Update packages/css/README.md

0c17e4a

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

This was referenced Mar 10, 2021

Improve extracts for legacy and aliases CSS properties w3c/reffy#538

Open

CSS package: Add test to guarantee the presence of a value definition #126

Open

CSS package: consider additional parsing guarantees #127

Open

tidoust added 3 commits March 10, 2021 12:27

Drop CSS patches that were working around CSSTree limitations

6a660f6

The problematic entries are explicitly listed in the tests for now. Hopefully, we'll be able to drop this (and the caveat in the README) soon.

Merge branch 'package-css' of github.com:w3c/webref into package-css

df67a8d

Add missing construct to ignore

1108f87

I was using a locally patched version of CSSTree so did not notice that one...

foolip approved these changes Mar 10, 2021

View reviewed changes

tidoust and others added 3 commits March 10, 2021 14:14

Update packages/css/README.md

88bf6bd

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Update packages/css/README.md

8d5eef2

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

Update packages/css/README.md

a066a04

Co-authored-by: Philip Jägenstedt <philip@foolip.org>

tidoust mentioned this pull request Mar 10, 2021

Add utility functions to retrieve specs to the package w3c/browser-specs#256

Open

tidoust merged commit 94aa0ae into master Mar 10, 2021

foolip deleted the package-css branch March 10, 2021 14:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add logic to create @webref/css package #115

Add logic to create @webref/css package #115

tidoust commented Mar 3, 2021

tidoust commented Mar 4, 2021

foolip commented Mar 4, 2021

dontcallmedom Mar 4, 2021

tidoust Mar 4, 2021

dontcallmedom Mar 4, 2021

tidoust Mar 8, 2021

foolip Mar 9, 2021

dontcallmedom Mar 9, 2021

tidoust Mar 10, 2021

foolip left a comment

foolip commented Mar 10, 2021

tidoust commented Mar 10, 2021

tidoust commented Mar 10, 2021

foolip left a comment

foolip Mar 10, 2021

tidoust Mar 10, 2021

		@@ -0,0 +1,43 @@
		# 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).

Add logic to create @webref/css package #115

Add logic to create @webref/css package #115

Conversation

tidoust commented Mar 3, 2021

tidoust commented Mar 4, 2021

foolip commented Mar 4, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

foolip left a comment

Choose a reason for hiding this comment

foolip commented Mar 10, 2021

tidoust commented Mar 10, 2021

tidoust commented Mar 10, 2021

foolip left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment