@taiga-ui/eslint-plugin-experience-next 0.471.0 → 0.472.0

package/README.md

@@ -44,7 +44,7 @@ export default [
 | decorator-key-sort                              | Sorts the keys of the object passed to the `@Component/@Injectable/@NgModule/@Pipe` decorator       | ✅  | 🔧  |     |
 | flat-exports                                    | Spread nested arrays when exporting Angular entity collections                                      |     | 🔧  |     |
 | host-attributes-sort                            | Sort Angular host metadata attributes using configurable attribute groups                           | ✅  | 🔧  |     |
-| injection-token-description                     | They are required to provide a description for `InjectionToken`                                     | ✅  |     |     |
+| injection-token-description                     | Require `InjectionToken` descriptions to include the token name                                     | ✅  | 🔧  |     |
 | no-deep-imports                                 | Disables deep imports of Taiga UI packages                                                          | ✅  | 🔧  |     |
 | no-deep-imports-to-indexed-packages             | Disallow deep imports from packages that expose an index.ts next to ng-package.json or package.json | ✅  | 🔧  |     |
 | no-fully-untracked-effect                       | Disallow reactive callbacks where all signal reads are hidden inside `untracked()`                  | ✅  |     |     |
@@ -282,17 +282,25 @@ Use atomic presets when you want a custom order instead of one of the bundled al
 
 ## injection-token-description
 
-<sup>`✅ Recommended`</sup>
+<sup>`✅ Recommended`</sup> <sup>`Fixable`</sup>
 
-The description string passed to `new InjectionToken(...)` must contain the name of the variable it is assigned to. This
-makes token names visible in Angular DevTools and error messages.
+The description passed to `new InjectionToken(...)` must contain the name of the variable it is assigned to. The rule
+accepts both direct string descriptions and Angular's `ngDevMode ? '...' : ''` pattern, and the autofix rewrites invalid
+descriptions to the dev-only form. If `ngDevMode` is not declared in the file, the autofix inserts
+`declare const ngDevMode: boolean;` after imports.
 
 ```ts
-// ❌ error — description does not mention TUI_MY_TOKEN
-const TUI_MY_TOKEN = new InjectionToken<string>('some description');
+// ❌ error
+import {InjectionToken} from '@angular/core';
+
+export const TUI_MY_TOKEN = new InjectionToken<string>('some description');
 
 // ✅ after autofix
-const TUI_MY_TOKEN = new InjectionToken<string>('[TUI_MY_TOKEN]: some description');
+import {InjectionToken} from '@angular/core';
+
+declare const ngDevMode: boolean;
+
+export const TUI_MY_TOKEN = new InjectionToken<string>(ngDevMode ? '[TUI_MY_TOKEN]: some description' : '');
 ```
 
 ---

package/index.esm.js

@@ -2024,37 +2024,109 @@ const config$2 = {
 
 const MESSAGE_ID$5 = 'invalid-injection-token-description';
 const ERROR_MESSAGE$3 = "InjectionToken's description should contain token's name";
+const NG_DEV_MODE = 'ngDevMode';
 const createRule$e = ESLintUtils.RuleCreator((name) => name);
+function getVariableName(node) {
+    if (node.parent.type !== AST_NODE_TYPES$1.VariableDeclarator) {
+        return undefined;
+    }
+    const { id } = node.parent;
+    return id.type === AST_NODE_TYPES$1.Identifier ? id.name : undefined;
+}
+function isStringLiteral$1(node) {
+    return node.type === AST_NODE_TYPES$1.Literal && typeof node.value === 'string';
+}
+function isStringLike(node) {
+    return isStringLiteral$1(node) || node.type === AST_NODE_TYPES$1.TemplateLiteral;
+}
+function getStringValue(node) {
+    if (isStringLiteral$1(node)) {
+        return node.value;
+    }
+    return node.quasis[0]?.value.raw || '';
+}
+function isEmptyString$1(node) {
+    return (getStringValue(node) === '' &&
+        (!('expressions' in node) || !node.expressions.length));
+}
+function isNgDevModeConditional(node) {
+    return (node.type === AST_NODE_TYPES$1.ConditionalExpression &&
+        node.test.type === AST_NODE_TYPES$1.Identifier &&
+        node.test.name === NG_DEV_MODE &&
+        isStringLike(node.consequent) &&
+        isStringLike(node.alternate) &&
+        isEmptyString$1(node.alternate));
+}
+function getDescriptionValue(node) {
+    if (isStringLike(node)) {
+        return getStringValue(node);
+    }
+    if (isNgDevModeConditional(node)) {
+        return getStringValue(node.consequent);
+    }
+    return undefined;
+}
+function getDescriptionNode(node) {
+    if (isStringLike(node)) {
+        return node;
+    }
+    return isNgDevModeConditional(node) ? node.consequent : undefined;
+}
+function prependTokenName(text, name) {
+    return `${text.slice(0, 1)}[${name}]: ${text.slice(1)}`;
+}
+function isNgDevModeVisible(sourceCode, node) {
+    for (let scope = sourceCode.getScope(node); scope !== null; scope = scope.upper) {
+        if (scope.variables.some((variable) => variable.name === NG_DEV_MODE)) {
+            return true;
+        }
+    }
+    return false;
+}
+function getNgDevModeDeclarationFix(program, fixer) {
+    const lastImport = [...program.body]
+        .reverse()
+        .find((statement) => statement.type === AST_NODE_TYPES$1.ImportDeclaration);
+    if (lastImport) {
+        return fixer.insertTextAfter(lastImport, '\n\ndeclare const ngDevMode: boolean;');
+    }
+    const [firstStatement] = program.body;
+    if (firstStatement) {
+        return fixer.insertTextBefore(firstStatement, 'declare const ngDevMode: boolean;\n\n');
+    }
+    return fixer.insertTextBeforeRange([0, 0], 'declare const ngDevMode: boolean;\n');
+}
 const rule$h = createRule$e({
     create(context) {
+        const { sourceCode } = context;
+        const program = sourceCode.ast;
+        let shouldAddNgDevModeDeclaration = true;
         return {
             'NewExpression[callee.name="InjectionToken"]'(node) {
-                let token;
-                let name;
-                const [description] = node?.arguments ?? [];
-                if (!description) {
+                const [description] = node.arguments;
+                if (!description || description.type === AST_NODE_TYPES$1.SpreadElement) {
                     return;
                 }
-                const isLiteral = description.type === AST_NODE_TYPES$1.Literal &&
-                    typeof description.value === 'string';
-                if (isLiteral) {
-                    token = description.value;
-                }
-                if (description.type === AST_NODE_TYPES$1.TemplateLiteral) {
-                    token = description.quasis[0]?.value.raw || '';
-                }
-                if (node?.parent.type === AST_NODE_TYPES$1.VariableDeclarator) {
-                    const id = node.parent.id;
-                    if (id.type === AST_NODE_TYPES$1.Identifier) {
-                        name = id.name;
-                    }
-                }
+                const name = getVariableName(node);
+                const token = getDescriptionValue(description);
+                const fixedDescription = getDescriptionNode(description);
                 const report = name && token && !token.includes(name);
-                if (report) {
+                if (report && fixedDescription) {
                     context.report({
                         fix: (fixer) => {
-                            const [start, end] = description.range;
-                            return fixer.insertTextBeforeRange([start + 1, end], `[${name}]: `);
+                            const isNgDevModeGuarded = isNgDevModeConditional(description);
+                            const fixes = [
+                                fixer.replaceText(isNgDevModeGuarded ? fixedDescription : description, isNgDevModeGuarded
+                                    ? prependTokenName(sourceCode.getText(fixedDescription), name)
+                                    : `${NG_DEV_MODE} ? ${prependTokenName(sourceCode.getText(fixedDescription), name)} : ''`),
+                            ];
+                            if (!isNgDevModeGuarded &&
+                                shouldAddNgDevModeDeclaration &&
+                                !isNgDevModeVisible(sourceCode, description)) {
+                                shouldAddNgDevModeDeclaration = false;
+                                fixes.unshift(getNgDevModeDeclarationFix(program, fixer));
+                            }
+                            return fixes;
                         },
                         messageId: MESSAGE_ID$5,
                         node: description,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taiga-ui/eslint-plugin-experience-next",
-  "version": "0.471.0",
+  "version": "0.472.0",
   "description": "An ESLint plugin to enforce a consistent code styles across taiga-ui projects",
   "repository": {
     "type": "git",