Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
17 tasks
perminder-17 opened this issue Jun 4, 2025 · 5 comments · May be fixed by #7886
Open
17 tasks

Comments

@perminder-17
Copy link
Collaborator

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.

@LalitNarayanYadav
Copy link
Contributor

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!

@ksen0 ksen0 moved this to Ready for Work in p5.js 2.x 🌱🌳 Jun 4, 2025
@ksen0 ksen0 moved this to Ready for Work in p5.js Documentation Jun 4, 2025
@perminder-17
Copy link
Collaborator Author

perminder-17 commented Jun 4, 2025

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:)

@LalitNarayanYadav
Copy link
Contributor

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!

@perminder-17
Copy link
Collaborator Author

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.

@ksen0 ksen0 moved this from Ready for Work to In Progress in p5.js 2.x 🌱🌳 Jun 7, 2025
@ksen0 ksen0 moved this from Ready for Work to In Progress in p5.js Documentation Jun 7, 2025
@ksen0 ksen0 modified the milestones: 2.x Anytime, 2.1 Jun 7, 2025
LalitNarayanYadav added a commit to LalitNarayanYadav/p5.js that referenced this issue Jun 7, 2025
@LalitNarayanYadav
Copy link
Contributor

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Status: In Progress
3 participants