Abstruct

Node.jsのプロジェクトで、import の順番をきれいにする(buildin, ライブラリ, 独自ライブラリの順にimportする)方法を調べたので、載せておきます。

1. Tools

以下のツールをインストールする。

1
2
3

$ yarn add @typescript-eslint
$ yarn add eslint-plugin-import
$ yarn add eslint-plugin-unused-imports

2. Settings

.eslintrc.yml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

env:
  browser: true
extends:
  - "plugin:@typescript-eslint/recommended"
  - "prettier"
  - plugin:import/recommended
  - plugin:import/errors
  - plugin:import/warnings
  - plugin:import/typescript
parser: "@typescript-eslint/parser"
parserOptions:
  ecmaVersion: 13
  sourceType: module
plugins:
  - "@typescript-eslint"
  - import
  - unused-imports
rules:
  {
    "import/no-unresolved": "off",
    "import/order":
      [
        "warn",
        {
          "groups":
            [
              "builtin",
              "external",
              "internal",
              "parent",
              "sibling",
              "index",
              "object",
              "type",
            ],
          "newlines-between": "always",
          "pathGroupsExcludedImportTypes": ["builtin"],
          "alphabetize": { "order": "asc", "caseInsensitive": true },
          "pathGroups": [],
        },
      ],
  }

3. Reference