⬅️ Back to Table of Contents

📄 debug-namespace

📊 Analysis Summary

Metric	Count
🔧 Functions	2
📦 Imports	3

📚 Table of Contents

• Default Export
• Imports
• Functions

🛠️ File Location:

📂 packages/eslint-plugin-internal/src/rules/debug-namespace.ts

📤 Default Export

export default createRule({ ... })

Property	Value
name	'debug-namespace'
meta.type	'problem'
meta.docs.description	'Enforce consistent debug() namespaces based on package name and file path'
meta.fixable	'code'
meta.messages.mismatched	'debug() namespace should match package and file. Use the fixer to update it.'
meta.schema	[]
defaultOptions	[]

Entry point: create — documented under Functions.

---

📦 Imports

Name	Source
TSESTree	@typescript-eslint/utils
getStaticValue	@typescript-eslint/utils/ast-utils
createRule	../util/index.js

---

Functions

create(context: any): { 'VariableDeclarator[id.name="log"] > CallExpression[argum…

Parameters:

• context any

Returns: { 'VariableDeclarator[id.name="log"] > CallExpression[arguments.length=1][callee.name="debug"]'?: undefined; } | { 'VariableDeclarator[id.name="log"] > CallExpression[arguments.length=1][callee.name="debug"]'(node: TSESTree.CallExpression): void; }

Calls:

• filePathToNamespace
• getStaticValue (from @typescript-eslint/utils/ast-utils)
• context.report
• fixer.replaceText

Code

create(context) {
    const expected = filePathToNamespace(context.filename);
    if (!expected) {
      return {};
    }

    return {
      'VariableDeclarator[id.name="log"] > CallExpression[arguments.length=1][callee.name="debug"]'(
        node: TSESTree.CallExpression,
      ) {
        const [argument] = node.arguments;
        const staticValue = getStaticValue(argument);
        if (
          typeof staticValue?.value !== 'string' ||
          staticValue.value === expected
        ) {
          return;
        }

        context.report({
          node: argument,
          messageId: 'mismatched',
          fix: fixer => fixer.replaceText(argument, `'${expected}'`),
        });
      },
    };
  }

filePathToNamespace(filePath: string): string

Parameters:

• filePath string

Returns: string

Calls:

• filePath .split(/packages[\\/]+/) .slice(1) .join
• relativePath .replace(/^[\\/]/, '') .replace(/(?:dist|lib|src)(\/|\\)/, '') .replace(/\.\w+$/, '') .replaceAll

Code

function filePathToNamespace(filePath: string) {
  const relativePath = filePath
    .split(/packages[\\/]+/)
    .slice(1)
    .join('');

  const relativeNamespace = relativePath
    .replace(/^[\\/]/, '')
    .replace(/(?:dist|lib|src)(\/|\\)/, '')
    .replace(/\.\w+$/, '')
    .replaceAll(/[^a-z0-9-]+/gi, ':');

  return `typescript-eslint:${relativeNamespace}`;
}

---

Generated by Syntax Scribe