no-namespace
TypeScript名前空間の使用を禁止します。
✅
拡張 "plugin:@typescript-eslint/recommended" を ESLint設定 で有効にすると、このルールが有効になります。
TypeScriptでは、歴史的に「カスタムモジュール」(module Example {})と呼ばれるコード編成方法が許容されており、後に「名前空間」(namespace Example)と改名されました。名前空間は、TypeScriptコードを編成するための時代遅れの方法です。現在では、ES2015モジュール構文(import/export)が推奨されています。
このルールは、外部APIを記述するためのTypeScriptモジュール宣言(
declare module 'foo' {})の使用については報告しません。
.eslintrc.cjs
module.exports = {
"rules": {
"@typescript-eslint/no-namespace": "error"
}
};
このルールをPlaygroundでお試しください ↗
例
デフォルトオプションを使用したコードの例
- ❌ 正しくない
- ✅ 正しい
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の無効化コメントを特定の状況で使用することを検討してください。