@ethlete/eslint-plugin 0.1.0-next.0 → 0.1.0-next.1

package/src/rules/no-legacy-angular-decorators.js

@@ -0,0 +1,210 @@
+// @ts-check
+'use strict';
+
+/**
+ * Disallows legacy Angular decorators in favour of their modern signal-based
+ * equivalents and the `host: {}` shorthand.
+ *
+ * Signal-based replacements:
+ *   ❌ @Input()           → ✅ input()
+ *   ❌ @Output()          → ✅ output()
+ *   ❌ @ViewChild()       → ✅ viewChild()
+ *   ❌ @ViewChildren()    → ✅ viewChildren()
+ *   ❌ @ContentChild()    → ✅ contentChild()
+ *   ❌ @ContentChildren() → ✅ contentChildren()
+ *
+ * Pair detection — when @Input() x and @Output() xChange are declared in the
+ * same class they form a two-way binding pattern that must be replaced by
+ * model():
+ *   ❌ @Input() value; @Output() valueChange = new EventEmitter();
+ *   → ✅ value = model();
+ *
+ * Host bindings — use the host: {} property instead:
+ *   ❌ @HostBinding('class.active') isActive = false;
+ *   ❌ @HostListener('click') onClick() {}
+ *   → ✅ host: { '[class.active]': 'isActive', '(click)': 'onClick()' }
+ */
+
+/**
+ * Returns the identifier name of a decorator.
+ * Works for both `@Foo` (Identifier) and `@Foo(...)` (CallExpression).
+ *
+ * @param {any} decorator
+ * @returns {string | null}
+ */
+const getDecoratorName = (decorator) => {
+  const expr = decorator.expression;
+  if (expr.type === 'Identifier') return expr.name;
+  if (expr.type === 'CallExpression' && expr.callee.type === 'Identifier') return expr.callee.name;
+  return null;
+};
+
+/**
+ * Returns the static string key of a class member, or null for computed keys.
+ *
+ * @param {any} node - PropertyDefinition or MethodDefinition
+ * @returns {string | null}
+ */
+const getMemberName = (node) => {
+  if (!node.computed && node.key.type === 'Identifier') return node.key.name;
+  if (!node.computed && node.key.type === 'Literal') return String(node.key.value);
+  return null;
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const rule = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description:
+        'Disallow legacy Angular decorators (@Input, @Output, @ViewChild, etc.) in favour of signal-based APIs and host: {} bindings.',
+    },
+    schema: [],
+    messages: {
+      useInput: 'Use the input() signal function instead of @Input().',
+      useOutput: 'Use the output() signal function instead of @Output().',
+      useViewChild: 'Use the viewChild() signal function instead of @ViewChild().',
+      useViewChildren: 'Use the viewChildren() signal function instead of @ViewChildren().',
+      useContentChild: 'Use the contentChild() signal function instead of @ContentChild().',
+      useContentChildren: 'Use the contentChildren() signal function instead of @ContentChildren().',
+      useHostBinding: 'Use the host: {} property in @Component/@Directive instead of @HostBinding().',
+      useHostListener: 'Use the host: {} property in @Component/@Directive instead of @HostListener().',
+      useModel:
+        "Use model() instead of the @Input()/@Output() two-way binding pattern ('{{inputName}}' / '{{outputName}}').",
+    },
+  },
+  create(context) {
+    /**
+     * Stack of per-class contexts used to detect two-way binding pairs.
+     * We defer @Input / @Output reporting to class exit so we can check whether
+     * a `xChange` output has a matching `x` input (→ model()).
+     *
+     * @type {Array<{ inputs: Map<string, any>; outputs: Map<string, any> }>}
+     */
+    const classStack = [];
+
+    const currentClass = () => classStack[classStack.length - 1] ?? null;
+
+    const pushClass = () => classStack.push({ inputs: new Map(), outputs: new Map() });
+
+    const popClass = () => {
+      const ctx = classStack.pop();
+      if (!ctx) return;
+
+      const reportedInputNames = new Set();
+      const reportedOutputNames = new Set();
+
+      // Detect @Input() x + @Output() xChange pairs → suggest model()
+      for (const [outputName, outputDecoratorNode] of ctx.outputs) {
+        if (!outputName.endsWith('Change')) continue;
+        const inputName = outputName.slice(0, -'Change'.length);
+        if (!ctx.inputs.has(inputName)) continue;
+
+        reportedInputNames.add(inputName);
+        reportedOutputNames.add(outputName);
+
+        context.report({
+          node: ctx.inputs.get(inputName),
+          messageId: 'useModel',
+          data: { inputName, outputName },
+        });
+        context.report({
+          node: outputDecoratorNode,
+          messageId: 'useModel',
+          data: { inputName, outputName },
+        });
+      }
+
+      // Report remaining @Input() decorators that are not part of a pair
+      for (const [name, decoratorNode] of ctx.inputs) {
+        if (!reportedInputNames.has(name)) {
+          context.report({ node: decoratorNode, messageId: 'useInput' });
+        }
+      }
+
+      // Report remaining @Output() decorators that are not part of a pair
+      for (const [name, decoratorNode] of ctx.outputs) {
+        if (!reportedOutputNames.has(name)) {
+          context.report({ node: decoratorNode, messageId: 'useOutput' });
+        }
+      }
+    };
+
+    return {
+      ClassDeclaration: pushClass,
+      ClassExpression: pushClass,
+      'ClassDeclaration:exit': popClass,
+      'ClassExpression:exit': popClass,
+
+      Decorator(node) {
+        const anyNode = /** @type {any} */ (node);
+        const decoratorName = getDecoratorName(anyNode);
+        if (!decoratorName) return;
+
+        // Only act on decorators attached to class members, not to the class itself
+        const parent = anyNode.parent;
+        if (!parent) return;
+        if (parent.type !== 'PropertyDefinition' && parent.type !== 'MethodDefinition') return;
+
+        const ctx = currentClass();
+
+        switch (decoratorName) {
+          case 'Input': {
+            if (!ctx) {
+              context.report({ node, messageId: 'useInput' });
+              break;
+            }
+            const memberName = getMemberName(parent);
+            if (memberName !== null) {
+              ctx.inputs.set(memberName, node);
+            } else {
+              // Computed key — cannot be part of a two-way binding pair, report immediately
+              context.report({ node, messageId: 'useInput' });
+            }
+            break;
+          }
+
+          case 'Output': {
+            if (!ctx) {
+              context.report({ node, messageId: 'useOutput' });
+              break;
+            }
+            const memberName = getMemberName(parent);
+            if (memberName !== null) {
+              ctx.outputs.set(memberName, node);
+            } else {
+              context.report({ node, messageId: 'useOutput' });
+            }
+            break;
+          }
+
+          case 'ViewChild':
+            context.report({ node, messageId: 'useViewChild' });
+            break;
+
+          case 'ViewChildren':
+            context.report({ node, messageId: 'useViewChildren' });
+            break;
+
+          case 'ContentChild':
+            context.report({ node, messageId: 'useContentChild' });
+            break;
+
+          case 'ContentChildren':
+            context.report({ node, messageId: 'useContentChildren' });
+            break;
+
+          case 'HostBinding':
+            context.report({ node, messageId: 'useHostBinding' });
+            break;
+
+          case 'HostListener':
+            context.report({ node, messageId: 'useHostListener' });
+            break;
+        }
+      },
+    };
+  },
+};
+
+module.exports = rule;

package/src/rules/no-locale-id.js

@@ -0,0 +1,57 @@
+// @ts-check
+'use strict';
+
+/**
+ * Disallows injecting Angular's LOCALE_ID token directly.
+ *
+ * @ethlete/core provides injectLocale() which wraps LOCALE_ID in a signal
+ * and exposes helper utilities for locale-aware formatting.
+ *
+ * BAD:
+ *   inject(LOCALE_ID)
+ *   import { LOCALE_ID } from '@angular/core';
+ *
+ * GOOD:
+ *   import { injectLocale } from '@ethlete/core';
+ *   const locale = injectLocale();
+ */
+
+/** @type {import('eslint').Rule.RuleModule} */
+const noLocaleId = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: "Disallow injecting 'LOCALE_ID' directly. Use 'injectLocale()' from '@ethlete/core' instead.",
+      recommended: true,
+    },
+    messages: {
+      noLocaleId:
+        "Do not inject 'LOCALE_ID' directly. Use 'injectLocale()' from '@ethlete/core' instead — it wraps LOCALE_ID and provides a clean, signal-compatible API.",
+    },
+    schema: [],
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        const { callee } = node;
+        if (callee.type !== 'Identifier' || callee.name !== 'inject') return;
+        const arg = node.arguments[0];
+        if (arg?.type === 'Identifier' && arg.name === 'LOCALE_ID') {
+          context.report({ node, messageId: 'noLocaleId' });
+        }
+      },
+
+      ImportDeclaration(node) {
+        if (node.source.value !== '@angular/core') return;
+        for (const specifier of node.specifiers) {
+          if (specifier.type === 'ImportSpecifier' && specifier.imported.name === 'LOCALE_ID') {
+            context.report({ node, messageId: 'noLocaleId' });
+            return;
+          }
+        }
+      },
+    };
+  },
+};
+
+module.exports = noLocaleId;

package/src/rules/no-member-alias.js

@@ -0,0 +1,151 @@
+// @ts-check
+'use strict';
+
+/**
+ * Disallows class members that exist solely as aliases for a nested property or
+ * zero-arg method of another class member accessed via `this`.
+ *
+ * These aliases add an extra layer of indirection without any benefit. Instead,
+ * the source member should be widened in accessibility so it can be referenced
+ * directly at the call/template site.
+ *
+ * BAD — property alias:
+ *   private stackDirective = inject(NotificationStackDirective);
+ *   protected displayRefs = this.stackDirective.displayRefs;   // just an alias
+ *
+ * BAD — zero-arg method alias:
+ *   context = inject(SomeContextToken);
+ *   retry() { this.context.retry(); }
+ *
+ * GOOD:
+ *   protected stackDirective = inject(NotificationStackDirective);
+ *   // use stackDirective.displayRefs directly in the template
+ *
+ *   context = inject(SomeContextToken);
+ *   // callers use directive.context.retry() directly
+ *
+ * Property rule fires when the entire initializer is a single `this.a.b`
+ * expression — it will not flag deeper chains, computed accesses, or any
+ * expression that does more than a plain property read.
+ *
+ * Method rule fires when a zero-param method body contains exactly one
+ * statement that calls `this.a.b()` with zero arguments AND the method name
+ * matches the target method name exactly. When the names differ the method is
+ * an intentional API rename (e.g. retry → playerResource.reload) and is not
+ * flagged.
+ */
+
+/**
+ * Checks whether a method node is a pure zero-arg forwarding alias of the form:
+ *   method() { this.source.method(); }
+ *   method() { return this.source.method(); }
+ *
+ * @param {any} node  MethodDefinition
+ * @returns {{ sourceName: string, propName: string } | null}
+ */
+const getMethodAliasInfo = (node) => {
+  if (node.kind === 'constructor' || node.kind === 'get' || node.kind === 'set') return null;
+
+  const fn = node.value;
+  if (!fn || fn.params.length !== 0) return null;
+
+  const body = fn.body;
+  if (!body || body.type !== 'BlockStatement' || body.body.length !== 1) return null;
+
+  const stmt = body.body[0];
+  let callExpr = null;
+  if (stmt.type === 'ExpressionStatement') {
+    callExpr = stmt.expression;
+  } else if (stmt.type === 'ReturnStatement' && stmt.argument) {
+    callExpr = stmt.argument;
+  }
+  if (!callExpr || callExpr.type !== 'CallExpression') return null;
+
+  // Must have zero arguments
+  if (callExpr.arguments.length !== 0) return null;
+
+  const callee = callExpr.callee;
+  // callee must be: this.something.method
+  if (callee.type !== 'MemberExpression') return null;
+  if (callee.computed) return null;
+  if (callee.property.type !== 'Identifier') return null;
+
+  const obj = callee.object;
+  if (obj.type !== 'MemberExpression') return null;
+  if (obj.computed) return null;
+  if (obj.object.type !== 'ThisExpression') return null;
+  if (obj.property.type !== 'Identifier') return null;
+
+  return { sourceName: obj.property.name, propName: callee.property.name };
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const noMemberAlias = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description:
+        'Disallow class members that are pure aliases for a nested property or zero-arg method of another member accessed via `this`.',
+      recommended: true,
+    },
+    messages: {
+      noAlias:
+        '`{{alias}}` is a pure alias for `this.{{source}}.{{prop}}`. ' +
+        'Remove the alias and widen the accessibility of `{{source}}` so it can be used directly.',
+    },
+    schema: [],
+  },
+  create(context) {
+    return {
+      PropertyDefinition(node) {
+        const value = node.value;
+        if (!value) return;
+
+        // Must be: this.something.property
+        if (value.type !== 'MemberExpression') return;
+        // Outer property must be a plain identifier (not computed)
+        if (value.computed) return;
+        if (value.property.type !== 'Identifier') return;
+
+        const obj = value.object;
+        // Object must itself be: this.something
+        if (obj.type !== 'MemberExpression') return;
+        if (obj.computed) return;
+        if (obj.object.type !== 'ThisExpression') return;
+        if (obj.property.type !== 'Identifier') return;
+
+        const aliasName = node.key.type === 'Identifier' ? node.key.name : null;
+        if (!aliasName) return;
+
+        const sourceName = obj.property.name;
+        const propName = value.property.name;
+
+        context.report({
+          node,
+          messageId: 'noAlias',
+          data: { alias: aliasName, source: sourceName, prop: propName },
+        });
+      },
+
+      MethodDefinition(node) {
+        const aliasName = node.key.type === 'Identifier' ? node.key.name : null;
+        if (!aliasName) return;
+
+        const info = getMethodAliasInfo(node);
+        if (!info) return;
+
+        // Only flag when names match — different names indicate an intentional
+        // API rename, which is not a pure alias.
+        if (aliasName !== info.propName) return;
+
+        context.report({
+          node,
+          messageId: 'noAlias',
+          data: { alias: aliasName, source: info.sourceName, prop: info.propName },
+        });
+      },
+    };
+  },
+};
+
+module.exports = noMemberAlias;

package/src/rules/no-native-observers.js

@@ -0,0 +1,102 @@
+// @ts-check
+'use strict';
+
+/**
+ * Disallows raw browser Observer APIs (IntersectionObserver, MutationObserver,
+ * ResizeObserver, PerformanceObserver). Use the signal-based utilities from
+ * @ethlete/core instead.
+ *
+ * The signal utilities:
+ * - Integrate automatically with Angular's reactivity model
+ * - Tear down the observer when the component is destroyed (no memory leaks)
+ * - Are composable with other signals and computed()
+ * - Require no manual disconnect() calls
+ *
+ * BAD:
+ *   new IntersectionObserver(cb, options)
+ *   new MutationObserver(cb)
+ *   new ResizeObserver(cb)
+ *
+ * GOOD:
+ *   // IntersectionObserver → from @ethlete/core
+ *   signalElementIntersection(elementRef, options)
+ *   signalHostElementIntersection(options)   // shortcut inside a directive/component
+ *
+ *   // MutationObserver → from @ethlete/core
+ *   signalElementMutations(elementRef, options)
+ *   signalHostElementMutations(options)
+ *
+ *   // ResizeObserver → from @ethlete/core
+ *   signalElementDimensions(elementRef)
+ *   signalHostElementDimensions()
+ */
+
+/**
+ * Maps Observer constructor names to their @ethlete/core signal equivalents.
+ * @type {Record<string, { alternatives: string[], from: string } | null>}
+ */
+const OBSERVER_ALTERNATIVES = {
+  IntersectionObserver: {
+    alternatives: ['signalElementIntersection', 'signalHostElementIntersection'],
+    from: '@ethlete/core',
+  },
+  MutationObserver: {
+    alternatives: ['signalElementMutations', 'signalHostElementMutations'],
+    from: '@ethlete/core',
+  },
+  ResizeObserver: {
+    alternatives: ['signalElementDimensions', 'signalHostElementDimensions'],
+    from: '@ethlete/core',
+  },
+  PerformanceObserver: null,
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const noNativeObservers = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: "Disallow raw browser Observer APIs. Use signal-based utilities from '@ethlete/core' instead.",
+      recommended: true,
+    },
+    messages: {
+      useSignalUtil:
+        "Use '{{alternatives}}' from '{{from}}' instead of 'new {{observer}}()'. The signal utility auto-cleans up when the component is destroyed.",
+      avoidObserver:
+        "Avoid 'new {{observer}}()'. Prefer a reactive signal utility from '@ethlete/core' where possible, or ensure you call disconnect() in inject(DestroyRef).onDestroy().",
+    },
+    schema: [],
+  },
+  create(context) {
+    return {
+      NewExpression(node) {
+        if (node.callee.type !== 'Identifier') return;
+
+        const name = node.callee.name;
+        if (!(name in OBSERVER_ALTERNATIVES)) return;
+
+        const info = OBSERVER_ALTERNATIVES[name];
+
+        if (info) {
+          context.report({
+            node,
+            messageId: 'useSignalUtil',
+            data: {
+              observer: name,
+              alternatives: info.alternatives.join(' or '),
+              from: info.from,
+            },
+          });
+        } else {
+          context.report({
+            node,
+            messageId: 'avoidObserver',
+            data: { observer: name },
+          });
+        }
+      },
+    };
+  },
+};
+
+module.exports = noNativeObservers;

package/src/rules/no-pipe-logic.js

@@ -0,0 +1,76 @@
+// @ts-check
+'use strict';
+
+/**
+ * Checks whether a class node has a @Pipe decorator.
+ * @param {import('eslint').Rule.Node} classNode
+ */
+const hasPipeDecorator = (classNode) => {
+  const decorators = /** @type {any} */ (classNode).decorators ?? [];
+  return decorators.some((/** @type {any} */ dec) => {
+    const expr = dec.expression;
+    if (expr.type === 'CallExpression') {
+      return expr.callee.type === 'Identifier' && expr.callee.name === 'Pipe';
+    }
+    if (expr.type === 'Identifier') {
+      return expr.name === 'Pipe';
+    }
+    return false;
+  });
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const noPipeLogic = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description:
+        'Pipes must not contain logic in the transform method. Extract to a utility function and assign it: `transform = myUtil;`',
+    },
+    messages: {
+      noLogicInTransform:
+        'Pipes must not contain logic in transform. Extract to a utility function and assign it: `transform = myUtil;`',
+    },
+    schema: [],
+  },
+  create(context) {
+    return {
+      // Case 1: transform() { ... } — method with a body
+      MethodDefinition(node) {
+        const key = /** @type {any} */ (node).key;
+        if (key.type !== 'Identifier' || key.name !== 'transform') return;
+
+        const classBody = node.parent;
+        if (!classBody || classBody.type !== 'ClassBody') return;
+
+        const classNode = classBody.parent;
+        if (!classNode || (classNode.type !== 'ClassDeclaration' && classNode.type !== 'ClassExpression')) return;
+
+        if (!hasPipeDecorator(classNode)) return;
+
+        context.report({ node, messageId: 'noLogicInTransform' });
+      },
+
+      // Case 2: transform = () => { ... } or transform = function() { ... }
+      PropertyDefinition(node) {
+        const key = /** @type {any} */ (node).key;
+        if (key.type !== 'Identifier' || key.name !== 'transform') return;
+
+        const classBody = node.parent;
+        if (!classBody || classBody.type !== 'ClassBody') return;
+
+        const classNode = classBody.parent;
+        if (!classNode || (classNode.type !== 'ClassDeclaration' && classNode.type !== 'ClassExpression')) return;
+
+        if (!hasPipeDecorator(classNode)) return;
+
+        const value = /** @type {any} */ (node).value;
+        if (value && (value.type === 'ArrowFunctionExpression' || value.type === 'FunctionExpression')) {
+          context.report({ node, messageId: 'noLogicInTransform' });
+        }
+      },
+    };
+  },
+};
+
+module.exports = noPipeLogic;

package/src/rules/no-public-property.js

@@ -0,0 +1,39 @@
+// @ts-check
+'use strict';
+
+/**
+ * @param {any} node
+ */
+const isInjectCall = (node) => {
+  if (!node || node.type !== 'CallExpression') return false;
+  return node.callee.type === 'Identifier' && node.callee.name === 'inject';
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+const noPublicProperty = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'Disallow explicit public on class properties, except for injected members that intentionally expose an external API.',
+      recommended: true,
+    },
+    schema: [],
+    messages: {
+      noPublicProperty:
+        'No public keyword on class properties. The only exception is an injected member that intentionally exposes an external API.',
+    },
+  },
+  create(context) {
+    return {
+      PropertyDefinition(node) {
+        if (node.accessibility !== 'public') return;
+        if (isInjectCall(node.value)) return;
+
+        context.report({ node, messageId: 'noPublicProperty' });
+      },
+    };
+  },
+};
+
+module.exports = noPublicProperty;