Skip to content

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

Open
@perminder-17

Description

@perminder-17
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.

Activity

added this to the 2.x Anytime milestone on Jun 4, 2025
LalitNarayanYadav

LalitNarayanYadav commented on Jun 4, 2025

@LalitNarayanYadav
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!

moved this to Ready for Work in p5.js 2.x 🌱🌳on Jun 4, 2025
moved this to Ready for Work in p5.js Documentationon Jun 4, 2025
perminder-17

perminder-17 commented on Jun 4, 2025

@perminder-17
CollaboratorAuthor

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

LalitNarayanYadav commented on Jun 7, 2025

@LalitNarayanYadav
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

perminder-17 commented on Jun 7, 2025

@perminder-17
CollaboratorAuthor

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.

moved this from Ready for Work to In Progress in p5.js 2.x 🌱🌳on Jun 7, 2025

7 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

Status

In Progress

Status

In Progress

Relationships

None yet

    Participants

    @ksen0@perminder-17@LalitNarayanYadav

    Issue actions

      Docs: Remove legacy Grunt commands and transition fully to Vitest / npm scripts in dev-2.0 · Issue #7871 · processing/p5.js