eslint-plugin-perfectionist

What is eslint-plugin-perfectionist?

eslint-plugin-perfectionist is an ESLint plugin designed to enforce consistent code style and formatting rules. It helps developers maintain a clean and organized codebase by providing rules for sorting and organizing various code elements such as imports, properties, and more.

What are eslint-plugin-perfectionist's main functionalities?

Sort Imports

This rule enforces a specific order for import statements. In this example, the order is set to 'builtin', 'external', and 'internal' imports.

module.exports = {
  "rules": {
    "perfectionist/sort-imports": ["error", {
      "order": ["builtin", "external", "internal"]
    }]
  }
};

Sort Object Properties

This rule enforces sorting of object properties in ascending order. The 'caseSensitive' option ensures that the sorting is case-sensitive.

module.exports = {
  "rules": {
    "perfectionist/sort-keys": ["error", "asc", {
      "caseSensitive": true,
      "natural": false
    }]
  }
};

Sort Class Members

This rule enforces a specific order for class members. In this example, the order is set to 'field', 'constructor', and 'method'.

module.exports = {
  "rules": {
    "perfectionist/sort-class-members": ["error", {
      "order": ["field", "constructor", "method"]
    }]
  }
};

Other packages similar to eslint-plugin-perfectionist

eslint-plugin-import

eslint-plugin-import is a popular ESLint plugin that provides rules for ensuring proper import/export syntax and order. It focuses on managing module imports and exports, ensuring they are used correctly and consistently.

eslint-plugin-sort-keys-fix

eslint-plugin-sort-keys-fix is an ESLint plugin that automatically sorts object keys in a consistent order. It is similar to the 'sort-keys' rule in eslint-plugin-perfectionist but focuses specifically on object keys.

eslint-plugin-jsdoc

eslint-plugin-jsdoc is an ESLint plugin that enforces JSDoc comments and their formatting. While it doesn't focus on sorting, it helps maintain consistent documentation style, which complements the goals of eslint-plugin-perfectionist.

README

ESLint Plugin Perfectionist

ESLint plugin for code formatting in perfectionist style.

Installation

You'll first need to install ESLint:

npm install --save-dev eslint

Next, install eslint-plugin-perfectionist:

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

Rules

Name	Description	💼	🛠
sort-array-includes	Enforce sorted arrays before include method	✅	🔧
sort-enums	Enforce sorted TypeScript enums	✅	🔧
sort-interfaces	Enforce sorted interface properties	✅	🔧
sort-jsx-props	Enforce sorted JSX props	✅	🔧
sort-map-elements	Enforce sorted Map elements	✅	🔧
sort-named-exports	Enforce sorted named exports	✅	🔧
sort-named-imports	Enforce sorted named imports	✅	🔧
sort-object-keys	Enforce sorted object keys	✅	🔧
sort-union-types	Enforce sorted union types	✅	🔧

See also

• @azat-io/eslint-config - Collection of ESLint configs

License

MIT © Azat S.