noCommonJs

JavaScript (and super languages)

摘要

¥Summary

规则生效日期：v1.9.0

¥Rule available since: v1.9.0
诊断类别：lint/style/noCommonJs

¥Diagnostic Category: lint/style/noCommonJs
此规则没有修复方案。

¥This rule doesn’t have a fix.
此规则的默认严重级别为 warning。

¥The default severity of this rule is warning.
来源：

¥Sources:
- 与 @typescript-eslint/no-require-imports 相同
  
  ¥Same as @typescript-eslint/no-require-imports
- 与 import/no-commonjs 相同
  
  ¥Same as import/no-commonjs

如何配置

¥How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "noCommonJs": "error"
6
      }
7
    }
8
  }
9
}

描述

¥Description

禁止使用 CommonJs 模块系统，转而使用 ESM 样式导入。

¥Disallow use of CommonJs module system in favor of ESM style imports.

ESM 样式 import 是 CommonJS require 导入的现代替代品。所有现代浏览器和 Node.js 版本均支持。与 CommonJs 相比，工具可以更轻松地静态分析和树状摇动 ESM import。

¥ESM-style imports are modern alternative to CommonJS require imports. Supported by all modern browsers and Node.js versions. Tooling can more easily statically analyze and tree-shake ESM imports compared to CommonJs.

示例

¥Examples

无效

¥Invalid

1
require('node:fs');

code-block.js:1:1 lint/style/noCommonJs ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Use ESM imports instead of require.
  
  > 1 │ require(‘node:fs’);
      │ ^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ ESM-style import statements are more easily statically analyzable and tree-shakable compared to CommonJs require.

1
module.exports = { a: 'b' }

code-block.js:1:1 lint/style/noCommonJs ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Use ESM exports instead of module.exports.
  
  > 1 │ module.exports = { a: ‘b’ }
      │ ^^^^^^^^^^^^^^
    2 │ 
  
  ℹ ESM-style export statements are more easily statically analyzable and tree-shakable compared to CommonJs module.exports.

1
exports.a = 'b';

code-block.js:1:1 lint/style/noCommonJs ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Use ESM exports instead of module.exports.
  
  > 1 │ exports.a = ‘b’;
      │ ^^^^^^^^^
    2 │ 
  
  ℹ ESM-style export statements are more easily statically analyzable and tree-shakable compared to CommonJs module.exports.

有效

¥Valid

1
import fs from 'node:fs';

1
import('node:fs')

1
export const a = 'b';

1
export default { a: 'b' };

注意事项

¥Caveats

规则在 .cjs 和 .cts 文件中自动禁用，因为它们明确是 CommonJs 文件。

¥Rule is automatically disabled inside .cjs and .cts files, because they are explicitly CommonJs files.

如果你正在从 CommonJs 迁移到 ESM，此规则可能会有所帮助，但如果你希望继续使用 CommonJs，则可以安全地禁用它。

¥This rule could be helpful if you are migrating from CommonJs to ESM, but if you wish to continue using CommonJs, you can safely disable it.

noCommonJs

摘要

如何配置

描述

示例

无效

有效

注意事项

相关链接