Skip to content

Latest commit

 

History

History
119 lines (76 loc) · 4.01 KB

README.md

File metadata and controls

119 lines (76 loc) · 4.01 KB
Raw

eslint-plugin-sort-imports-requires

An ESLint plugin to sort both import and require declarations in a unified manner.

Status

npm version build status

Motivation

ESLint's sort-imports only works for import statements. However, require statements are still being widely used. We needed to validate import and require statements in a similar way throughout our codebase and we couldn't find an OSS package that would address this need with the features we require.

This plugin is a drop-in replacement to sort-imports with a few extra features:

  • Provides autofix for potentially unsafe situations (see unsafeAutofix).
  • Allows sorting by aliases. (see useAliases).
  • Allows restoring the old ESLint behavior where multiple type corresponds to all named imports, regardless of how many are imported (see useOldSingleMemberSyntax).

Installation

You'll first need to install ESLint:

npm install eslint --save-dev

Next, install eslint-plugin-sort-imports-requires:

npm install eslint-plugin-sort-imports-requires --save-dev

Usage

Add sort-imports-requires to the plugins section of your ESLint configuration file and configure its rules. Here's an example:

// eslint.config.js
import sortImportRequires from 'eslint-plugin-sort-imports-requires';

export default [
  {
    plugins: {
      'sort-imports-requires': sortImportRequires
    },
    rules: {
      'sort-imports-requires/sort-imports': ['error', { unsafeAutofix: true }],
      'sort-imports-requires/sort-requires': ['error', { unsafeAutofix: true }]
    }
  }
];

Supported Rules

sort-imports and sort-requires

These are the only supported rules and can be configured independently. Both have exactly the same options as ESLint's sort-imports rule, with a few more options:

  • unsafeAutofix (default: false)
  • useAliases (default: true)
  • useOldSingleMemberSyntax (default: false)

unsafeAutofix

Whether to autofix potentially unsafe scenarios automatically when the --fix flag is used when calling eslint.

The current scenarios considered unsafe are:

  • Sorting import / require declarations because they can have side-effects, therefore the order in which they are executed might matter. That's the reason why the built-in ESLint sort-imports rule does not autofix.
  • Sorting dynamic keys with potential side-effects, e.g.: const { [foo()]: bar } = require('bar'). In this scenario, the order in which keys are declared might matter.

Enable this option at your own discretion.

useAliases

Whether to use aliases when sorting.

Consider the following import:

import { foo as bar } from 'some-module';

If useAliases is enabled, bar is used when sorting. If it was disabled, foo would have been used instead.

useOldSingleMemberSyntax

Whether to restore the old ESLint behavior where multiple type corresponds to all named imports (regardless of how many are imported), while the single type corresponds only to default imports.

License

MIT

Contributing

Development

Install dependencies:

npm i

Run tests:

npm run test

Cutting a release

The release process is automated via the release GitHub workflow. Run it by clicking the "Run workflow" button.