-
Notifications
You must be signed in to change notification settings - Fork 45
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
Add tools/ dir and some handy utilities #702
Conversation
The tools are intended for spec editors to use when authoring and/or reviewing changes. They aren't incorporated into the spec publishing process, but that could be considered in the future. - tools/reformat_js - reformats JS blocks in the spec - tools/lint.mjs - looks for convention violations and other glitches The reformat_js tools has been applied to index.bs
As long promised, here are some tools I've written to help with authoring the spec. They're inconsistent and best effort, but I've found them useful. I think they're too immature to incorporate into the Makefile (does anyone use that?) or the spec publishing action, but iteration is welcome! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for these contributions!
I already test drove the lint tool and found it very helpful 👍
Also FYI I kicked off a thread with spec-prod https://lists.w3.org/Archives/Public/spec-prod/2024AprJun/0003.html - but let's start locally. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks JB. 2 opinionated style thoughts, plus easy ones.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These tools would be very useful! Thanks much @inexorabletash !
Co-authored-by: Ningxin Hu <ningxin.hu@intel.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another nit: you may want to add npm related files into .gitignore:
/tools/node_modules/
/tools/package-lock.json
Done in 1a1e054 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! And verified in my dev environment. Thanks much!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😎 Cool. Thanks JB.
SHA: 74b9831 Reason: push, by fdwr Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
The tools are intended for spec editors to use when authoring and/or reviewing changes. They aren't incorporated into the spec publishing process, but that could be considered in the future.
The reformat-js.py tool has been applied to index.bs
Preview | Diff