@ethlete/eslint-plugin 1.0.0-next.16 → 1.0.0-next.17

package/CHANGELOG.md

@@ -1,20 +1,29 @@
 # Changelog
 
+## 1.0.0-next.17
+
+### Minor Changes
+
+- [#3041](https://github.com/ethlete-io/ethdk/pull/3041) [`ae18442`](https://github.com/ethlete-io/ethdk/commit/ae18442bcbeaf0bc1b023812f4e507169db56c88) Thanks [@github-actions](https://github.com/apps/github-actions)! - New rule `no-impure-top-level-provider`: bans destructuring a factory call at module scope, and - with
+  `{ requirePureAnnotation: true }`, for publishable library source - requires `/* @__PURE__ */` on
+  module-scope calls. Both shapes are undroppable, so one of them puts everything the call touches into
+  every consumer's bundle. Fixable.
+
 ## 1.0.0-next.16
 
 ### Minor Changes
 
 - [#3037](https://github.com/ethlete-io/ethdk/pull/3037) [`19469c2`](https://github.com/ethlete-io/ethdk/commit/19469c21903217e05b974ac69773f222e63ae4e1) Thanks [@github-actions](https://github.com/apps/github-actions)! - Add `no-effect-cleanup-return`: flags a cleanup function returned from `effect()` /
-  `afterRenderEffect()`, which Angular ignores — so the teardown silently never runs. Auto-fixes the
+  `afterRenderEffect()`, which Angular ignores - so the teardown silently never runs. Auto-fixes the
   mechanical case to the `onCleanup` parameter; otherwise points at `inject(DestroyRef).onDestroy()`.
 
 - [#3037](https://github.com/ethlete-io/ethdk/pull/3037) [`3151b7a`](https://github.com/ethlete-io/ethdk/commit/3151b7a253d14e38e22e20d67bf0191f141c144e) Thanks [@github-actions](https://github.com/apps/github-actions)! - Add `ethlete/no-template-literal-before-inline-template`, and restructure the files it flagged.
 
-  The Angular VS Code extension decides **client-side** whether the cursor sits inside an inline `template:` before it forwards completion, hover, go-to-definition or signature-help to the language server. That check (`isNotTypescriptOrSupportedDecoratorField`) walks the file with a bare `ts.createScanner()` loop, which cannot re-scan `}` as `TemplateMiddle`/`TemplateTail` — that needs the parser's `reScanTemplateToken()`. So the first template literal containing a `${…}` substitution desynchronises both the token stream and the brace counter, the scanner never recognises `template` `:` again, and every template request below it is dropped. The language server answers those requests correctly; the editor just never asks, so the template silently has no IntelliSense at all.
+  The Angular VS Code extension decides **client-side** whether the cursor sits inside an inline `template:` before it forwards completion, hover, go-to-definition or signature-help to the language server. That check (`isNotTypescriptOrSupportedDecoratorField`) walks the file with a bare `ts.createScanner()` loop, which cannot re-scan `}` as `TemplateMiddle`/`TemplateTail` - that needs the parser's `reScanTemplateToken()`. So the first template literal containing a `${…}` substitution desynchronises both the token stream and the brace counter, the scanner never recognises `template` `:` again, and every template request below it is dropped. The language server answers those requests correctly; the editor just never asks, so the template silently has no IntelliSense at all.
 
-  The new rule reproduces that scanner verbatim, so it reports exactly the templates the extension would abandon — no heuristic. Twenty inline templates across `components`, `cdk` and the playground were affected, all of them behind a fixture or helper that happened to use an interpolated template literal. Story fixtures moved into sibling `*-storybook.data.ts` files; spec fixtures and in-class helpers that must stay above their component (because a later `@Component` references the class in `imports`) were rewritten without the interpolation.
+  The new rule reproduces that scanner verbatim, so it reports exactly the templates the extension would abandon - no heuristic. Twenty inline templates across `components`, `cdk` and the playground were affected, all of them behind a fixture or helper that happened to use an interpolated template literal. Story fixtures moved into sibling `*-storybook.data.ts` files; spec fixtures and in-class helpers that must stay above their component (because a later `@Component` references the class in `imports`) were rewritten without the interpolation.
 
-  No public API changed — the `components` and `cdk` bumps are story/spec restructuring plus moving `signalVisibilityChangeClasses` below `RichFilterHostComponent` in the same module.
+  No public API changed - the `components` and `cdk` bumps are story/spec restructuring plus moving `signalVisibilityChangeClasses` below `RichFilterHostComponent` in the same module.
 
 ## 1.0.0-next.15
 
@@ -28,13 +37,13 @@
 
 - [`423b30b`](https://github.com/ethlete-io/ethdk/commit/423b30ba4f368d7cee8c464ebd89b5df20d3934c) Thanks [@TomTomB](https://github.com/TomTomB)! - The `static` class member ban now excepts `ngTemplateContextGuard`, which Angular's template type checker requires to be static.
 
-- [`7ca77d4`](https://github.com/ethlete-io/ethdk/commit/7ca77d4a9e1dd3abad7237227c62643159719b74) Thanks [@TomTomB](https://github.com/TomTomB)! - `no-trivial-return-type`: self-referencing (recursive) functions keep their return type annotation — TypeScript cannot infer a return type that depends on itself (TS7023), so the fixer no longer strips it there.
+- [`7ca77d4`](https://github.com/ethlete-io/ethdk/commit/7ca77d4a9e1dd3abad7237227c62643159719b74) Thanks [@TomTomB](https://github.com/TomTomB)! - `no-trivial-return-type`: self-referencing (recursive) functions keep their return type annotation - TypeScript cannot infer a return type that depends on itself (TS7023), so the fixer no longer strips it there.
 
 ## 1.0.0-next.13
 
 ### Minor Changes
 
-- [#3022](https://github.com/ethlete-io/ethdk/pull/3022) [`5a43c83`](https://github.com/ethlete-io/ethdk/commit/5a43c8347a98a815562d1bb0f59bc0db1d765262) Thanks [@github-actions](https://github.com/apps/github-actions)! - Recommended config: the `@Injectable` ban now also flags Angular 22's `@Service` decorator — use `createProvider` / `createRootProvider` from `@ethlete/core` instead.
+- [#3022](https://github.com/ethlete-io/ethdk/pull/3022) [`5a43c83`](https://github.com/ethlete-io/ethdk/commit/5a43c8347a98a815562d1bb0f59bc0db1d765262) Thanks [@github-actions](https://github.com/apps/github-actions)! - Recommended config: the `@Injectable` ban now also flags Angular 22's `@Service` decorator - use `createProvider` / `createRootProvider` from `@ethlete/core` instead.
 
 - [#3022](https://github.com/ethlete-io/ethdk/pull/3022) [`9be3738`](https://github.com/ethlete-io/ethdk/commit/9be3738e18ef1837841c79131127fa42406a3e92) Thanks [@github-actions](https://github.com/apps/github-actions)! - New template rule `ethlete/prefer-static-boolean-properties` (in `recommendedTemplate` as `warn`): flags property bindings of static booleans like `[isReadonly]="true"` and suggests the static-attribute form (`isReadonly` / `isReadonly="false"`). Suggestion-only, since the rewrite is only safe for inputs with a `booleanAttribute` transform.
 
@@ -43,8 +52,8 @@
 ### Minor Changes
 
 - [`44adcac`](https://github.com/ethlete-io/ethdk/commit/44adcac94d7e0f56742e02901221c6e04da7df47) Thanks [@TomTomB](https://github.com/TomTomB)! - Add two component I/O naming rules:
-  - `no-native-html-input-name` (error) — flags an `input()`/`model()` named after a global HTML attribute (`title`, `id`, `hidden`, `role`, `tabindex`, …), which collides with the attribute the host element carries natively.
-  - `prefer-present-tense-output` (warn) — nudges `output()` names toward the present tense like native DOM events (`playerSelect`, not `playerSelected`).
+  - `no-native-html-input-name` (error) - flags an `input()`/`model()` named after a global HTML attribute (`title`, `id`, `hidden`, `role`, `tabindex`, …), which collides with the attribute the host element carries natively.
+  - `prefer-present-tense-output` (warn) - nudges `output()` names toward the present tense like native DOM events (`playerSelect`, not `playerSelected`).
 
   The `on`-prefix case is already covered by `@angular-eslint/no-output-on-prefix`, so no rule is added for it.
 
@@ -52,7 +61,7 @@
 
 ### Major Changes
 
-- [#3016](https://github.com/ethlete-io/ethdk/pull/3016) [`396bdfb`](https://github.com/ethlete-io/ethdk/commit/396bdfb50dc51d2de0156dd7b7cc0ae3b21dfe9b) Thanks [@github-actions](https://github.com/apps/github-actions)! - Remove the `no-public-property` rule. It contradicted `template-member-accessibility`, which requires an explicit `public` modifier on surface members — the explicit-public style is the intended one. The rule was never part of the `recommended` config; if you enabled `ethlete/no-public-property` manually, drop it from your ESLint config.
+- [#3016](https://github.com/ethlete-io/ethdk/pull/3016) [`396bdfb`](https://github.com/ethlete-io/ethdk/commit/396bdfb50dc51d2de0156dd7b7cc0ae3b21dfe9b) Thanks [@github-actions](https://github.com/apps/github-actions)! - Remove the `no-public-property` rule. It contradicted `template-member-accessibility`, which requires an explicit `public` modifier on surface members - the explicit-public style is the intended one. The rule was never part of the `recommended` config; if you enabled `ethlete/no-public-property` manually, drop it from your ESLint config.
 
 ## 0.1.0-next.10
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/eslint-plugin",
-  "version": "1.0.0-next.16",
+  "version": "1.0.0-next.17",
   "license": "MIT",
   "type": "commonjs",
   "main": "./src/index.js",

package/src/configs/recommended.js

@@ -170,12 +170,12 @@ const recommendedTs = {
         message:
           'No legacy Angular lifecycle hooks. Use afterNextRender, inject(DestroyRef).onDestroy, or constructor-based effects instead.',
       },
-      // No @Injectable / @Service — use createRootProvider / createProvider from @ethlete/core
+      // No @Injectable / @Service — use defineRootProvider / defineProvider from @ethlete/core
       {
         selector:
           'Decorator[expression.callee.name=/^(Injectable|Service)$/], Decorator[expression.name=/^(Injectable|Service)$/]',
         message:
-          'No @Injectable / @Service services. Use createRootProvider / createProvider from @ethlete/core instead.',
+          'No @Injectable / @Service services. Use defineRootProvider / defineProvider from @ethlete/core instead.',
       },
       // No route guards — handle access control inside the component itself
       {
@@ -295,6 +295,8 @@ const recommendedTs = {
     // No empty blank lines between import declarations
     'ethlete/no-empty-newlines-between-imports': 'error',
 
+    'ethlete/no-impure-top-level-provider': 'error',
+
     // No legacy Angular decorators — use signal-based APIs (input, output, viewChild, etc.)
     // and host: {} bindings (instead of @HostBinding / @HostListener)
     'ethlete/no-legacy-angular-decorators': 'error',

package/src/index.js

@@ -53,6 +53,7 @@ const noTypedInjectedElementRef = require('./rules/no-typed-injected-element-ref
 const noNativeHtmlInputName = require('./rules/no-native-html-input-name');
 const preferPresentTenseOutput = require('./rules/prefer-present-tense-output');
 const preferStaticBooleanProperties = require('./rules/prefer-static-boolean-properties');
+const noImpureTopLevelProvider = require('./rules/no-impure-top-level-provider');
 const { recommendedTs, recommendedTemplate, recommendedSpec } = require('./configs/recommended');
 
 /** @type {import('eslint').ESLint.Plugin} */
@@ -114,6 +115,7 @@ const plugin = {
     'no-native-html-input-name': noNativeHtmlInputName,
     'prefer-present-tense-output': preferPresentTenseOutput,
     'prefer-static-boolean-properties': preferStaticBooleanProperties,
+    'no-impure-top-level-provider': noImpureTopLevelProvider,
   },
 };
 

package/src/rules/no-impure-top-level-provider.js

@@ -0,0 +1,129 @@
+// @ts-check
+'use strict';
+
+const PURE_ANNOTATION = /^\s*[#@]__PURE__\s*$/;
+
+/**
+ * Angular's own app build already pure-annotates these at module scope
+ * (`pure-toplevel-functions`'s `sideEffectFreeConstructors`), so requiring it in source is noise.
+ */
+const AUTO_ANNOTATED_CONSTRUCTORS = new Set(['InjectionToken']);
+
+/** Nothing inside a function body runs on import, so it needs no annotation. */
+const NOT_EVALUATED_ON_IMPORT = new Set(['ArrowFunctionExpression', 'FunctionExpression', 'ClassExpression']);
+
+const isModuleScope = (declarator) => {
+  const declaration = declarator.parent;
+  const container = declaration?.parent;
+
+  if (container?.type === 'Program') return true;
+
+  return container?.type === 'ExportNamedDeclaration' && container.parent?.type === 'Program';
+};
+
+const hasPureAnnotation = (sourceCode, node) =>
+  sourceCode.getCommentsBefore(node).some((comment) => comment.type === 'Block' && PURE_ANNOTATION.test(comment.value));
+
+/** `f()`, `ns.f()` and `new X()` are nameable; an IIFE is not, and is left alone. */
+const calleeName = (node) => {
+  const callee = node.callee;
+
+  if (callee.type === 'Identifier') return callee.name;
+  if (callee.type === 'MemberExpression' && callee.property.type === 'Identifier') return callee.property.name;
+
+  return null;
+};
+
+/** Every call/`new` in an initializer that really is evaluated when the module is imported. */
+const collectImportTimeCalls = (root) => {
+  const found = [];
+
+  const visit = (node) => {
+    if (!node || typeof node.type !== 'string' || NOT_EVALUATED_ON_IMPORT.has(node.type)) return;
+
+    if (node.type === 'CallExpression' || node.type === 'NewExpression') found.push(node);
+
+    for (const key of Object.keys(node)) {
+      if (key === 'parent') continue;
+
+      const child = node[key];
+
+      if (Array.isArray(child)) child.forEach(visit);
+      else if (child && typeof child === 'object') visit(child);
+    }
+  };
+
+  visit(root);
+
+  return found;
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const noImpureTopLevelProvider = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'Disallow module-scope destructuring of a factory call, and require a pure annotation on module-scope calls in library source.',
+    },
+    fixable: 'code',
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          requirePureAnnotation: {
+            type: 'boolean',
+            description:
+              'Also require `@__PURE__` on every call evaluated at module scope. Turn this on in publishable library source; it is pointless in application code, where every statement is retained anyway.',
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      noDestructuring:
+        'Do not destructure a factory call at module scope. Destructuring invokes the iterator protocol, so no bundler can drop the statement — everything the factory closes over ships to every consumer. Assign the result to one `const` and name each binding with its own annotated extractor (`toProvideFn` / `toInjectFn` / `toToken`).',
+      missingPure:
+        'This module-scope call to `{{name}}` needs a `/* @__PURE__ */` annotation, or the whole declaration is retained in every consumer bundle — one unannotated call anywhere in an initializer (including inside an argument or an object literal) is enough. If the call is genuinely not side-effect free at import time, move it inside a function instead of annotating it: library code must not do work on import.',
+    },
+  },
+  create(context) {
+    const sourceCode = context.sourceCode;
+    const requirePureAnnotation = context.options[0]?.requirePureAnnotation === true;
+
+    return {
+      VariableDeclarator(node) {
+        if (!isModuleScope(node) || !node.init) return;
+
+        const initializer = node.init.type === 'TSAsExpression' ? node.init.expression : node.init;
+
+        if (
+          initializer.type === 'CallExpression' &&
+          (node.id.type === 'ArrayPattern' || node.id.type === 'ObjectPattern')
+        ) {
+          context.report({ node, messageId: 'noDestructuring' });
+
+          return;
+        }
+
+        if (!requirePureAnnotation || node.id.type !== 'Identifier') return;
+
+        for (const call of collectImportTimeCalls(initializer)) {
+          const name = calleeName(call);
+
+          if (name === null || hasPureAnnotation(sourceCode, call)) continue;
+          if (call.type === 'NewExpression' && AUTO_ANNOTATED_CONSTRUCTORS.has(name)) continue;
+
+          context.report({
+            node: call,
+            messageId: 'missingPure',
+            data: { name },
+            fix: (fixer) => fixer.insertTextBefore(call, '/* @__PURE__ */ '),
+          });
+        }
+      },
+    };
+  },
+};
+
+module.exports = noImpureTopLevelProvider;