p5.js icon indicating copy to clipboard operation
p5.js copied to clipboard

Docs: Remove legacy Grunt commands and transition fully to Vitest / npm scripts in dev-2.0

Open perminder-17 opened this issue 7 months ago • 7 comments

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
  • [ ] Internationalization
  • [ ] Friendly errors
  • [ ] Other (specify if possible)

p5.js version

2.0

Web browser and version

Firefox

Operating system

Linux

Steps to reproduce this

In p5.js ≤ 1.x, repetitive tasks such as running unit tests were orchestrated through Grunt, with all task definitions living in a Gruntfile.js. Starting with the dev-2.0 branch we have removed Grunt entirely. The test suite now runs with Vitest.

However, several references to grunt … commands still exist across the codebase, These stale instructions can mislead contributors who expect Grunt to be available.

So, the task would be to replace each instance with the correct Vitest/ npm script invocation, or remove it if there is no modern equivalent.

Cleaning up these leftovers will make the contribution experience smoother and ensure our documentation accurately represents the 2.0 toolchain.

I already worked on the file unit_testing.md, so the next step would be to look for all other files which uses grunt and replace it with the correct docs.

perminder-17 avatar Jun 04 '25 00:06 perminder-17

Hi! I came across this issue and would like to work on it. Just wanted to confirm — is this issue open for contribution, and would it be okay if I proceed with updating the remaining documentation files that reference grunt ?

Thanks!

LalitNarayanYadav avatar Jun 04 '25 18:06 LalitNarayanYadav

would it be okay if I proceed with updating the remaining documentation files that reference grunt

Hi @LalitNarayanYadav , Really thanks for showing interest for working on this issue. It would be really helpful. Just to mention, I have worked on for the file unit_testing.md you can take reference from. Please feel free to open a PR for dev-2.0 branch. I have assigned you. Thanks:)

perminder-17 avatar Jun 04 '25 21:06 perminder-17

Hi @perminder-17 ,

I’ve updated the documentation files to replace deprecated grunt commands with the current npm/vitest scripts as per the dev-2.0 branch. Could you please review these changes? Once approved, I will continue updating the remaining documentation files referencing grunt. Please let me know if something is wrong there.

Thanks!

LalitNarayanYadav avatar Jun 07 '25 00:06 LalitNarayanYadav

Hi, really thanks for your quick work on this. You are going right on this, I can maybe have some minor changes but it looks good so far :). Once you're done feel free to make a Pull request, I can review and approve it.

perminder-17 avatar Jun 07 '25 01:06 perminder-17

Hi @perminder-17 ! I have created a PR related to this. Please review it when you have time and let me know if any change is required. Thanks in advance!

LalitNarayanYadav avatar Jun 07 '25 10:06 LalitNarayanYadav

The contributor_guidelines.md file still mentions Gruntfile.js in the "Codebase breakdown" section.

sidwellr avatar Nov 09 '25 03:11 sidwellr

Hi @sidwellr thanks for mentioning that. https://github.com/processing/p5.js/pull/8245 I have opened up a PR removing that, Can you have a look?

perminder-17 avatar Nov 09 '25 08:11 perminder-17