eslint-plugin-eslint-config

ESLint plugin for ESLint configs

This plugin provides rules for linting files that export configs meant for use with ESLint, to ensure that they're valid.

Installation

npm install --dev eslint eslint-plugin-eslint-config

Note: If you installed ESLint globally then you must also install eslint-plugin-eslint-config globally.

Usage

Add config to the plugins section of your .eslintrc.js configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["eslint-config"]
}

Then configure the rules you want to use for your config(s) using overrides:

{
  "overrides": [
    {
      "files": [".eslintrc.js", "react.js", "@typescript-eslint.js"],
      "rules": {
        "eslint-config/no-deprecated-rules": "warn"
      }
    }
  ]
}

The rules assume that the files they're linting are configs meant for ESLint. Also note that while ESLint can be configured using JSON and YAML files, it doesn't support linting those file types meaning this plugin will not work if you're not using a .js config file.

Shareable configurations

This plugin provides three presets:

• recommended-rules
• rc
• all

The rc preset generally should be used by all projects, as it applies recommended rules to supported eslintrc files.

If a project contains other files that export eslint configs (such as an eslint config package), the recommended-rules preset can be used to apply the recommended rules to those files using overrides.

While the recommended-rules and rc presets only change in major versions, the all preset may change in any release and is thus unsuited for installations requiring long-term consistency.

Rules

Rule	Description	Configurations	Fixable
no-deprecated-rules	Checks for usage of deprecated eslint rules
no-invalid-config	Checks that the config exported by a file is valid
no-unknown-rules	Ensures that all rules are known
sort-rules	Ensures that rules are sorted in a consistent order