eslint-plugin-align-import

eslint-plugin-align-import

What is this?

This plugin / rule will align all your import statements:

from

import defaultExport from "module-name";
import * as name  from "module-name";
import { export1 } from "module-name";
import { export2 as alias1 } from "module-name";
import { export3 , export4 } from "module-name";
import { foo , bar } from "module-name/path/to/specific/un-exported/file";
import { export5 , export6 as alias7 } from "module-name";
import defaultExport2, { export8 } from "module-name";
import defaultExport3, * as name2 from "module-name";

to

import defaultExport                   from "module-name";
import * as name                       from "module-name";
import { export1 }                     from "module-name";
import { export2 as alias1 }           from "module-name";
import { export3 , export4 }           from "module-name";
import { foo , bar }                   from "module-name/path/to/specific/un-exported/file";
import { export5 , export6 as alias7 } from "module-name";
import defaultExport2, { export8 }     from "module-name";
import defaultExport3, * as name2      from "module-name";

Installation

You'll first need to install ESLint:

$ npm install eslint --save-dev

Next, install eslint-plugin-align-import:

$ npm install eslint-plugin-align-import --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-align-import globally.

Usage

Add babel-align-import to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "babel-align-import"
    ]
}

You might have to update the no-multi-spaces rule to allow multiple spaces in front of import:

{
    "rules": {
        "no-multi-spaces": ["error", {"exceptions": {"ImportDeclaration": true}}]
    }
}

There are two rules available:

rule	description
align-import/align-import	Aligns your import statements, this is probably the rule you're looking for.
align-import/trim-import	This rule will remove any extra space around your import keyword.