Nate-Wilkins / eslint-plugin-jsort

Sort imports effortlessly

eslint-plugin-jsort

ESLint plugin with rules to sort imports effortlessly.

$ npm install eslint-plugin-jsort

This rule sorts & formats import declaration with a lot of flexibility using eslint --fix.

JavaScript imports are frustrating and this tries to make them a bit easier to work with. Feel free to post any issues/suggestions you might have with the plugin on the issue tracker.

Capabilities

• Sort import declarations into distinct groups by type
• Sort import declarations by "global" packages vs "local" packages
• Sort import declarations by source
• Sort imported modules (aka specifiers)
• Combine import declarations that can be combined
• Force explicit default imports
• Force single line imports
• Force explicit type imports
• Normalize import source

Supported Parsers

• @typescript-eslint/parser
• @babel/eslint-parser

Installation

1. Install ESLint:

$ npm i eslint --save-dev

2. Install the plugin eslint-plugin-jsort:

$ npm install eslint-plugin-jsort --save-dev

Usage

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

{
  "plugins": ["jsort"]
}

2. Then configure the rules you want to use under the rules section.

{
  "rules": {
    "jsort/sort-imports": [
      "error",
      {
        /* `sort-imports` Additional Configuration */
      }
    ],
    "jsort/normalize-import-source": [
      "error",
      {
        /* `normalize-import-source` Additional Configuration */
      }
    ]
  }
}

3. For "sort-imports Additional Configuration" see jsort/sort-imports docs.
4. For "normalize-import-source Additional Configuration" see jsort/normalize-import-source docs

Available Rules

• jsort/sort-imports
• jsort/normalize-import-source

Other Alternatives

• ESLint Builtin sort-imports Rule
• eslint-plugin-simple-import-sort
• eslint-plugin-sort-imports-es6-autofix
• prettier-plugin-sort-imports
• eslint-plugin-import

Other Resources

• AST Explorer