禁止命名空间

禁止 TypeScript 命名空间。

✅

在 "plugin:@typescript-eslint/recommended" 中扩展 ESLint 配置 将启用此规则。

TypeScript 历史上允许一种称为“自定义模块”（module Example {}）的代码组织形式，后来改名为“命名空间”（namespace Example）。命名空间是组织 TypeScript 代码的过时方式。现在首选 ES2015 模块语法（import/export）。

此规则不会报告使用 TypeScript 模块声明来描述外部 API（declare module 'foo' {}）。

.eslintrc.cjs

module.exports = {
  "rules": {
    "@typescript-eslint/no-namespace": "error"
  }
};

在游乐场中尝试此规则 ↗

示例

使用默认选项的代码示例

❌ 错误

module foo {}
namespace foo {}

declare module foo {}
declare namespace foo {}

在游乐场中打开

✅ 正确

declare module 'foo' {}

// anything inside a d.ts file

在游乐场中打开

选项

此规则接受以下选项

type Options = [
  {
    /** Whether to allow `declare` with custom TypeScript namespaces. */
    allowDeclarations?: boolean;
    /** Whether to allow `declare` with custom TypeScript namespaces inside definition files. */
    allowDefinitionFiles?: boolean;
  },
];

const defaultOptions: Options = [
  { allowDeclarations: false, allowDefinitionFiles: true },
];

allowDeclarations

使用 { "allowDeclarations": true } 选项的代码示例

❌ 错误

module foo {}
namespace foo {}

在游乐场中打开

✅ 正确

declare module 'foo' {}
declare module foo {}
declare namespace foo {}

declare global {
  namespace foo {}
}

declare module foo {
  namespace foo {}
}

在游乐场中打开

使用 { "allowDeclarations": false } 选项的代码示例

❌ 错误

module foo {}
namespace foo {}
declare module foo {}
declare namespace foo {}

在游乐场中打开

✅ 正确

declare module 'foo' {}

在游乐场中打开

allowDefinitionFiles

使用 { "allowDefinitionFiles": true } 选项的代码示例

❌ 错误

// if outside a d.ts file
module foo {}
namespace foo {}

// if outside a d.ts file and allowDeclarations = false
module foo {}
namespace foo {}
declare module foo {}
declare namespace foo {}

在游乐场中打开

✅ 正确

declare module 'foo' {}

// anything inside a d.ts file

在游乐场中打开

何时不使用它

如果您的项目是在现代模块和命名空间出现之前构建的，那么迁移出命名空间可能很困难。在这种情况下，您可能无法将此规则应用于项目的部分内容。您可能需要考虑使用 ESLint 禁用注释 来解决这些特定情况，而不是完全禁用此规则。

进一步阅读

• 模块
• 命名空间
• 命名空间和模块

资源

• 规则来源
• 测试来源