[Dev] Migrate from npm to pnpm (#6018)

* Replace `package-lock.json` with `pnpm-lock.yaml`

* Update `package.json`

* Update `lefthook.yml`

* Update GitHub workflows

* Update references to `npm`/`npx`

* Update `CONTRIBUTING.md`

* Update `linting.md` and `comments.md`

* Update comment in `create-test.js`

* Add missing dependency `chalk` for `create-test.js`

.dependency-cruiser.cjs

@@ -323,7 +323,7 @@ module.exports = {
       conditionNames: ["import", "require", "node", "default", "types"],
       /*
          The extensions, by default are the same as the ones dependency-cruiser
-         can access (run `npx depcruise --info` to see which ones that are in
+         can access (run `pnpm exec depcruise --info` to see which ones that are in
          _your_ environment). If that list is larger than you need you can pass
          the extensions you actually use (e.g. [".js", ".jsx"]). This can speed
          up module resolution, which is the most expensive step.

.github/pull_request_template.md

@@ -68,8 +68,8 @@ Do the reviewers need to do something special in order to test your changes?
 - [ ] The PR is self-contained and cannot be split into smaller PRs?
 - [ ] Have I provided a clear explanation of the changes?
 - [ ] Have I tested the changes manually?
-- [ ] Are all unit tests still passing? (`npm run test:silent`)
-  - [ ] Have I created new automated tests (`npm run test:create`) or updated existing tests related to the PR's changes?
+- [ ] Are all unit tests still passing? (`pnpm test:silent`)
+  - [ ] Have I created new automated tests (`pnpm test:create`) or updated existing tests related to the PR's changes?
 - [ ] Have I provided screenshots/videos of the changes (if applicable)?
   - [ ] Have I made sure that any UI change works for both UI themes (default and legacy)?
 

.github/workflows/deploy-beta.yml

@@ -18,15 +18,24 @@ jobs:
         with:
           submodules: "recursive"
           ref: ${{ vars.BETA_DEPLOY_BRANCH || 'beta'}}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
       - uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
+
       - name: Install dependencies
-        run: npm ci
+        run: pnpm i
+
       - name: Build
-        run: npm run build:beta
+        run: pnpm build:beta
         env:
           NODE_ENV: production
+
       - name: Set up SSH
         run: |
           mkdir ~/.ssh
@@ -34,6 +43,7 @@ jobs:
           echo "${{ secrets.BETA_SSH_PRIVATE_KEY }}" > ~/.ssh/id_ed25519
           chmod 600 ~/.ssh/*
           ssh-keyscan -H ${{ secrets.BETA_SSH_HOST }} >> ~/.ssh/known_hosts
+
       - name: Deploy build on server
         run: |
           rsync --del --no-times --checksum -vrm dist/* ${{ secrets.BETA_SSH_USER }}@${{ secrets.BETA_SSH_HOST }}:${{ secrets.BETA_DESTINATION_DIR }}

.github/workflows/deploy.yml

@@ -16,15 +16,24 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
       - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
+
       - name: Install dependencies
-        run: npm ci
+        run: pnpm i
+
       - name: Build
-        run: npm run build
+        run: pnpm build
         env:
           NODE_ENV: production
+
       - name: Set up SSH
         if: github.event_name == 'push' && github.ref_name == 'main'
         run: |
@@ -33,11 +42,13 @@ jobs:
           echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_ed25519
           chmod 600 ~/.ssh/*
           ssh-keyscan -H ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts
+
       - name: Deploy build on server
         if: github.event_name == 'push' && github.ref_name == 'main'
         run: |
           rsync --del --no-times --checksum -vrm dist/* ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}:${{ secrets.DESTINATION_DIR }}
           ssh -t ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "~/prmanifest --inpath ${{ secrets.DESTINATION_DIR }} --outpath ${{ secrets.DESTINATION_DIR }}/manifest.json"
+
       - name: Purge Cloudflare Cache
         if: github.event_name == 'push' && github.ref_name == 'main'
         id: purge-cache

.github/workflows/github-pages.yml

@@ -34,6 +34,11 @@ jobs:
           sudo apt update
           sudo apt install -y git openssh-client
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
       - name: Setup Node 22.14.1
         uses: actions/setup-node@v4
         with:
@@ -50,13 +55,13 @@ jobs:
         working-directory: ${{env.api-dir}}
         run: |
           cd pokerogue_docs
-          npm ci
+          pnpm i
 
       - name: Generate Typedoc docs
         working-directory: ${{env.api-dir}}
         run: |
           cd pokerogue_docs
-          npm run docs -- --out /tmp/docs --githubPages false --entryPoints ./src/
+          pnpm exec typedoc --out /tmp/docs --githubPages false --entryPoints ./src/
 
       - name: Commit & Push docs
         if: github.event_name == 'push'

.github/workflows/linting.yml

@@ -23,17 +23,22 @@ jobs:
         with:
           submodules: 'recursive'
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
-          cache: 'npm'
+          cache: 'pnpm'
 
       - name: Install Node.js dependencies
-        run: npm ci
+        run: pnpm i
 
       - name: Lint with Biome
-        run: npm run biome-ci
+        run: pnpm biome-ci
 
       - name: Check dependencies with depcruise
-        run: npm run depcruise
+        run: pnpm depcruise

.github/workflows/test-shard-template.yml

@@ -28,12 +28,20 @@ jobs:
         uses: actions/checkout@v4.2.2
         with:
           submodules: "recursive"
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
-          cache: "npm"
+          cache: "pnpm"
+
       - name: Install Node.js dependencies
-        run: npm ci
+        run: pnpm i
+
       - name: Run tests
-        run: npx vitest --project ${{ inputs.project }} --no-isolate --shard=${{ inputs.shard }}/${{ inputs.totalShards }} ${{ !runner.debug && '--silent' || '' }}
+        run: pnpm exec vitest --project ${{ inputs.project }} --no-isolate --shard=${{ inputs.shard }}/${{ inputs.totalShards }} ${{ !runner.debug && '--silent' || '' }}

.github/workflows/tests.yml

@@ -1,16 +1,14 @@
 name: Tests
 
 on:
-  # Trigger the workflow on push or pull request,
-  # but only for the main branch
   push:
     branches:
-      - main # Trigger on push events to the main branch
-      - beta # Trigger on push events to the beta branch
+      - main
+      - beta
   pull_request:
     branches:
-      - main # Trigger on pull request events targeting the main branch
-      - beta # Trigger on pull request events targeting the beta branch
+      - main
+      - beta
   merge_group:
     types: [checks_requested]
 
@@ -24,6 +22,7 @@ jobs:
     steps:
       - name: checkout
         uses: actions/checkout@v4
+
       - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36
         id: filter
         with:

CONTRIBUTING.md

@@ -24,14 +24,14 @@ If you have the motivation and experience with Typescript/Javascript (or are wil
 
 ### Prerequisites
 
-- node: >=22.14.0
-- npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- node: >=22.14.0 - [manage with pnpm](https://pnpm.io/cli/env) | [manage with fnm](https://github.com/Schniz/fnm) | [manage with nvm](https://github.com/nvm-sh/nvm)
+- pnpm: 10.x - [how to install](https://pnpm.io/installation) (not recommended to install via `npm` on Windows native) | [alternate method - volta.sh](https://volta.sh/)
 
 ### Running Locally
 
-1. Clone the repo and in the root directory run `npm install`
+1. Clone the repo and in the root directory run `pnpm install`
     - *if you run into any errors, reach out in the **#dev-corner** channel on Discord*
-2. Run `npm run start:dev` to locally run the project in `localhost:8000`
+2. Run `pnpm start:dev` to locally run the project at `localhost:8000`
 
 ### Linting
 
@@ -91,11 +91,11 @@ You can get help testing your specific changes, and you might have found a new o
 
 > PokéRogue uses [Vitest](https://vitest.dev/) for automatic testing. Checking out the existing tests in the [test](./test/) folder is a great way to understand how this works, and to get familiar with the project as a whole.
 
-To make sure your changes didn't break any existing test cases, run `npm run test:silent` in your terminal. You can also provide an argument to the command: to run only the Dancer (ability) tests, you could write `npm run test:silent dancer`. 
+To make sure your changes didn't break any existing test cases, run `pnpm test:silent` in your terminal. You can also provide an argument to the command: to run only the Dancer (ability) tests, you could write `pnpm test:silent dancer`. 
   - __Note that passing all test cases does *not* guarantee that everything is working properly__. The project does not have complete regression testing.
 
 Most non-trivial changes (*especially bug fixes*) should come along with new test cases. 
-  - To make a new test file, run `npm run create-test` and follow the prompts. If the move/ability/etc. you're modifying already has tests, simply add new cases to the end of the file. As mentioned before, the easiest way to get familiar with the system and understand how to write your own tests is simply to read the existing tests, particularly ones similar to the tests you intend to write.
+  - To make a new test file, run `pnpm test:create` and follow the prompts. If the move/ability/etc. you're modifying already has tests, simply add new cases to the end of the file. As mentioned before, the easiest way to get familiar with the system and understand how to write your own tests is simply to read the existing tests, particularly ones similar to the tests you intend to write.
   - Ensure that new tests:
     - Are deterministic. In other words, the test should never pass or fail when it shouldn't due to randomness. This involves primarily ensuring that abilities and moves are never randomly selected.
     - As much as possible, are unit tests. If you have made two distinct changes, they should be tested in two separate cases.

biome.jsonc

@@ -27,6 +27,7 @@
       "!**/.github/**/*",
       "!**/node_modules/**/*",
       "!**/.vscode/**/*",
+      "!**/typedoc/**/*",
       // TODO: lint css and html?
       "!**/*.css",
       "!**/*.html",

docs/comments.md

@@ -23,7 +23,7 @@ When formatted correctly, these comments are shown within VS Code or similar IDE
 - Functions also show the comment for each parameter as you type them, making keeping track of arguments inside lengthy functions much more clear.
 
 They can also be used to generate a commentated overview of the codebase. There is a GitHub action that automatically updates [this docs site](https://pagefaultgames.github.io/pokerogue/main/index.html)
-and you can generate it locally as well via `npm run docs` which will generate into the `typedoc/` directory.
+and you can generate it locally as well via `pnpm run docs` which will generate into the `typedoc/` directory.
 
 ## Syntax
 For an example of how TSDoc comments work, here are some TSDoc comments taken from `src/data/moves/move.ts`:

docs/linting.md

@@ -1,14 +1,10 @@
 # Linting & Formatting
 
-> "Any fool can write code that a computer can understand. Good programmers write code that humans can understand."
->
-> — Martin Fowler
-
 Writing clean, readable code is important, and linters and formatters are an integral part of ensuring code quality and readability.
 It is for this reason we are using [Biome](https://biomejs.dev), an opinionated linter/formatter (akin to Prettier) with a heavy focus on speed and performance.
 
 ### Installation
-You probably installed Biome already without noticing it - it's included inside `package.json` and should've been downloaded when you ran `npm install` after cloning the repo (assuming you followed proper instructions, that is). If you haven't done that yet, go do it.
+You probably installed Biome already without noticing it - it's included inside `package.json` and should've been downloaded when you ran `pnpm install` after cloning the repo. If you haven't done that yet, go do it.
 
 # Using Biome
 
@@ -24,17 +20,11 @@ You will **not** be able to push code with `error`-level linting problems - fix
 
 We also have a [Github Action](../.github/workflows/quality.yml) to verify code quality each time a PR is updated, preventing bad code from inadvertently making its way upstream.
 
-### Why am I getting errors for code I didn't write?
-<!-- TODO: Remove this if/when we perform a project wide linting spree -->
-To save time and minimize friction with existing code, both the pre-commit hook and workflow run will only check files **directly changed** by a given PR or commit.
-As a result, changes to files not updated since Biome's introduction can cause any _prior_ linting errors in them to resurface and get flagged.
-This should occur less and less often as time passes and more files are updated to the new standard.
-
 ## Running Biome via CLI
 If you want Biome to check your files manually, you can run it from the command line like so:
 
 ```sh
-npx biome check --[flags]
+pnpm exec biome check --[flags]
 ```
 
 A full list of flags and options can be found on [their website](https://biomejs.dev/reference/cli/), but here's a few useful ones to keep in mind:
@@ -56,10 +46,3 @@ Some things to consider:
 Any questions about linting rules should be brought up in the `#dev-corner` channel in the discord.
 
 [^1]: A complete list of rules can be found in the `biome.jsonc` file in the project root.
-
-## What about ESLint?
-
-<!-- Remove if/when we finally ditch eslint for good -->
-Our project migrated away from ESLint around March 2025 due to it simply not scaling well enough with the codebase's ever-growing size. The [existing eslint rules](../eslint.config.js) are considered _deprecated_, only kept due to Biome lacking the corresponding rules in its current ruleset.
-
-No additional ESLint rules should be added under any circumstances - even the few currently in circulation take longer to run than the entire Biome formatting/linting suite combined.

lefthook.yml

@@ -1,8 +1,7 @@
 pre-commit:
-  parallel: true
   commands:
     biome-lint:
-      run: npx biome check --write --reporter=summary --staged --no-errors-on-unmatched
+      run: pnpm exec biome check --write --reporter=summary --staged --no-errors-on-unmatched
       stage_fixed: true
       skip:
         - merge

package.json

@@ -22,9 +22,9 @@
     "docs": "typedoc",
     "depcruise": "depcruise src test",
     "depcruise:graph": "depcruise src --output-type dot | node dependency-graph.js > dependency-graph.svg",
-    "postinstall": "npx lefthook install && npx lefthook run post-merge",
-    "update-version:patch": "npm version patch --force --no-git-tag-version",
-    "update-version:minor": "npm version minor --force --no-git-tag-version",
+    "postinstall": "lefthook install && lefthook run post-merge",
+    "update-version:patch": "pnpm version patch --force --no-git-tag-version",
+    "update-version:minor": "pnpm version minor --force --no-git-tag-version",
     "update-locales:remote": "git submodule update --progress --init --recursive --force --remote"
   },
   "devDependencies": {
@@ -33,6 +33,7 @@
     "@types/jsdom": "^21.1.7",
     "@types/node": "^22.13.14",
     "@vitest/coverage-istanbul": "^3.0.9",
+    "chalk": "^5.4.1",
     "dependency-cruiser": "^16.3.10",
     "inquirer": "^12.4.2",
     "jsdom": "^26.0.0",

scripts/create-test/create-test.js

@@ -1,7 +1,7 @@
 /**
  * This script creates a test boilerplate file in the appropriate
  * directory based on the type selected.
- * @example npm run test:create
+ * @example pnpm test:create
  */
 
 import chalk from "chalk";