📄 `no-namespace`¶

📊 Analysis Summary¶

Metric	Count
🔧 Functions	2
📦 Imports	4
📑 Type Aliases	2

📚 Table of Contents¶

Default Export
Imports
Functions
Type Aliases

🛠️ File Location:¶

📂 packages/eslint-plugin/src/rules/no-namespace.ts

📤 Default Export¶

export default createRule<Options, MessageIds>({ ... })

Property	Value
`name`	'no-namespace'
`meta.type`	'suggestion'
`meta.docs.description`	'Disallow TypeScript namespaces'
`meta.docs.recommended`	'recommended'
`meta.messages.moduleSyntaxIsPreferred`	'ES2015 module syntax is preferred over namespaces.'
`meta.schema`	[ { type: 'object', additionalProperties: false, properties: { allowDeclarations: { type: 'boolean', description: 'Wh...
`defaultOptions`	[ { allowDeclarations: false, allowDefinitionFiles: true, }, ]

Entry point: create — documented under Functions.

📦 Imports¶

Name	Source
`TSESTree`	`@typescript-eslint/utils`
`AST_NODE_TYPES`	`@typescript-eslint/utils`
`createRule`	`../util`
`isDefinitionFile`	`../util`

Functions¶

`create(context: any, [{ allowDeclarations, allowDefi…: any): { "TSModuleDeclaration[global!=true][id.type!='Literal']"(n…`¶

Parameters:

context any
[{ allowDeclarations, allowDefinitionFiles }] any

Returns: { "TSModuleDeclaration[global!=true][id.type!='Literal']"(node: TSESTree.TSModuleDeclaration): void; }

Calls:

isDeclaration
isDefinitionFile (from ../util)
context.report

Code

create(context, [{ allowDeclarations, allowDefinitionFiles }]) {
    function isDeclaration(node: TSESTree.Node): boolean {
      if (node.type === AST_NODE_TYPES.TSModuleDeclaration && node.declare) {
        return true;
      }

      return node.parent != null && isDeclaration(node.parent);
    }

    return {
      "TSModuleDeclaration[global!=true][id.type!='Literal']"(
        node: TSESTree.TSModuleDeclaration,
      ): void {
        if (
          node.parent.type === AST_NODE_TYPES.TSModuleDeclaration ||
          (allowDefinitionFiles && isDefinitionFile(context.filename)) ||
          (allowDeclarations && isDeclaration(node))
        ) {
          return;
        }

        context.report({
          node,
          messageId: 'moduleSyntaxIsPreferred',
        });
      },
    };
  }

Internal helpers¶

Declared inside another function in this file.

`isDeclaration(node: TSESTree.Node): boolean`¶

Parameters:

node TSESTree.Node

Returns: boolean

Calls:

isDeclaration

Code

function isDeclaration(node: TSESTree.Node): boolean {
      if (node.type === AST_NODE_TYPES.TSModuleDeclaration && node.declare) {
        return true;
      }

      return node.parent != null && isDeclaration(node.parent);
    }

Type Aliases¶

`Options`¶

type Options = [
  {
    allowDeclarations?: boolean;
    allowDefinitionFiles?: boolean;
  },
];

`MessageIds`¶

type MessageIds = 'moduleSyntaxIsPreferred';

Generated by Syntax Scribe

📄 no-namespace¶