docs: update module usage instructions to remove Grunt and reflect dev-2.0 tooling #7871 #7886
Conversation
|
Hi @LalitNarayanYadav thanks for working on this! To link the PR to an issue, please write: "Fixes #7871" (if the issue should be closed when this PR is merged; otherwise, write "Addresses [issue]"). Thank you! |
|
Thanks you @ksen0 ! I'll keep it in mind. |
| npx eslint src/ | ||
| npx eslint test/ |
There was a problem hiding this comment.
Yes, these commands look promising, and the npm run lint command appears to work correctly. Could you confirm whether changing the code’s indentation causes the linter to fail, or does it still pass? In my case, it always passes regardless of indentation.
There was a problem hiding this comment.
The linter isn't implemented in v2+ yet. See #7853
In v1+ it wasn't configured for .md files. So my best bet is to not indent the code snippets.
There was a problem hiding this comment.
Aah...okay. Thanks for letting me know @error-four-o-four :)
There was a problem hiding this comment.
Hi, I think we should also update the overview section. Currently it's something like:
An excellent new [feature](https://github.com/processing/p5.js/pull/2051) of p5.js allows user to build p5.js as a custom combination of its modules. This greatly helps in reducing the production version size of the library, as well as improves overall performance..
I think, the PR we link here adds a grunt task which takes in the arguments of modules it want to bundle together. Maybe we could remove/update it.
| cd p5.js | ||
| npm ci | ||
| npm run grunt | ||
| npm run grunt combineModules:module_x:module_y | ||
| npm run build # builds the full p5.js bundle | ||
| npm test # runs linter and tests using Vitest |
There was a problem hiding this comment.
This section is meant to show how to create a custom build of p5.js with selected components. Right now, the commands only build the full library and run the test suite. We should remove the final npm test line and replace it with the command that actually generates a custom bundle. I’m not sure whether the dev-2.0 branch already supports modular builds, @limzykenneth , could you confirm if dev-2.0 lets users assemble p5.js from a chosen set of modules, and if so, what the exact command is?
| cd p5.js | ||
| npm ci | ||
| npm run grunt | ||
| npm run grunt combineModules:module_x:module_y | ||
| npm run build # builds the full p5.js bundle | ||
| npm test # runs linter and tests using Vitest |
There was a problem hiding this comment.
"runs linter and tests using Vitest" also, this line is misleading. Vitest never “runs the linter”, if you look at the script section, we have two different commands,
"scripts" : {
"test": "vitest",
"lint": "eslint .",
},so, for lint we should write npm run lint, however we can probably remove the commands which is used for running tests in p5js from custom_p5_build.md?
Changes:
npm run buildfor dev-2.0 and guidance on custom builds via Rollup.Fixes #7871
PR Checklist
npm run lintpasses