refactor: migrate to pnpm workspace

.github/workflows/CI.yml

@@ -19,12 +19,14 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Install Node.js
         uses: actions/setup-node@v6
       - name: Install Packages
-        run: npm install --legacy-peer-deps
+        run: pnpm install
       - name: Lint
-        run: npm run lint
+        run: pnpm run lint
 
   test:
     name: Test
@@ -35,46 +37,52 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Install Node.js v${{ matrix.node }}
         uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node }}
       - name: Install Packages
-        run: npm install
+        run: pnpm install
       - name: Test
-        run: npm test
+        run: pnpm test
 
   test-with-eslint-v8:
     name: Test with ESLint v8
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Install Node.js v18
         uses: actions/setup-node@v6
         with:
           node-version: 18
       - name: Install Packages
-        run: npm install
+        run: pnpm install
       - name: Install ESLint v8
-        run: npm install --save-dev eslint@8 --force
+        run: pnpm install --save-dev eslint@8 --force
       - name: Test
-        run: npm test
+        run: pnpm test
 
   test-without-eslint-stylistic:
     name: Test without ESLint Stylistic
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Install Node.js
         uses: actions/setup-node@v6
       - name: Install Packages
-        run: npm install
+        run: pnpm install
       - name: Uninstall @stylistic/eslint-plugin
-        run: npm uninstall @stylistic/eslint-plugin
+        run: pnpm uninstall @stylistic/eslint-plugin
       - name: Test
-        run: npm test
+        run: pnpm test
 
   test-with-old-eslint-stylistic:
     name: Test with old ESLint Stylistic
@@ -85,26 +93,30 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Install Node.js
         uses: actions/setup-node@v6
       - name: Install Packages
-        run: npm install
+        run: pnpm install
       - name: Install @stylistic/eslint-plugin v${{ matrix.stylistic }}
-        run: npm install -D @stylistic/eslint-plugin@${{ matrix.stylistic }} --force
+        run: pnpm install -D @stylistic/eslint-plugin@${{ matrix.stylistic }} --force
       - name: Test
-        run: npm test
+        run: pnpm test
 
   test-with-typescript-eslint-v7:
     name: Test with typescript-eslint v7
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Install Node.js
         uses: actions/setup-node@v6
       - name: Install Packages
-        run: npm install
+        run: pnpm install
       - name: Install @typescript-eslint/parser v7
-        run: npm install -D @typescript-eslint/parser@7 --force
+        run: pnpm install -D @typescript-eslint/parser@7 --force
       - name: Test
-        run: npm test
+        run: pnpm test

.github/workflows/Release.yml

@@ -20,18 +20,20 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Setup Node.js
         uses: actions/setup-node@v6
         with:
           node-version: 24
       - name: Install Dependencies
-        run: npm install
+        run: pnpm install
 
       - name: Create Release Pull Request or Publish to npm
         id: changesets
         uses: changesets/action@v1
         with:
-          version: npm run changeset:version
-          publish: npm run changeset:publish
+          version: pnpm run changeset:version
+          publish: pnpm run changeset:publish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/check-for-resources-update.yml

@@ -15,14 +15,16 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
       - name: Install Node.js
         uses: actions/setup-node@v6
         with:
           node-version: 18
       - name: Install Packages
-        run: npm install
+        run: pnpm install
       - name: Update
-        run: npm run update-resources
+        run: pnpm run update-resources
       - uses: peter-evans/create-pull-request@v7
         with:
           commit-message: Updates resources

.gitignore

@@ -7,10 +7,5 @@
 /test.*
 yarn.lock
 yarn-error.log
-/docs/.vitepress/dist
-/docs/.vitepress/build-system/shim/vue-eslint-parser.mjs
-/docs/.vitepress/build-system/shim/@typescript-eslint/parser.mjs
-/docs/.vitepress/.temp
-/docs/.vitepress/cache
 typings/eslint/lib/rules
 eslint-typegen.d.ts

docs/.gitignore

@@ -0,0 +1,5 @@
+.vitepress/dist
+.vitepress/build-system/shim/@typescript-eslint
+.vitepress/build-system/shim/vue-eslint-parser.js
+.vitepress/.temp
+.vitepress/cache

docs/.vitepress/build-system/build.mts → docs/.vitepress/build-system/build.ts

@@ -13,7 +13,7 @@ build(
     dirname,
     '../../../node_modules/@typescript-eslint/parser/dist/index.js'
   ),
-  path.join(dirname, './shim/@typescript-eslint/parser.mjs'),
+  path.join(dirname, './shim/@typescript-eslint/parser.js'),
   [
     'util',
     'node:util',
@@ -29,7 +29,7 @@ build(
 
 build(
   path.join(dirname, '../../../node_modules/vue-eslint-parser/index.js'),
-  path.join(dirname, './shim/vue-eslint-parser.mjs'),
+  path.join(dirname, './shim/vue-eslint-parser.js'),
   [
     'path',
     'debug',
@@ -59,7 +59,7 @@ function bundle(entryPoint: string, externals: string[]) {
     bundle: true,
     external: externals,
     write: false,
-    inject: [path.join(dirname, './src/process-shim.mjs')]
+    inject: [path.join(dirname, './src/process-shim.js')]
   })
 
   return `${result.outputFiles[0].text}`

docs/.vitepress/config.mts → docs/.vitepress/config.ts

@@ -2,11 +2,11 @@ import type { DefaultTheme } from 'vitepress'
 import { defineConfig } from 'vitepress'
 import path from 'pathe'
 import { fileURLToPath } from 'url'
-import { viteCommonjs, vitePluginRequireResolve } from './vite-plugin.mjs'
+import { viteCommonjs, vitePluginRequireResolve } from './vite-plugin'
 import eslint4b, { requireESLintUseAtYourOwnRisk4b } from 'vite-plugin-eslint4b'
 
 // Pre-build cjs packages that cannot be bundled well.
-import './build-system/build.mjs'
+import './build-system/build'
 
 const dirname = path.dirname(fileURLToPath(import.meta.url))
 
@@ -152,17 +152,17 @@ export default async () => {
         alias: {
           'vue-eslint-parser': path.join(
             dirname,
-            './build-system/shim/vue-eslint-parser.mjs'
+            './build-system/shim/vue-eslint-parser.js'
           ),
           '@typescript-eslint/parser': path.join(
             dirname,
-            './build-system/shim/@typescript-eslint/parser.mjs'
+            './build-system/shim/@typescript-eslint/parser.js'
           ),
 
           tslib: path.join(dirname, '../../node_modules/tslib/tslib.es6.js'),
-          globby: path.join(dirname, './build-system/shim/empty.mjs'),
-          'fast-glob': path.join(dirname, './build-system/shim/empty.mjs'),
-          module: path.join(dirname, './build-system/shim/empty.mjs')
+          globby: path.join(dirname, './build-system/shim/empty.js'),
+          'fast-glob': path.join(dirname, './build-system/shim/empty.js'),
+          module: path.join(dirname, './build-system/shim/empty.js')
         }
       },
       define: {

docs/.vitepress/theme/index.ts

@@ -1,22 +1,16 @@
-// @ts-expect-error -- Browser
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import Layout from './Layout.vue'
+import ESLintCodeBlock from './components/eslint-code-block.vue'
+import RulesTable from './components/rules-table.vue'
+
 if (typeof window !== 'undefined' && typeof require === 'undefined') {
-  // @ts-expect-error -- Browser
   ;(window as any).require = () => {
     const e = new Error('require is not defined')
     ;(e as any).code = 'MODULE_NOT_FOUND'
     throw e
   }
 }
-// @ts-expect-error -- Cannot change `module` option
-import type { Theme } from 'vitepress'
-// @ts-expect-error -- Cannot change `module` option
-import DefaultTheme from 'vitepress/theme'
-// @ts-expect-error -- ignore
-import Layout from './Layout.vue'
-// @ts-expect-error -- ignore
-import ESLintCodeBlock from './components/eslint-code-block.vue'
-// @ts-expect-error -- ignore
-import RulesTable from './components/rules-table.vue'
 
 const theme: Theme = {
   ...DefaultTheme,

docs/.vitepress/vite-plugin.mts → docs/.vitepress/vite-plugin.ts

@@ -2,6 +2,7 @@ import type { UserConfig } from 'vitepress'
 import path from 'pathe'
 import { fileURLToPath } from 'url'
 import esbuild from 'esbuild'
+
 type Plugin = Extract<
   NonNullable<NonNullable<UserConfig['vite']>['plugins']>[number],
   { name: string }

docs/package.json

@@ -0,0 +1,8 @@
+{
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vitepress",
+    "build": "vitepress build"
+  }
+}

docs/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "bundler",
+    "lib": ["ESNext", "DOM"],
+  },
+  "include": [
+    ".vitepress/**/*.js",
+    ".vitepress/**/*.ts",
+    ".vitepress/**/*.vue"
+  ]
+}

eslint.config.mjs

@@ -61,8 +61,8 @@
 
       '!.vitepress',
       'docs/.vitepress/dist',
-      'docs/.vitepress/build-system/shim/vue-eslint-parser.mjs',
-      'docs/.vitepress/build-system/shim/@typescript-eslint/parser.mjs',
+      'docs/.vitepress/build-system/shim/vue-eslint-parser.js',
+      'docs/.vitepress/build-system/shim/@typescript-eslint/parser.js',
       'docs/.vitepress/.temp',
       'docs/.vitepress/cache'
     ]
@@ -88,7 +88,7 @@
     ],
     // turn off some rules from shared configs in all files
     rules: {
       'eslint-plugin/require-meta-default-options': 'off', // TODO: enable when all rules have defaultOptions
       'eslint-plugin/require-meta-docs-recommended': 'off', // use `categories` instead
       'eslint-plugin/require-meta-schema-description': 'off',
 
@@ -109,7 +109,7 @@
 
   {
     name: 'typescript/setup',
-    files: ['**/*.{ts,mts}'],
+    files: ['docs/**/*.js', '**/*.{ts,mts}'],
     languageOptions: {
       parser: tsEslintParser,
       parserOptions: {

package.json

@@ -4,6 +4,7 @@
   "description": "Official ESLint plugin for Vue.js",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "packageManager": "pnpm@10.23.0",
   "scripts": {
     "new": "node tools/new-rule.js",
     "start": "npm run test:base -- --watch --growl",
@@ -22,9 +23,9 @@
     "update": "node ./tools/update.js",
     "update-resources": "node ./tools/update-resources.js",
     "typegen": "node ./tools/generate-typegen.mjs",
-    "docs:watch": "vitepress dev docs",
+    "docs:watch": "pnpm -C docs run dev",
     "predocs:build": "npm run update",
-    "docs:build": "vitepress build docs",
+    "docs:build": "pnpm -C docs run build",
     "generate:version": "env-cmd -e version npm run update && npm run lint:fix",
     "changeset:version": "changeset version && npm run generate:version && git add --all",
     "changeset:publish": "npm run typegen && changeset publish"

pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - docs

tsconfig.base.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "noEmit": true,
+    "strict": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true
+  }
+}

tsconfig.json

@@ -1,32 +1,17 @@
 {
+  "extends": "./tsconfig.base.json",
   "compilerOptions": {
     "target": "ES2019",
     "module": "node16",
     "moduleResolution": "Node16",
     "lib": ["es2020"],
-    "allowJs": true,
-    "checkJs": true,
-    "noEmit": true,
-    "strict": true,
-    "noImplicitAny": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
     "baseUrl": ".",
     "paths": {
       "*": ["typings/*"]
-    },
-    "skipLibCheck": true
+    }
   },
   "include": [
     "lib/**/*",
     "typings/eslint-plugin-vue/global.d.ts",
-    "docs/.vitepress/**/*.ts",
-    "docs/.vitepress/**/*.mts"
   ]
 }