← Back to rules

import/prefer-default-export Style

作用

在导出文件时，此规则会检查是否存在默认导出。

为什么这不好？

此规则旨在通过在模块只有一个导出时优先使用默认导出来标准化模块导出，从而提升可读性和可维护性。

示例

对于 { target: "single" } 选项，下面是错误代码示例：

export const foo = "foo";

对于 { target: "single" } 选项，下面是正确代码示例：

export const foo = "foo";
const bar = "bar";
export default bar;

对于 { target: "any" } 选项，下面是错误代码示例：

export const foo = "foo";
export const baz = "baz";

对于 { target: "any" } 选项，下面是正确代码示例：

export default function bar() {}

配置

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

target

类型: "single" | "any"

默认值: "single"

用于指定优先使用默认导出的目标类型的配置选项。

"single"

当模块中只有一个导出时，优先使用默认导出。

"any"

在任何有导出的模块中都优先使用默认导出。

如何使用

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "plugins": ["import"],
  "rules": {
    "import/prefer-default-export": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["import"],
  rules: {
    "import/prefer-default-export": "error",
  },
});

CLI

oxlint --deny import/prefer-default-export --import-plugin

版本

此规则于 v1.4.0 中添加。

参考资料

• Rule Source
• Open rule in Oxc Playground