feat: pnpm migration #520
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,11 +21,15 @@ jobs: | |
|
|
||
| - uses: jdx/mise-action@v4 | ||
|
|
||
| - uses: pnpm/action-setup@v4 | ||
| with: | ||
| version: 10.5.2 | ||
|
There was a problem hiding this comment.
|
||
|
|
||
| - name: Install dependencies | ||
| run: pnpm install --frozen-lockfile | ||
|
|
||
| - name: Deploy to Sanity | ||
| run: pnpm run deploy:sanity -- --yes | ||
| env: | ||
| SANITY_AUTH_TOKEN: ${{ secrets.SANITY_AUTH_TOKEN }} | ||
| NEXT_PUBLIC_SANITY_PROJECT_ID: ${{ vars.SANITY_PROJECT_ID }} | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,27 +1,27 @@ | ||||||
| # Environment & Commands | ||||||
|
|
||||||
| - **IMPORTANT**: Dev server runs on port 3003 (not 3000): `pnpm run dev` | ||||||
| - Node version: 24.12.0 (managed by Volta) | ||||||
|
There was a problem hiding this comment. This doc says Node is “managed by Volta”, but the repo is configured to manage Node via Mise (
Suggested change
|
||||||
| - TypeScript path aliases: `@/*` (src), `@data/*` (data) | ||||||
| - Required env vars: see .env.example (Sanity, AWS SES, reCAPTCHA) | ||||||
| - Sanity Studio: separate at /studio path | ||||||
|
|
||||||
| ## Key Commands (see package.json for full list) | ||||||
|
|
||||||
| - `pnpm run dev` - Dev server on port 3003 | ||||||
| - `pnpm run test:e2e[:ui|:debug|:report]` - Playwright E2E tests | ||||||
| - `pnpm run crawl:[clubs|fixtures]` - Playwright-based web scraping | ||||||
| - `pnpm run sync:[clubs|fixtures]` - Sync scraped data to Sanity | ||||||
| - `pnpm run type:gen` - Regenerate Sanity types after schema changes | ||||||
|
|
||||||
| # Testing | ||||||
|
|
||||||
| - Framework: Playwright only (no unit test framework) | ||||||
| - Tests run against http://localhost:3003 | ||||||
| - Run E2E tests: `pnpm run test:e2e` | ||||||
| - Run with UI mode: `pnpm run test:e2e:ui` | ||||||
| - Debug mode: `pnpm run test:e2e:debug` | ||||||
| - View report: `pnpm run test:e2e:report` | ||||||
|
|
||||||
| # Technical Requirements | ||||||
|
|
||||||
|
|
@@ -62,11 +62,11 @@ | |||||
| All changes MUST follow the following workflow | ||||||
|
|
||||||
| - After finishing code changes and **before every push**, run all checks in order: | ||||||
| 1. `pnpm run format` | ||||||
| 2. `pnpm run lint` | ||||||
| 3. `pnpm run type:check` | ||||||
| 4. `pnpm run build` | ||||||
| 5. `pnpm run test:e2e` | ||||||
| - Never push without running these checks — commit any formatting changes before pushing | ||||||
| - Pre-commit hooks auto-run: Husky runs lint-staged (prettier + eslint) | ||||||
| - Update any plan files with progress to help with issue tracking | ||||||
|
|
@@ -96,5 +96,5 @@ All changes MUST follow the following workflow | |||||
| - **NEVER**: create "helpers" or "utils" (use services/mappers/transformers) | ||||||
| - Playwright-based web scraping: crawl scripts use playwright-core for data extraction | ||||||
| - Pre-commit hooks auto-run: changes will trigger prettier + eslint | ||||||
| - Run `pnpm run type:gen` after Sanity schema changes | ||||||
| - Prettier line width: 100 chars (not default 80) | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Migrate repo to pnpm | ||
|
|
||
| **Created:** 2026-04-28 | ||
| **Status:** In Progress | ||
|
|
||
| ## Purpose | ||
|
|
||
| Standardize project package manager on pnpm. Keep local docs and GitHub workflows aligned to prevent drift and CI failures. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Use pnpm as canonical package manager for local and CI workflows | ||
| - Remove npm lockfile and commit pnpm lockfile | ||
| - Update script references in active docs and workflow docs | ||
| - Update GitHub Actions install and command steps to pnpm | ||
|
|
||
| ## Todo | ||
|
|
||
| - [x] Generate `pnpm-lock.yaml` from current dependency graph | ||
| - [x] Add `packageManager` in `package.json` | ||
| - [x] Update build script chaining in `package.json` to pnpm | ||
| - [x] Configure `pnpm.onlyBuiltDependencies` for known postinstall/build-script deps | ||
| - [x] Remove `package-lock.json` | ||
| - [x] Migrate `.github/workflows/ci.yml` to pnpm install/exec/run commands | ||
| - [x] Migrate `.github/workflows/crawl.yml` to pnpm install/exec/run commands and lockfile cache key | ||
| - [x] Migrate `.github/workflows/deploy-sanity.yml` to pnpm install/run commands | ||
| - [x] Update command docs in `README.md` | ||
| - [x] Update command docs in `AGENTS.md` | ||
| - [x] Run `pnpm run type:check` | ||
| - [x] Run `pnpm run lint` | ||
| - [x] Run `pnpm run format` | ||
| - [x] Run `pnpm run build` | ||
| - [ ] Run `pnpm run test:e2e` (1 failing test: `tests/search.spec.ts` navigation assertion) | ||
|
|
||
| ## Files | ||
|
|
||
| - `package.json`: set pnpm package manager, update build chaining, add pnpm build-script allowlist | ||
| - `pnpm-lock.yaml`: new lockfile generated via pnpm install | ||
| - `package-lock.json`: removed | ||
| - `.github/workflows/ci.yml`: npm/npx commands replaced with pnpm equivalents | ||
| - `.github/workflows/crawl.yml`: npm/npx commands replaced with pnpm equivalents, cache key now uses pnpm lockfile | ||
| - `.github/workflows/deploy-sanity.yml`: npm commands replaced with pnpm equivalents | ||
| - `README.md`: local setup and schema typegen commands updated to pnpm | ||
| - `AGENTS.md`: workflow command references updated to pnpm |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,10 +3,44 @@ import nextTs from 'eslint-config-next/typescript'; | |
| import prettier from 'eslint-config-prettier/flat'; | ||
| import { defineConfig, globalIgnores } from 'eslint/config'; | ||
|
|
||
| const dependencyCheckConfigValue = { | ||
| files: ['**/*.{js,mjs,cjs,jsx,ts,tsx}'], | ||
| settings: { | ||
| 'import/internal-regex': '^(@/|@data/)', | ||
| 'import/resolver': { | ||
| typescript: { | ||
| project: './tsconfig.json' | ||
| } | ||
| } | ||
| }, | ||
| rules: { | ||
| 'import/no-extraneous-dependencies': [ | ||
| 'error', | ||
|
Comment on lines
+16
to
+18
There was a problem hiding this comment.
Comment on lines
+6
to
+18
There was a problem hiding this comment.
|
||
| { | ||
| packageDir: ['.'], | ||
| devDependencies: [ | ||
| 'bin/**/*.{js,mjs,cjs,ts,tsx}', | ||
| '**/*.test.{js,jsx,ts,tsx}', | ||
| '**/*.spec.{js,jsx,ts,tsx}', | ||
| '**/tests/**/*.{js,jsx,ts,tsx}', | ||
| 'playwright.config.ts', | ||
| 'eslint.config.mjs', | ||
| 'next.config.ts', | ||
| 'sanity.config.ts', | ||
| 'sanity.cli.ts' | ||
| ], | ||
| optionalDependencies: false, | ||
| peerDependencies: false | ||
| } | ||
| ] | ||
| } | ||
| }; | ||
|
|
||
| const eslintConfig = defineConfig([ | ||
| ...nextVitals, | ||
| ...nextTs, | ||
| prettier, | ||
| dependencyCheckConfigValue, | ||
| // Override default ignores of eslint-config-next. | ||
| globalIgnores([ | ||
| // Default ignores of eslint-config-next: | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actions/checkoutis pinned tov6here, while other workflows in the repo useactions/checkout@v4(e.g.crawl.yml). It’s safer to align on a single major version across workflows to avoid unexpected behavior differences and simplify maintenance.