Skip to content
← Back to rules

typescript/no-namespace Restriction

它的作用

不允许 TypeScript 命名空间。

为什么这不好?

TypeScript 历史上允许一种称为“自定义模块”的代码组织形式(module Example {}),后来改名为“命名空间”(namespace Example)。命名空间是组织 TypeScript 代码的一种过时方式。现在更推荐使用 ES2015 模块语法(import/export)。

示例

此规则的错误代码示例:

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

此规则的正确代码示例:

typescript
declare module "foo" {}
// d.ts 文件中的任何内容

配置

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

allowDeclarations

type: boolean

default: false

是否允许对自定义 TypeScript 命名空间使用 declare。

{ "allowDeclarations": true } 时,此规则的错误代码示例

typescript
module foo {}
namespace foo {}

{ "allowDeclarations": true } 时,此规则的正确代码示例

typescript
declare module "foo" {}
declare module foo {}
declare namespace foo {}

declare global {
  namespace foo {}
}

declare module foo {
  namespace foo {}
}

{ "allowDeclarations": false } 时,此规则的错误代码示例

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

{ "allowDeclarations": false } 时,此规则的正确代码示例

typescript
declare module "foo" {}

allowDefinitionFiles

type: boolean

default: true

{ "allowDefinitionFiles": true } 时,此规则的错误代码示例

typescript
// 如果在 d.ts 文件之外
module foo {}
namespace foo {}

// 如果在 d.ts 文件之外
module foo {}
namespace foo {}
declare module foo {}
declare namespace foo {}

{ "allowDefinitionFiles": true } 时,此规则的正确代码示例

typescript
declare module "foo" {}
// d.ts 文件中的任何内容

如何使用

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

json
{
  "rules": {
    "typescript/no-namespace": "error"
  }
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "typescript/no-namespace": "error",
  },
});
bash
oxlint --deny typescript/no-namespace

版本

此规则在 v0.0.8 中添加。

参考资料