Getting Started

💿 Installation

You'll first need to install ESLint:

npm

npm install --save-dev eslint

pnpm

pnpm add --save-dev eslint

yarn

yarn add --dev eslint

Next, install eslint-plugin-perfectionist:

npm

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

pnpm

pnpm add --save-dev eslint-plugin-perfectionist

yarn

yarn add --dev eslint-plugin-perfectionist

⚙️ Usage

Add perfectionist to the plugins section of your .eslintrc configuration file or import eslint-plugin-perfectionist in your eslint.config.js. Then configure the rules you want to use under the rules section.

Legacy Config

// .eslintrc
{
  "plugins": ["perfectionist"],
  "rules": {
    "perfectionist/sort-interfaces": "error"
  }
}

Flat Config

// eslint.config.js
import perfectionist from 'eslint-plugin-perfectionist'

export default {
  plugins: {
    perfectionist,
  },
  rules: {
    'perfectionist/sort-interfaces': 'error',
  },
}