← Back to rules

eslint/sort-imports 风格

🛠️ An auto-fix is available for this rule for some violations.

它的作用

此规则检查所有导入声明，并验证所有导入首先按使用的成员语法排序，然后按第一个成员或别名名称的字母顺序排序。

在声明多个导入时，有序的导入声明列表能让开发者更容易阅读代码，并在后续快速找到所需的导入。

为什么这是不好的？

一致的导入排序有助于提高代码的可读性和可维护性。

示例

此规则的 错误 示例：

import { b, a, c } from "foo.js";

import d from "foo.js";
import e from "bar.js";

配置

此规则接受一个配置对象，包含以下属性：

allowSeparatedGroups

type: boolean

default: false

当设置为 true 时，该规则允许被空行分隔的导入组独立处理。

ignoreCase

type: boolean

default: false

当设置为 true 时，该规则在排序导入名称时不区分大小写。

ignoreDeclarationSort

type: boolean

default: false

当设置为 true 时，该规则忽略导入声明的排序（即 import 语句的顺序）。

ignoreMemberSort

type: boolean

default: false

当设置为 true 时，该规则忽略单个导入声明内导入成员的排序。

memberSyntaxSortOrder

type: array

default: ["none", "all", "multiple", "single"]

指定不同导入语法的排序顺序。 必须包含全部 4 种类型！

memberSyntaxSortOrder[n]

type: "none" | "all" | "multiple" | "single"

如何使用

要通过配置文件或 CLI 启用此规则，可以使用：

配置文件 (.oxlintrc.json)

{
  "rules": {
    "sort-imports": "error"
  }
}

CLI

oxlint --deny sort-imports

参考资料

• 规则源码