Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider using w3c/webref? #5

Open
dontcallmedom opened this issue Feb 4, 2021 · 2 comments
Open

Consider using w3c/webref? #5

dontcallmedom opened this issue Feb 4, 2021 · 2 comments

Comments

@dontcallmedom
Copy link

W3C now maintains an automatically updated extract of the CSS fragments (along with other spec artefacts) in https://github.com/w3c/webref/ (extracted via https://github.com/w3c/reffy/) - this could serve as a replacement for this project? In particular, it extracts the said fragments from more than the csswg-drafts repo since a few CSS-defining specs are hosted in other repos.

We're looking at guaranteeing in the published fragments parseability by the csstree's css grammar parser - see w3c/reffy#494 where directly related discussion is happening

@lahmatiy
Copy link
Member

Wow! w3c/webref pretty cool project, that I've been looking for years. I'm really happy about it.
csswg-drafts-index was quick and dirty attempt to get something like w3c/webref. However, w3c/webref has gone much further.
I had the following goals for csswg-drafts-index:

  1. To get "machine-readable references of CSS properties, definitions, IDL, and other useful terms". As I can see, w3c/webref provides all I needed. Now I can use w3c/webref instead of my own hacky parsed data.
  2. To have such data as an NPM package. I hope w3c/webref will be published as a NPM package in the future. Would be happy if you share your plans on it.
  3. To have an interface to overview all the specs with cross-references, spec anomaly reports and so on. That's what a web-interface (dashboard) does. I will be happy to play around w3c/webref data the same way. I looked around for some reports (Web Platform exploration with Reffy, WebIDLpedia), and I intend to improve dashboard to have similar functionality in nearby future.
  4. To automate mdn-data sync. Since mdn-data contains additional info (that's not in specs), non-standard CSS properties etc w3c/webref can't replace it for now.
  5. To use this data as a reference in CSS Syntax Reference used for csstree. Not it allows to compare csstree definitions with mdn-data, reports problems in mdn-data etc. I need time to time look into specs to check original definitions. So references to specs would be a great addition.

We're looking at guaranteeing in the published fragments parseability by the csstree's css grammar parser

I would help with a linter or some sort of testing script to achieve it. From my perspective, csstree's definition syntax parser is stable enough and tested on mdn-data and CSSWG spec drafts. Let me know how I can help you.

@dontcallmedom
Copy link
Author

Great to hear of the likely convergence!

re NPM package, we've posted the first one out yesterday for IDL fragments: https://www.npmjs.com/package/@webref/idl

I expect CSS definitions will follow shortly once we figure w3c/reffy#494 out (thanks for commenting there!). I think adding data not extracted from specs to that package would be absolutely in order (esp as MDN browser compat data is already one of the primary customers of webref).

For your 5th use case, if you have more details on what you have in mind, that would definitely help with designing the future package, so please chime in in https://github.com/w3c/webref/issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants