npm run grunt no longer works and needs to be updated to npx grunt

[adityagarg06]

Increasing Access

The current method of setting up the development environment using the command "npm run grunt" is no longer functional. This is due to changes in the way npm handles scripts and dependencies. To address this, we need to update the setup process to use "npx grunt" instead of "npm run grunt."

Most appropriate sub-area of p5.js?

• Accessibility
• Color
• Core/Environment/Rendering
• Data
• DOM
• Events
• Image
• IO
• Math
• Typography
• Utilities
• WebGL
• Build Process
• Unit Testing
• Internalization
• Friendly Errors
• Other (specify if possible)

Feature enhancement details

This issue aims to update the documentation, scripts, or any relevant configuration files to reflect the correct usage of "npx grunt" for setting up the development environment effectively.

[davepagurek]

For some extra context, npm run grunt is suggested here: https://p5js.org/contributor-docs/#/custom_p5_build but gives this error:

We tried npx grunt and it runs, so it looks like maybe npm just changed their command for running dependency binaries and we need to update the docs accordingly.

[limzykenneth]

npm run grunt is supposed to run the script defined under the "script" key in package.json called "grunt", which before was just an alias to grunt. It effectively is a duplicate of npm test in terms of functionality so was removed in 1c09c8f#diff-7ae45ad102eab3b6d7e7896acd08c427a9b25b346470d7bc6507b6481575d519

npx grunt is a npm utility to run binary scripts linked in node_modules/.bin which is not related in this case.

I would suggest correcting https://p5js.org/contributor-docs/#/custom_p5_build and anywhere else that still references npm run grunt to either npm run build (if test is not to be run), npm test (for running everything), or npx grunt if the grunt cli specifically is required.

[Paras0750]

Hey, Can i get a little help. I was trying to setup project locally but i am getting errors while doing npm ci or npm install. I think this might be because of different node version but not sure.

[limzykenneth]

@Paras0750 What you have is unrelated to this issue and is likely a node.js/npm version issue. Please update the node.js and associated npm version to at least node.js 18, if you encounter problem still please open a new issue. Thanks.

[Paras0750]

I upgraded to v18.3.0 now it's working, Thank you @limzykenneth now i can start contributing