@angular-eslint/eslint-plugin 22.2.1-alpha.11 → 22.2.1-alpha.12

package/dist/index.d.ts

@@ -27,7 +27,7 @@ declare const _default: {
         "directive-selector": import("@typescript-eslint/utils/ts-eslint").RuleModule<import("./rules/directive-selector").MessageIds, import("./rules/directive-selector").Options, import("./utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
             name: string;
         };
-        "inject-at-top": import("@typescript-eslint/utils/ts-eslint").RuleModule<"injectAtTop", [], import("./utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+        "inject-at-top": import("@typescript-eslint/utils/ts-eslint").RuleModule<"injectAtTop", import("./rules/inject-at-top").Options, import("./utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
             name: string;
         };
         "no-async-lifecycle-method": import("@typescript-eslint/utils/ts-eslint").RuleModule<"noAsyncLifecycleMethod", [], import("./utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {

package/dist/rules/inject-at-top.d.ts

@@ -1,7 +1,11 @@
-export type Options = [];
+export type Options = [
+    {
+        readonly additionalInjectFunctions?: readonly string[];
+    }
+];
 export type MessageIds = 'injectAtTop';
 export declare const RULE_NAME = "inject-at-top";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"injectAtTop", [], import("../utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"injectAtTop", Options, import("../utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
     name: string;
 };
 export default _default;

package/dist/rules/inject-at-top.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inject-at-top.d.ts","sourceRoot":"","sources":["../../src/rules/inject-at-top.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GAAG,EAAE,CAAC;AAEzB,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC;AACvC,eAAO,MAAM,SAAS,kBAAkB,CAAC;;;;AAEzC,wBAyFG;AAEH,eAAO,MAAM,mBAAmB;;CAG/B,CAAC"}
+{"version":3,"file":"inject-at-top.d.ts","sourceRoot":"","sources":["../../src/rules/inject-at-top.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GAAG;IACpB;QACE,QAAQ,CAAC,yBAAyB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;KACxD;CACF,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC;AACvC,eAAO,MAAM,SAAS,kBAAkB,CAAC;;;;AAIzC,wBAyHG;AAEH,eAAO,MAAM,mBAAmB;;CAG/B,CAAC"}

package/dist/rules/inject-at-top.js

@@ -5,6 +5,7 @@ const utils_1 = require("@angular-eslint/utils");
 const utils_2 = require("@typescript-eslint/utils");
 const create_eslint_rule_1 = require("../utils/create-eslint-rule");
 exports.RULE_NAME = 'inject-at-top';
+const DEFAULT_OPTIONS = { additionalInjectFunctions: [] };
 exports.default = (0, create_eslint_rule_1.createESLintRule)({
     name: exports.RULE_NAME,
     meta: {
@@ -12,13 +13,28 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
         docs: {
             description: 'Requires inject() calls to be declared at the top of the class, before any other member',
         },
-        schema: [],
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    additionalInjectFunctions: {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                        },
+                        description: 'A list of additional functions which perform injection, such as your own `injectTranslations()` helper. Each entry is a regular expression which must match the whole function name, so plain names such as `injectTranslations` work as well as patterns such as `inject[A-Z].*`.',
+                        uniqueItems: true,
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
         messages: {
-            injectAtTop: 'Move this inject() to the top of the class. Class fields are initialized in the order they are written, so anything declared above this line cannot safely use the service yet.',
+            injectAtTop: 'Move this {{functionName}}() to the top of the class. Class fields are initialized in the order they are written, so anything declared above this line cannot safely use the service yet.',
         },
-        defaultOptions: [],
+        defaultOptions: [DEFAULT_OPTIONS],
     },
-    create(context) {
+    create(context, [{ additionalInjectFunctions = [] }]) {
         const angularDecoratorsPattern = (0, utils_1.toPattern)([
             'Component',
             'Directive',
@@ -26,14 +42,18 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
             'Pipe',
             'Service',
         ]);
-        function hasEagerInject(node) {
+        const injectFunctionsPattern = (0, utils_1.toPattern)([
+            'inject',
+            ...additionalInjectFunctions,
+        ]);
+        function findEagerInjectName(node) {
             if (!node) {
-                return false;
+                return null;
             }
             if (node.type === utils_2.AST_NODE_TYPES.CallExpression &&
                 node.callee.type === utils_2.AST_NODE_TYPES.Identifier &&
-                node.callee.name === 'inject') {
-                return true;
+                injectFunctionsPattern.test(node.callee.name)) {
+                return node.callee.name;
             }
             const isFn = node.type === utils_2.AST_NODE_TYPES.ArrowFunctionExpression ||
                 node.type === utils_2.AST_NODE_TYPES.FunctionExpression;
@@ -41,15 +61,20 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                 node.parent?.type === utils_2.AST_NODE_TYPES.CallExpression &&
                 node.parent.callee === node;
             if (node.type === utils_2.AST_NODE_TYPES.ClassExpression || (isFn && !isIIFE)) {
-                return false;
+                return null;
+            }
+            for (const child of Object.values(node).flat()) {
+                if (child &&
+                    typeof child === 'object' &&
+                    'type' in child &&
+                    child !== node.parent) {
+                    const name = findEagerInjectName(child);
+                    if (name) {
+                        return name;
+                    }
+                }
             }
-            return Object.values(node)
-                .flat()
-                .some((child) => child &&
-                typeof child === 'object' &&
-                'type' in child &&
-                child !== node.parent &&
-                hasEagerInject(child));
+            return null;
         }
         return {
             [`${utils_1.Selectors.decoratorDefinition(angularDecoratorsPattern)} > ClassBody`](node) {
@@ -58,12 +83,18 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                     if ('static' in member && member.static) {
                         continue;
                     }
-                    if (member.type === utils_2.AST_NODE_TYPES.PropertyDefinition &&
-                        hasEagerInject(member.value)) {
-                        if (seenNonInject) {
-                            context.report({ node: member, messageId: 'injectAtTop' });
+                    if (member.type === utils_2.AST_NODE_TYPES.PropertyDefinition) {
+                        const functionName = findEagerInjectName(member.value);
+                        if (functionName) {
+                            if (seenNonInject) {
+                                context.report({
+                                    node: member,
+                                    messageId: 'injectAtTop',
+                                    data: { functionName },
+                                });
+                            }
+                            continue;
                         }
-                        continue;
                     }
                     seenNonInject = true;
                 }
@@ -72,5 +103,5 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
     },
 });
 exports.RULE_DOCS_EXTENSION = {
-    rationale: "Class fields are initialized in the order they are declared, so a field that calls inject() only creates its value when the initializer runs. Anything declared above that line which tries to read the injected service will see undefined, and the error message (usually something like 'Cannot read properties of undefined') points at the consumer, not at the field that was initialized out of order. TypeScript catches the obvious shape of this bug when a later-declared field is referenced directly from an earlier initializer, but it does not trace through a getter body or a method call, so the moment the read of this.someService happens behind that indirection the compiler lets it through and the failure only shows up at runtime. The scenario is deceptively easy to introduce: a getter that reads an injected service is defined below the inject() call, someone later adds a small convenience field above the getter that references it, and the class breaks at construction time even though nothing about the change looks suspicious. Keeping every inject() call at the very top of the class removes the ordering concern entirely, because every dependency is guaranteed to exist before any other field, getter, method, or constructor statement runs.",
+    rationale: "Class fields are initialized in the order they are declared, so a field that calls inject() only creates its value when the initializer runs. Anything declared above that line which tries to read the injected service will see undefined, and the error message (usually something like 'Cannot read properties of undefined') points at the consumer, not at the field that was initialized out of order. TypeScript catches the obvious shape of this bug when a later-declared field is referenced directly from an earlier initializer, but it does not trace through a getter body or a method call, so the moment the read of this.someService happens behind that indirection the compiler lets it through and the failure only shows up at runtime. The scenario is deceptively easy to introduce: a getter that reads an injected service is defined below the inject() call, someone later adds a small convenience field above the getter that references it, and the class breaks at construction time even though nothing about the change looks suspicious. Keeping every inject() call at the very top of the class removes the ordering concern entirely, because every dependency is guaranteed to exist before any other field, getter, method, or constructor statement runs. Codebases often wrap inject() in their own helpers, for example an injectTranslations() function that injects a translation service and derives a scoped accessor from it; such a helper has exactly the same ordering constraint, so it can be declared through the additionalInjectFunctions option to be treated like inject() itself.",
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-eslint/eslint-plugin",
-  "version": "22.2.1-alpha.11",
+  "version": "22.2.1-alpha.12",
   "description": "ESLint plugin for Angular applications, following https://angular.dev/style-guide",
   "license": "MIT",
   "main": "dist/index.js",
@@ -19,12 +19,12 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@angular-eslint/bundled-angular-compiler": "22.2.1-alpha.11",
-    "@angular-eslint/utils": "22.2.1-alpha.11",
+    "@angular-eslint/bundled-angular-compiler": "22.2.1-alpha.12",
+    "@angular-eslint/utils": "22.2.1-alpha.12",
     "ts-api-utils": "^2.1.0"
   },
   "devDependencies": {
-    "@angular-eslint/test-utils": "22.2.1-alpha.11"
+    "@angular-eslint/test-utils": "22.2.1-alpha.12"
   },
   "peerDependencies": {
     "@typescript-eslint/utils": "^8.0.0",