eslint-plugin-import-sorting
v2.0.0
Published
ESLint plugin to group and sort imports by module, à la Python isort
Downloads
219
Maintainers
Readme
eslint-plugin-import-sorting
Enforce a convention in the order of import
statements, inspired by isort’s grouping style:
- Node standard modules
- Framework modules
- External modules
- Internal modules
- Explicitly local modules
This plugin includes an additional group for “style” imports where the import source ends in .css
or other style format. Imports are sorted alphabetically, except for local modules, which are sorted by the number of .
segements in the path first, then alphabetically.
Usage
Install the plugin, and ESLint if is not already.
npm install --save-dev eslint eslint-plugin-import-sorting
Include the plugin in the plugins
key of your ESLint config and enable the rule.
// eslint.config.js
import importSortingPlugin from 'eslint-plugin-import-sorting'
export default [
{
plugins: {
'import-sorting': importSortingPlugin,
},
rules: {
'import-sorting/order': 'warn',
},
},
]
// .eslintrc.js
module.exports = {
plugins: ['import-sorting'],
rules: {
'import-sorting/order': 'warn',
},
}
See the order rule docs for more configuration options.