eslint-plugin-pnpm

ESLint plugin to enforce and auto-fix pnpm catalogs.

This plugin consists of two set of rules that applies to package.json and pnpm-workspace.yaml respectively.

• json- rules applies to package.json and requires jsonc-eslint-parser to be used as parser.
• yaml- rules applies to pnpm-workspace.yaml and requires yaml-eslint-parser to be used as parser.
  • YAML support is still experimental as it might have race conditions with other plugins.

Setup

pnpm add -D eslint-plugin-pnpm

Basic Usage

// eslint.config.mjs
import { configs } from 'eslint-plugin-pnpm'

export default [
  {
    ignores: ['**/node_modules/**', '**/dist/**'],
  },
  ...configs.json,
  ...configs.yaml,
]

Manual Configuration

// eslint.config.mjs
import pluginPnpm from 'eslint-plugin-pnpm'
import * as jsoncParser from 'jsonc-eslint-parser'
import * as yamlParser from 'yaml-eslint-parser'

export default [
  {
    ignores: ['**/node_modules/**', '**/dist/**'],
  },
  {
    name: 'pnpm/package.json',
    files: [
      'package.json',
      '**/package.json',
    ],
    languageOptions: {
      parser: jsoncParser,
    },
    plugins: {
      pnpm: pluginPnpm,
    },
    rules: {
      'pnpm/json-enforce-catalog': 'error',
      'pnpm/json-valid-catalog': 'error',
      'pnpm/json-prefer-workspace-settings': 'error',
    },
  },
  {
    name: 'pnpm/pnpm-workspace-yaml',
    files: ['pnpm-workspace.yaml'],
    languageOptions: {
      parser: yamlParser,
    },
    plugins: {
      pnpm: pluginPnpm,
    },
    rules: {
      'pnpm/yaml-no-unused-catalog-item': 'error',
      'pnpm/yaml-no-duplicate-catalog-item': 'error',
      'pnpm/yaml-valid-packages': 'error',
    },
  },
]

Rules

JSON Rules (package.json)

• json-enforce-catalog - Enforce catalog usage for dependencies
• json-valid-catalog - Validate catalog references in dependencies
• json-prefer-workspace-settings - Prefer workspace protocol for local dependencies

YAML Rules (pnpm-workspace.yaml)

• yaml-no-unused-catalog-item - Disallow unused catalog items
• yaml-no-duplicate-catalog-item - Disallow duplicate catalog items
• yaml-valid-packages - Ensure package patterns match directories with package.json
• yaml-enforce-settings - Enforce settings in pnpm-workspace.yaml

Settings

| Name | Description | Type | Default | | --------------------- | ----------------------------------------------------------- | ------- | ------- | | ensureWorkspaceFile | Whether to create pnpm-workspace.yaml if it doesn't exist | boolean | false |

Sponsors

License

MIT License © Anthony Fu