feat(eslint): add eslint-plugin-pnpm (#267)

lachlancollins · web-flow · commit 93e778343d16 · 2025-07-19T12:46:41.000+10:00
* feat(eslint): add eslint-plugin-pnpm

* Update stylistic

* Update changeset
diff --git a/.changeset/brown-ants-burn.md b/.changeset/brown-ants-burn.md
@@ -0,0 +1,5 @@
+---
+'@tanstack/eslint-config': minor
+---
+
+chore: update @stylistic/eslint-plugin
diff --git a/.changeset/slow-cougars-cut.md b/.changeset/slow-cougars-cut.md
@@ -0,0 +1,6 @@
+---
+'@tanstack/config': minor
+'@tanstack/eslint-config': minor
+---
+
+feat: add eslint-plugin-pnpm
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,5 @@
+// @ts-check
+
+import { tanstackConfig } from './packages/eslint-config/src/index.js'
+
+export default [...tanstackConfig]
diff --git a/integrations/react/tests/build.test.ts b/integrations/react/tests/build.test.ts
@@ -1,4 +1,4 @@
-import { readdirSync, readFileSync } from 'node:fs'
+import { readFileSync, readdirSync } from 'node:fs'
 import { fileURLToPath } from 'node:url'
 import { dirname, resolve } from 'node:path'
 import { describe, expect, it } from 'vitest'
diff --git a/integrations/vanilla/tests/build.test.ts b/integrations/vanilla/tests/build.test.ts
@@ -1,4 +1,4 @@
-import { readdirSync, readFileSync } from 'node:fs'
+import { readFileSync, readdirSync } from 'node:fs'
 import { fileURLToPath } from 'node:url'
 import { dirname, resolve } from 'node:path'
 import { describe, expect, it } from 'vitest'
diff --git a/integrations/vue/tests/build.test.ts b/integrations/vue/tests/build.test.ts
@@ -1,4 +1,4 @@
-import { readdirSync, readFileSync } from 'node:fs'
+import { readFileSync, readdirSync } from 'node:fs'
 import { fileURLToPath } from 'node:url'
 import { dirname, resolve } from 'node:path'
 import { describe, expect, it } from 'vitest'
diff --git a/package.json b/package.json
@@ -14,7 +14,7 @@
     "test:ci": "nx run-many --targets=test:eslint,test:types,test:build,test:sherif,build",
     "test:build": "nx affected --target=test:build",
     "test:types": "nx affected --target=test:types",
-    "test:eslint": "nx affected --target=test:eslint",
+    "test:eslint": "eslint '**/*'",
     "test:format": "pnpm run prettier --check",
     "test:sherif": "sherif",
     "build": "nx affected --target=build",
@@ -27,6 +27,12 @@
     "changeset:version": "changeset version && pnpm install --no-frozen-lockfile && pnpm prettier:write",
     "changeset:publish": "changeset publish"
   },
+  "nx": {
+    "includedScripts": [
+      "test:eslint",
+      "test:sherif"
+    ]
+  },
   "devDependencies": {
     "@changesets/cli": "catalog:",
     "@svitejs/changesets-changelog-github-compact": "catalog:",
diff --git a/packages/config/package.json b/packages/config/package.json
@@ -16,7 +16,6 @@
   },
   "scripts": {
     "test:types": "tsc",
-    "test:eslint": "eslint ./src",
     "test:build": "publint --strict",
     "build": "vite build"
   },
diff --git a/packages/eslint-config/eslint.config.js b/packages/eslint-config/eslint.config.js
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -16,7 +16,6 @@
   },
   "scripts": {
     "test:types": "tsc",
-    "test:eslint": "eslint ./src",
     "test:build": "publint --strict"
   },
   "type": "module",
@@ -41,9 +40,12 @@
     "@stylistic/eslint-plugin": "catalog:",
     "eslint-plugin-import-x": "catalog:",
     "eslint-plugin-n": "catalog:",
+    "eslint-plugin-pnpm": "catalog:",
     "globals": "catalog:",
+    "jsonc-eslint-parser": "catalog:",
     "typescript-eslint": "catalog:",
-    "vue-eslint-parser": "catalog:"
+    "vue-eslint-parser": "catalog:",
+    "yaml-eslint-parser": "catalog:"
   },
   "devDependencies": {
     "@types/eslint": "catalog:",
diff --git a/packages/eslint-config/src/import.js b/packages/eslint-config/src/import.js
@@ -10,8 +10,6 @@ export const importRules = {
   'import/newline-after-import': 'error',
   /** No require() or module.exports */
   'import/no-commonjs': 'error',
-  /** No import loops */
-  'import/no-cycle': 'error',
   /** Reports if a resolved path is imported more than once */
   'import/no-duplicates': 'error',
   /** Stylistic preference */
diff --git a/packages/eslint-config/src/index.js b/packages/eslint-config/src/index.js
@@ -1,18 +1,18 @@
 import tseslint from 'typescript-eslint'
-import vueparser from 'vue-eslint-parser'
-import stylisticJs from '@stylistic/eslint-plugin'
-import pluginImport from 'eslint-plugin-import-x'
-import pluginNode from 'eslint-plugin-n'
+import jsoncParser from 'jsonc-eslint-parser'
+import vueParser from 'vue-eslint-parser'
+import yamlParser from 'yaml-eslint-parser'
+import stylisticPlugin from '@stylistic/eslint-plugin'
+import importPlugin from 'eslint-plugin-import-x'
+import nodePlugin from 'eslint-plugin-n'
+import pnpmPlugin from 'eslint-plugin-pnpm'
 import globals from 'globals'
 import { javascriptRules } from './javascript.js'
 import { importRules } from './import.js'
 import { typescriptRules } from './typescript.js'
 import { nodeRules } from './node.js'
 import { stylisticRules } from './stylistic.js'
 
-const JS_GLOB_INCLUDE = ['**/*.{js,ts,tsx}']
-const VUE_GLOB_INCLUDE = ['**/*.vue']
-
 const GLOB_EXCLUDE = [
   '**/.nx/**',
   '**/.svelte-kit/**',
@@ -32,10 +32,10 @@ const jsRules = {
 }
 
 const jsPlugins = {
-  '@stylistic/js': stylisticJs,
+  '@stylistic': stylisticPlugin,
   '@typescript-eslint': tseslint.plugin,
-  import: pluginImport,
-  node: pluginNode,
+  import: importPlugin,
+  node: nodePlugin,
 }
 
 /** @type {import('eslint').Linter.Config[]} */
@@ -45,8 +45,8 @@ export const tanstackConfig = [
     ignores: GLOB_EXCLUDE,
   },
   {
-    name: 'tanstack/setup',
-    files: JS_GLOB_INCLUDE,
+    name: 'tanstack/javascript',
+    files: ['**/*.{js,ts,tsx}'],
     languageOptions: {
       sourceType: 'module',
       ecmaVersion: 2020,
@@ -66,9 +66,9 @@ export const tanstackConfig = [
   },
   {
     name: 'tanstack/vue',
-    files: VUE_GLOB_INCLUDE,
+    files: ['**/*.vue'],
     languageOptions: {
-      parser: vueparser,
+      parser: vueParser,
       parserOptions: {
         sourceType: 'module',
         ecmaVersion: 2020,
@@ -84,4 +84,33 @@ export const tanstackConfig = [
     plugins: jsPlugins,
     rules: jsRules,
   },
+  {
+    name: 'tanstack/package-json',
+    files: ['package.json', '**/package.json'],
+    languageOptions: {
+      parser: jsoncParser,
+    },
+    plugins: {
+      pnpm: pnpmPlugin,
+    },
+    rules: {
+      'pnpm/json-enforce-catalog': 'error',
+      'pnpm/json-valid-catalog': 'error',
+      'pnpm/json-prefer-workspace-settings': 'error',
+    },
+  },
+  {
+    name: 'tanstack/pnpm-workspace',
+    files: ['pnpm-workspace.yaml'],
+    languageOptions: {
+      parser: yamlParser,
+    },
+    plugins: {
+      pnpm: pnpmPlugin,
+    },
+    rules: {
+      'pnpm/yaml-no-unused-catalog-item': 'error',
+      'pnpm/yaml-no-duplicate-catalog-item': 'error',
+    },
+  },
 ]
diff --git a/packages/eslint-config/src/stylistic.js b/packages/eslint-config/src/stylistic.js
@@ -3,5 +3,5 @@
 /** @type {import('eslint').Linter.RulesRecord} */
 export const stylisticRules = {
   /** Enforce consistency of spacing after the start of a comment */
-  '@stylistic/js/spaced-comment': 'error',
+  '@stylistic/spaced-comment': 'error',
 }
diff --git a/packages/publish-config/eslint.config.js b/packages/publish-config/eslint.config.js
diff --git a/packages/publish-config/package.json b/packages/publish-config/package.json
@@ -16,7 +16,6 @@
   },
   "scripts": {
     "test:types": "tsc",
-    "test:eslint": "eslint ./src",
     "test:build": "publint --strict"
   },
   "type": "module",
diff --git a/packages/typedoc-config/eslint.config.js b/packages/typedoc-config/eslint.config.js
diff --git a/packages/typedoc-config/package.json b/packages/typedoc-config/package.json
@@ -16,7 +16,6 @@
   },
   "scripts": {
     "test:types": "tsc",
-    "test:eslint": "eslint ./src",
     "test:build": "publint --strict"
   },
   "type": "module",
diff --git a/packages/vite-config/eslint.config.js b/packages/vite-config/eslint.config.js
diff --git a/packages/vite-config/package.json b/packages/vite-config/package.json
@@ -16,7 +16,6 @@
   },
   "scripts": {
     "test:types": "tsc",
-    "test:eslint": "eslint ./src",
     "test:build": "publint --strict"
   },
   "type": "module",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
diff --git a/tsconfig.json b/tsconfig.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@tanstack/eslint-config': minor
 +---
++
 +chore: update @stylistic/eslint-plugin
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { readdirSync, readFileSync } from 'node:fs'`
	`1`	`+import { readFileSync, readdirSync } from 'node:fs'`
`2`	`2`	`import { fileURLToPath } from 'node:url'`
`3`	`3`	`import { dirname, resolve } from 'node:path'`
`4`	`4`	`import { describe, expect, it } from 'vitest'`