eslint-plugin-eslint-plugin

An ESLint plugin for linting ESLint plugins. Rules written in CJS, ESM, and TypeScript are all supported.

• Installation
• Usage
• Rules
  • Rules
  • Tests
• Presets
  • Semantic versioning policy
  • Preset usage

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-eslint-plugin:

npm install eslint-plugin-eslint-plugin --save-dev

Usage

Here's an example ESLint configuration that:

• Enables the recommended configuration
• Enables an optional/non-recommended rule

Note: you might need to set sourceType to module or script depending on your codebase.

// eslint.config.js
import eslintPlugin from 'eslint-plugin-eslint-plugin';

export default [
  eslintPlugin.configs.recommended,
  {
    rules: {
      'eslint-plugin/require-meta-docs-description': 'error',
    },
  },
];

Rules

💼 Configurations enabled in.
✅ Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.
💡 Manually fixable by editor suggestions.
💭 Requires type information.

Rules

Tests

Presets

Semantic versioning policy

The list of recommended rules will only change in a major release of this plugin. However, new non-recommended rules might be added in a minor release of this plugin. Therefore, using the all, rules, and tests presets is not recommended for production use, because the addition of new rules in a minor release could break your build.

Preset usage

Example of applying the recommended config to all files.

// eslint.config.js
import eslintPlugin from 'eslint-plugin-eslint-plugin';

export default [eslintPlugin.configs.recommended];

Or to apply linting only to the appropriate rule or test files:

// eslint.config.js
import eslintPlugin from 'eslint-plugin-eslint-plugin';

export default [
  {
    files: ['lib/rules/*.{js,ts}'],
    ...eslintPlugin.configs['rules-recommended'],
  },
  {
    files: ['tests/lib/rules/*.{js,ts}'],
    ...eslintPlugin.configs['tests-recommended'],
  },
];

Settings

You may set the following settings in your eslint.config.js

ruleTesterConstructors

The different names allowed for the constructors of the RuleTester. Can contain both string and RegExp. A string verifies a full match, while a RegExp uses RegExp.prototype.test().

This settings defaults to ['RuleTester'].

// eslint.config.js
export default [
  {
    settings: {
      'eslint-plugin': {
        ruleTesterConstructors: [/RuleTester$/, /^createRuleTester/],
      },
    },
  },
];