1.1.13 • Published 5 months ago

eslint-plugin-sort-properties v1.1.13

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

eslint-plugin-sort-properties

This plugin provides rules that enforce the sorting of properties in object expressions, object destructuring for JavaScript, and type literals, interface members for TypeScript.\ Inspired by eslint-plugin-sort-keys-fix and eslint-plugin-sort-destructure-keys, it is designed to be auto-fixable. But with optimization, it is up to 11x faster to fix, 6x to parse, 60x to apply rule than these plugins.benchmark\ And this plugin can be configured to include leading/trailing comments as part of the property, so there's less chance of breaking the placement of comments.\ Additionally, inspired by the eslint-plugin-react/jsx-sort-props rule, it supports giving higher priority to function properties when sorting.

Demo GIF

Table of Contents

Rules

āš ļø Configurations set to warn in.\ 🌐 Set in the all configuration.\ JavaScript Set in the js configuration.\ TypeScript Set in the ts configuration.\ šŸ”§ Automatically fixable by the --fix CLI option.\ šŸ’” Manually fixable by editor suggestions.

NameDescriptionāš ļøšŸ”§šŸ’”
sort-interfaceEnforce interface members to be sorted.🌐 TypeScriptšŸ”§šŸ’”
sort-object-destructingEnforce properties in object destructuring to be sorted.🌐 JavaScriptšŸ”§šŸ’”
sort-object-expressionEnforce properties in object expressions to be sorted.🌐 JavaScriptšŸ”§šŸ’”
sort-type-literalEnforce properties in type literals to be sorted.🌐 TypeScriptšŸ”§šŸ’”

Installation

You'll first need to install ESLint:

npm install eslint --save-dev

Next, install eslint-plugin-sort-properties:

npm install eslint-plugin-sort-properties --save-dev

Available configurations

NameDescription
🌐allApply all rules in the sort-properties plugin. Use flat/all in eslint>=9
JavaScriptjsApply JavaScript rules in the sort-properties plugin. Use flat/js in eslint>=9
TypeScripttsApply TypeScript rules in the sort-properties plugin. Use flat/ts in eslint>=9

Configuration (legacy: .eslintrc*)

āš ļø Important note\ To use rules for typescript(sort-interface, sort-type-literal), you must specify the parser as @typescript-eslint/parser.

module.exports = {
  // ...
  overrides: [
    {
      files: ["**/*.{ts,tsx}"],
      parser: "@typescript-eslint/parser",
    },
  ],
};

Use all to enable all rules. Here's an example configuration in your .eslintrc:

module.exports = {
  extends: ["plugin:sort-properties/all"],
};

or you can enable specific rules:

module.exports = {
  plugins: ["sort-properties"],
  rules: {
    "sort-properties/sort-interface": "warn",
    "sort-properties/sort-object-destructing": "warn",
    "sort-properties/sort-object-expression": [
      "warn",
      // See the options section below for more information
      {
        allowLineSeparatedGroups: false,
        caseSensitive: true,
        functionOrder: "higher",
        includeComments: "leading",
        minKeys: 2,
        natural: true,
        order: "asc",
      },
    ],
    "sort-properties/sort-type-literal": "warn",
  },
};

Configuration (new: eslint.config.js)

āš ļø Important note\ To use rules for typescript(sort-interface, sort-type-literal), you must specify the parser as @typescript-eslint/parser.

const tseslint = require("typescript-eslint");

// Use utility function for typescript-eslint
module.exports = tseslint.config(
  { ... }
);

// Or manually specify the parser
module.exports = [
  {
    files: ["**/*.{ts,tsx}"],
    languageOptions: {
      parser: tseslint.parser,
    },
  },
];

Use flat/all to enable all rules. Here's an example configuration in your eslint.config.js:

const sortPropertiesPlugin = require("eslint-plugin-sort-properties");

module.exports = [
  // ...
  sortPropertiesPlugin.configs["flat/all"],
];

or you can enable specific rules:

module.exports = [
  // ...
  {
    plugins: {
      "sort-properties": require("eslint-plugin-sort-properties"),
    },
    rules: {
      "sort-properties/sort-interface": "warn",
      "sort-properties/sort-object-destructing": "warn",
      "sort-properties/sort-object-expression": [
        "warn",
        // See the options section below for more information
        {
          allowLineSeparatedGroups: false,
          caseSensitive: true,
          functionOrder: "higher",
          includeComments: "leading",
          minKeys: 2,
          natural: true,
          order: "asc",
        },
      ],
      "sort-properties/sort-type-literal": "warn",
    },
  },
];

Options

All four rules shares most of the options below:

NameDescriptionTypeChoicesDefault
allowLineSeparatedGroupsIf true, properties are separated independently by line breaks. Works same as eslint sort-keys rule.Booleantrue
caseSensitiveWhether the comparison is case sensitive.Booleantrue
functionOrderThe priority of properties which values are either method or arrow function. For example, if order is 'asc' and functionOrder is 'higher', function properties will be placed at the end. this option is not available for sort-object-destructing rule.higher, lower, equalhigher
includeCommentsPosition of comments to consider as part of the property.leading, trailingleading
minKeysMinimum number of keys to check order.Integer2
naturalWhether the comparison is using a natural order. See natural-compareBooleantrue
orderThe order of properties.Stringasc, descasc
1.1.13

5 months ago

1.1.9

5 months ago

1.1.8

5 months ago

1.1.7

5 months ago

1.1.6

5 months ago

1.1.12

5 months ago

1.1.11

5 months ago

1.1.10

5 months ago

1.1.1

5 months ago

1.1.0

5 months ago

1.1.5

5 months ago

1.1.4

5 months ago

1.1.3

5 months ago

1.1.2

5 months ago

1.0.0

5 months ago