fix: remove runtime dependency on load-rules
#462
Conversation
dynamic loading/requiring of files breaks bundlers as those files will not be available at runtime of bundled code (protofire#461) we accomplish this by adding a script, `npm run generate-rulesets`, which generates a static version of the rulesets
llllvvuu
force-pushed
the
fix/static_require_rulesets
branch
from
f0cddaf to
1538f1e
Compare
| "docs": "node scripts/generate-rule-docs.js" | ||
| "generate-rulesets": "node scripts/generate-rulesets.js && prettier --write conf/rulesets", | ||
| "docs": "node scripts/generate-rule-docs.js", | ||
| "prepare": "husky install", |
There was a problem hiding this comment.
Sorry if it is a dumb question, but
are the 'prepare' and 'prepublishOnly' needed ?
There was a problem hiding this comment.
It's not strictly necessary, but it makes docs and ruleset JSON automatically updated when you commit or publish
There was a problem hiding this comment.
Yes. I know... What I meant is:
Husky executes sh ./scripts/generate-changed.sh on every commit(pre)
That files is calling "generate-rulesets" and also "docs" npm commands (which is the whole purpose of it and it is a good thing)
Maybe I'm missing something but I don't see any call to 'prepare' and 'prepublishOnly'... That is why I asked
There was a problem hiding this comment.
Oh, I see what you're asking.
Those are npm lifecycle scripts. npm will run prepare when you run npm install, that makes sure that git is synced with husky. It's recommended here.
npm will run prepublishOnly when you run npm publish, that makes sure that npm package has up to date rulesets.
There was a problem hiding this comment.
ohh thanks for the clarification
I've never used those...
Thanks for the links as well...
I have one question if you dont mind..
I see in the link you provided the 'prepare'
Runs BEFORE the package is packed, i.e. during npm publish and npm pack
Runs on local npm install without any arguments
Runs AFTER prepublish, but BEFORE prepublishOnly
If I have in github actions to run E2E tests, the npm pack and also npm install and some more...
This means it will do a husky install on each step ?
Thanks!
llllvvuu
force-pushed
the
fix/static_require_rulesets
branch
from
1538f1e to
4b76b89
Compare
|
|
dynamic loading/requiring of files breaks bundlers as those files will not be available at runtime of bundled code (#461)
i accomplish this by adding a script,
npm run generate-rulesets, which generates a static version of the rulesetsi also add prepublish and precommit hook to make sure docs and rulesets are up-to-date if anything in the rules directory has changed