Turn Web IDL into a Living Standard

[annevk]

Helps with #1016.

---

💥 Error: 400 Bad Request 💥

PR Preview failed to build. (Last tried on Sep 3, 2021, 2:15 PM UTC).

More

PR Preview relies on a number of web services to run. There seems to be an issue with the following one:

🚨 CSS Spec Preprocessor - CSS Spec Preprocessor is the web service used to build Bikeshed specs.

🔗 Related URL

Error running preprocessor, returned code: 2.
FATAL ERROR: Found unmatched text macro [COMMIT-SHA]. Correct the macro, or escape it with a leading backslash.
 ✘  Did not generate, due to fatal errors

If you don't have enough information above to solve the error by yourself (or to understand to which web service the error is related to, if any), please file an issue.

[annevk]

A thing I did not realize is that Web IDL has some Node.js-based post processing as well. It's not clear to me if spec-factory's post_build_step is sufficient for that. I suppose it might be...

[annevk]

I essentially added

deploy: index.bs
	curl --remote-name --fail https://resources.whatwg.org/build/deploy.sh
	POST_BUILD_STEP='npm run pp-webidl -- --input index.html' \
	bash ./deploy.sh

to the Makefile to see what kind of errors I would run into. There were a lot. 😟

I ended up suppressing RFC2119 warnings. Given that "optional" is a term that's frequently used that ended up generating too much noise (I suspect "required" as well, but I didn't get that far).

[andreubotella]

The default WHATWG boilerplate includes an entry in the spec metadata section that links to the WPT tests, and I noticed that for Web IDL, the WPT folder it links to is webidl, in lowercase, rather than the correct WebIDL. This results in a 404 when you visit the link. The Bikeshed boilerplate should probably include a WPTDIRNAME macro that defaults to the shortname, so it can be overriden if needed.

[annevk]

Really appreciate your help with this @andreubotella!

@domenic want to take a look? @TimothyGu you might also be interested?

[domenic]

Where does $$DIR come from?

[annevk]

It's passed in as an argument. Encoding does the same thing.

[domenic]

Can we give these examples real IDs? I care about this a good bit so if you can't be bothered I guess I'll volunteer :)

[annevk]

These are the current IDs, for better or worse. I guess I don't feel too strongly about keeping these IDs working, but folks might be linking to them. (I haven't checked, but either this is disabled or Bikeshed must generate a lot of warnings for the document in its current state.)

[domenic]

Oh, that turns this from a "we should fix before merging" to a "we should maybe fix eventually".

[foolip]

Alright, the first deploy worked!
https://webidl.spec.whatwg.org/
https://webidl.spec.whatwg.org/commit-snapshots/37c0e6fe29c50d9c19842135f3f2b265ddcbe932/