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 5 months ago • 5 comments
trafficstars

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