@ethlete/eslint-plugin 1.0.0-next.25 → 1.0.0-next.26

package/src/rules/require-on-push-change-detection.js

@@ -1,266 +1,13 @@
 // @ts-check
 'use strict';
 
-const {
-  ANGULAR_CORE,
-  getAngularDecoratorName,
-  getImportLocalName,
-  isImportedAs,
-  resolveIdentifier,
-} = require('./internals/import-resolution');
+const { getAngularMajor } = require('./internals/angular-version');
+const { buildRequiredEnumFix, getPropertyName } = require('./internals/angular-metadata-fix');
+const { getAngularDecoratorName, isImportedAs } = require('./internals/import-resolution');
 
-const COMPONENT_ORDER = ['selector', 'template', 'styleUrl', 'encapsulation', 'changeDetection'];
-
-// OnPush became the default change detection strategy in Angular 22, so from
-// v22 onward it must NOT be declared (see no-redundant-on-push-change-detection).
-// This rule therefore only applies to older Angular, where OnPush is opt-in.
 const MAX_MAJOR = 21;
 
-/** @type {number | null | undefined} */
-let cachedAngularMajor;
-
-/**
- * Detect the workspace's installed Angular major version. Cached across files.
- *
- * @returns {number | null} major version, or null when it cannot be determined
- */
-const detectAngularMajor = () => {
-  if (cachedAngularMajor !== undefined) return cachedAngularMajor;
-
-  try {
-    const pkg = require('@angular/core/package.json');
-    const major = Number.parseInt(String(pkg.version).split('.')[0], 10);
-    cachedAngularMajor = Number.isNaN(major) ? null : major;
-  } catch {
-    cachedAngularMajor = null;
-  }
-
-  return cachedAngularMajor;
-};
-
-/**
- * Resolve the Angular major version to gate on. An explicit
- * `settings.ethlete.angularMajor` wins over auto-detection — handy for
- * pinning behaviour and for tests.
- *
- * @param {import('eslint').Rule.RuleContext} context
- * @returns {number | null}
- */
-const getAngularMajor = (context) => {
-  const settings = /** @type {any} */ (context.settings);
-  const override = settings?.ethlete?.angularMajor;
-  if (typeof override === 'number') return override;
-
-  return detectAngularMajor();
-};
-
-/**
- * @param {import('estree').Property['key']} key
- */
-const getPropertyName = (key) => {
-  if (key.type === 'Identifier') return key.name;
-  if (key.type === 'Literal' && typeof key.value === 'string') return key.value;
-  return null;
-};
-
-/**
- * @param {string | null} propertyName
- */
-const getOrderKey = (propertyName) => {
-  if (propertyName === 'template' || propertyName === 'templateUrl') return 'template';
-  if (propertyName === 'styleUrl' || propertyName === 'styleUrls') return 'styleUrl';
-  return propertyName;
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {import('eslint').AST.Token | import('eslint').Rule.Node} node
- */
-const getIndent = (sourceCode, node) => {
-  if (!node.loc) return '';
-
-  const line = sourceCode.lines[node.loc.start.line - 1] ?? '';
-  return line.slice(0, node.loc.start.column);
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {any} property
- */
-const hasTrailingComma = (sourceCode, property) => {
-  const tokenAfter = sourceCode.getTokenAfter(property);
-  return Boolean(tokenAfter && tokenAfter.type === 'Punctuator' && tokenAfter.value === ',');
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- */
-const findAngularCoreImport = (sourceCode) => {
-  const imports = sourceCode.ast.body.filter(
-    (node) =>
-      node.type === 'ImportDeclaration' && node.source.type === 'Literal' && node.source.value === '@angular/core',
-  );
-
-  return (
-    imports.find((node) =>
-      node.specifiers.some(
-        (specifier) =>
-          specifier.type === 'ImportSpecifier' &&
-          specifier.imported.type === 'Identifier' &&
-          specifier.imported.name === 'ChangeDetectionStrategy',
-      ),
-    ) ??
-    imports.find((node) => node.importKind !== 'type') ??
-    null
-  );
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {any} importNode
- */
-const buildAngularCoreImportFix = (sourceCode, importNode) => {
-  const specifiers = importNode.specifiers ?? [];
-  const hasChangeDetectionStrategy = specifiers.some(
-    (specifier) =>
-      specifier.type === 'ImportSpecifier' &&
-      specifier.imported.type === 'Identifier' &&
-      specifier.imported.name === 'ChangeDetectionStrategy',
-  );
-  if (hasChangeDetectionStrategy) return null;
-
-  const defaultSpecifier = specifiers.find((specifier) => specifier.type === 'ImportDefaultSpecifier') ?? null;
-  const namespaceSpecifier = specifiers.find((specifier) => specifier.type === 'ImportNamespaceSpecifier') ?? null;
-  const namedSpecifiers = specifiers.filter((specifier) => specifier.type === 'ImportSpecifier');
-
-  if (namespaceSpecifier) {
-    return (fixer) => fixer.insertTextAfter(importNode, `\nimport { ChangeDetectionStrategy } from '@angular/core';`);
-  }
-
-  const importParts = [];
-  if (defaultSpecifier) {
-    importParts.push(sourceCode.getText(defaultSpecifier));
-  }
-
-  const namedTexts = namedSpecifiers.map((specifier) => sourceCode.getText(specifier));
-  importParts.push(`{ ${[...namedTexts, 'ChangeDetectionStrategy'].join(', ')} }`);
-
-  return (fixer) => fixer.replaceText(importNode, `import ${importParts.join(', ')} from '@angular/core';`);
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- */
-const buildMissingAngularCoreImportFix = (sourceCode) => {
-  const importDeclarations = sourceCode.ast.body.filter((node) => node.type === 'ImportDeclaration');
-  const lastImport = importDeclarations[importDeclarations.length - 1] ?? null;
-
-  if (lastImport) {
-    return (fixer) => fixer.insertTextAfter(lastImport, `\nimport { ChangeDetectionStrategy } from '@angular/core';`);
-  }
-
-  const firstNode = sourceCode.ast.body[0];
-  const lastComment = firstNode ? sourceCode.getCommentsBefore(firstNode).at(-1) : null;
-
-  return lastComment
-    ? (fixer) => fixer.insertTextAfter(lastComment, `\nimport { ChangeDetectionStrategy } from '@angular/core';\n`)
-    : (fixer) =>
-        fixer.replaceTextRange(
-          [0, firstNode?.range[0] ?? 0],
-          `import { ChangeDetectionStrategy } from '@angular/core';\n\n`,
-        );
-};
-
-/**
- * @param {any} metadata
- */
-const getChangeDetectionInsertionTarget = (metadata) => {
-  if (metadata.properties.some((property) => property.type === 'SpreadElement')) return null;
-
-  const changeDetectionIndex = COMPONENT_ORDER.indexOf('changeDetection');
-
-  return (
-    metadata.properties.find((property) => {
-      if (property.type !== 'Property') return false;
-
-      const propertyName = getOrderKey(getPropertyName(property.key));
-      const propertyIndex = propertyName === null ? COMPONENT_ORDER.length : COMPONENT_ORDER.indexOf(propertyName);
-      return propertyIndex > changeDetectionIndex || propertyIndex === -1;
-    }) ?? null
-  );
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {any} metadata
- */
-const buildMetadataFix = (sourceCode, metadata) => {
-  const changeDetectionText = `changeDetection: ${getImportLocalName(sourceCode, ANGULAR_CORE, 'ChangeDetectionStrategy') ?? 'ChangeDetectionStrategy'}.OnPush`;
-  const properties = metadata.properties;
-  const insertionTarget = getChangeDetectionInsertionTarget(metadata);
-  const isMultiline = Boolean(metadata.loc && metadata.loc.start.line !== metadata.loc.end.line);
-
-  if (properties.length === 0) {
-    return (fixer) => fixer.replaceText(metadata, `{ ${changeDetectionText} }`);
-  }
-
-  if (insertionTarget) {
-    if (isMultiline) {
-      const propertyIndent = getIndent(sourceCode, insertionTarget);
-      return (fixer) => fixer.insertTextBefore(insertionTarget, `${changeDetectionText},\n${propertyIndent}`);
-    }
-
-    return (fixer) => fixer.insertTextBefore(insertionTarget, `${changeDetectionText}, `);
-  }
-
-  const lastProperty = properties[properties.length - 1];
-  const closingBrace = sourceCode.getLastToken(metadata);
-  if (!lastProperty || !closingBrace) return null;
-
-  if (isMultiline) {
-    const closingIndent = getIndent(sourceCode, closingBrace);
-    const propertyIndent = getIndent(sourceCode, lastProperty);
-    const separator = hasTrailingComma(sourceCode, lastProperty) ? '' : ',';
-    const rangeStart =
-      separator === ''
-        ? (sourceCode.getTokenAfter(lastProperty)?.range[1] ?? lastProperty.range[1])
-        : lastProperty.range[1];
-
-    return (fixer) =>
-      fixer.replaceTextRange(
-        [rangeStart, closingBrace.range[0]],
-        `${separator}\n${propertyIndent}${changeDetectionText}\n${closingIndent}`,
-      );
-  }
-
-  const separator = hasTrailingComma(sourceCode, lastProperty) ? '' : ',';
-  return (fixer) =>
-    fixer.replaceTextRange([lastProperty.range[1], closingBrace.range[0]], `${separator} ${changeDetectionText} `);
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {any} metadata
- * @param {any} valueNode
- */
-const buildFix = (sourceCode, metadata, valueNode) => {
-  const valueFix = valueNode && ((fixer) => fixer.replaceText(valueNode.property, 'OnPush'));
-  if (valueNode && valueNode.object.type !== 'Identifier') return valueFix;
-  if (valueNode && resolveIdentifier(sourceCode, valueNode.object)?.source) return valueFix;
-
-  const fixes = [];
-  const angularCoreImport = findAngularCoreImport(sourceCode);
-  const importFix = angularCoreImport
-    ? buildAngularCoreImportFix(sourceCode, angularCoreImport)
-    : buildMissingAngularCoreImportFix(sourceCode);
-
-  if (importFix) fixes.push(importFix);
-
-  const metadataFix = valueFix ?? buildMetadataFix(sourceCode, metadata);
-  if (metadataFix) fixes.push(metadataFix);
-
-  return (fixer) => fixes.map((applyFix) => applyFix(fixer));
-};
+const SPEC = { property: 'changeDetection', importName: 'ChangeDetectionStrategy', member: 'OnPush' };
 
 /** @type {import('eslint').Rule.RuleModule} */
 const requireOnPushChangeDetection = {
@@ -268,6 +15,7 @@ const requireOnPushChangeDetection = {
     type: 'suggestion',
     docs: {
       description: 'Require `changeDetection: ChangeDetectionStrategy.OnPush` in all @Component decorators.',
+      recommended: true,
     },
     fixable: 'code',
     messages: {
@@ -305,7 +53,7 @@ const requireOnPushChangeDetection = {
           context.report({
             node: metadata,
             messageId: 'missing',
-            fix: buildFix(sourceCode, metadata, null),
+            fix: buildRequiredEnumFix(sourceCode, metadata, null, SPEC),
           });
           return;
         }
@@ -321,7 +69,7 @@ const requireOnPushChangeDetection = {
             node: value,
             messageId: 'notOnPush',
             data: { value: value.property.name },
-            fix: buildFix(sourceCode, metadata, value),
+            fix: buildRequiredEnumFix(sourceCode, metadata, value, SPEC),
           });
         }
       },

package/src/rules/require-view-encapsulation-none.js

@@ -1,219 +1,10 @@
 // @ts-check
 'use strict';
 
-const {
-  ANGULAR_CORE,
-  getAngularDecoratorName,
-  getImportLocalName,
-  isImportedAs,
-  resolveIdentifier,
-} = require('./internals/import-resolution');
+const { buildRequiredEnumFix, getPropertyName } = require('./internals/angular-metadata-fix');
+const { getAngularDecoratorName, isImportedAs } = require('./internals/import-resolution');
 
-const COMPONENT_ORDER = ['selector', 'template', 'styleUrl', 'encapsulation', 'changeDetection'];
-
-/**
- * @param {import('estree').Property['key']} key
- */
-const getPropertyName = (key) => {
-  if (key.type === 'Identifier') return key.name;
-  if (key.type === 'Literal' && typeof key.value === 'string') return key.value;
-  return null;
-};
-
-/**
- * @param {string | null} propertyName
- */
-const getOrderKey = (propertyName) => {
-  if (propertyName === 'template' || propertyName === 'templateUrl') return 'template';
-  if (propertyName === 'styleUrl' || propertyName === 'styleUrls') return 'styleUrl';
-  return propertyName;
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {import('eslint').AST.Token | import('eslint').Rule.Node} node
- */
-const getIndent = (sourceCode, node) => {
-  if (!node.loc) return '';
-
-  const line = sourceCode.lines[node.loc.start.line - 1] ?? '';
-  return line.slice(0, node.loc.start.column);
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {any} property
- */
-const hasTrailingComma = (sourceCode, property) => {
-  const tokenAfter = sourceCode.getTokenAfter(property);
-  return Boolean(tokenAfter && tokenAfter.type === 'Punctuator' && tokenAfter.value === ',');
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- */
-const findAngularCoreImport = (sourceCode) => {
-  const imports = sourceCode.ast.body.filter(
-    (node) =>
-      node.type === 'ImportDeclaration' && node.source.type === 'Literal' && node.source.value === '@angular/core',
-  );
-
-  return (
-    imports.find((node) =>
-      node.specifiers.some(
-        (specifier) =>
-          specifier.type === 'ImportSpecifier' &&
-          specifier.imported.type === 'Identifier' &&
-          specifier.imported.name === 'ViewEncapsulation',
-      ),
-    ) ??
-    imports.find((node) => node.importKind !== 'type') ??
-    null
-  );
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {any} importNode
- */
-const buildAngularCoreImportFix = (sourceCode, importNode) => {
-  const specifiers = importNode.specifiers ?? [];
-  const hasViewEncapsulation = specifiers.some(
-    (specifier) =>
-      specifier.type === 'ImportSpecifier' &&
-      specifier.imported.type === 'Identifier' &&
-      specifier.imported.name === 'ViewEncapsulation',
-  );
-  if (hasViewEncapsulation) return null;
-
-  const defaultSpecifier = specifiers.find((specifier) => specifier.type === 'ImportDefaultSpecifier') ?? null;
-  const namespaceSpecifier = specifiers.find((specifier) => specifier.type === 'ImportNamespaceSpecifier') ?? null;
-  const namedSpecifiers = specifiers.filter((specifier) => specifier.type === 'ImportSpecifier');
-
-  if (namespaceSpecifier) {
-    return (fixer) => fixer.insertTextAfter(importNode, `\nimport { ViewEncapsulation } from '@angular/core';`);
-  }
-
-  const importParts = [];
-  if (defaultSpecifier) {
-    importParts.push(sourceCode.getText(defaultSpecifier));
-  }
-
-  const namedTexts = namedSpecifiers.map((specifier) => sourceCode.getText(specifier));
-  importParts.push(`{ ${[...namedTexts, 'ViewEncapsulation'].join(', ')} }`);
-
-  return (fixer) => fixer.replaceText(importNode, `import ${importParts.join(', ')} from '@angular/core';`);
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- */
-const buildMissingAngularCoreImportFix = (sourceCode) => {
-  const importDeclarations = sourceCode.ast.body.filter((node) => node.type === 'ImportDeclaration');
-  const lastImport = importDeclarations[importDeclarations.length - 1] ?? null;
-
-  if (lastImport) {
-    return (fixer) => fixer.insertTextAfter(lastImport, `\nimport { ViewEncapsulation } from '@angular/core';`);
-  }
-
-  const firstNode = sourceCode.ast.body[0];
-  const lastComment = firstNode ? sourceCode.getCommentsBefore(firstNode).at(-1) : null;
-
-  return lastComment
-    ? (fixer) => fixer.insertTextAfter(lastComment, `\nimport { ViewEncapsulation } from '@angular/core';\n`)
-    : (fixer) =>
-        fixer.replaceTextRange([0, firstNode?.range[0] ?? 0], `import { ViewEncapsulation } from '@angular/core';\n\n`);
-};
-
-/**
- * @param {any} metadata
- */
-const getEncapsulationInsertionTarget = (metadata) => {
-  if (metadata.properties.some((property) => property.type === 'SpreadElement')) return null;
-
-  const encapsulationIndex = COMPONENT_ORDER.indexOf('encapsulation');
-
-  return (
-    metadata.properties.find((property) => {
-      if (property.type !== 'Property') return false;
-
-      const propertyName = getOrderKey(getPropertyName(property.key));
-      const propertyIndex = propertyName === null ? COMPONENT_ORDER.length : COMPONENT_ORDER.indexOf(propertyName);
-      return propertyIndex > encapsulationIndex || propertyIndex === -1;
-    }) ?? null
-  );
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {any} metadata
- */
-const buildMetadataFix = (sourceCode, metadata) => {
-  const encText = `encapsulation: ${getImportLocalName(sourceCode, ANGULAR_CORE, 'ViewEncapsulation') ?? 'ViewEncapsulation'}.None`;
-  const properties = metadata.properties;
-  const insertionTarget = getEncapsulationInsertionTarget(metadata);
-  const isMultiline = Boolean(metadata.loc && metadata.loc.start.line !== metadata.loc.end.line);
-
-  if (properties.length === 0) {
-    return (fixer) => fixer.replaceText(metadata, `{ ${encText} }`);
-  }
-
-  if (insertionTarget) {
-    if (isMultiline) {
-      const propertyIndent = getIndent(sourceCode, insertionTarget);
-      return (fixer) => fixer.insertTextBefore(insertionTarget, `${encText},\n${propertyIndent}`);
-    }
-
-    return (fixer) => fixer.insertTextBefore(insertionTarget, `${encText}, `);
-  }
-
-  const lastProperty = properties[properties.length - 1];
-  const closingBrace = sourceCode.getLastToken(metadata);
-  if (!lastProperty || !closingBrace) return null;
-
-  if (isMultiline) {
-    const closingIndent = getIndent(sourceCode, closingBrace);
-    const propertyIndent = getIndent(sourceCode, lastProperty);
-    const separator = hasTrailingComma(sourceCode, lastProperty) ? '' : ',';
-    const rangeStart =
-      separator === ''
-        ? (sourceCode.getTokenAfter(lastProperty)?.range[1] ?? lastProperty.range[1])
-        : lastProperty.range[1];
-
-    return (fixer) =>
-      fixer.replaceTextRange(
-        [rangeStart, closingBrace.range[0]],
-        `${separator}\n${propertyIndent}${encText}\n${closingIndent}`,
-      );
-  }
-
-  const separator = hasTrailingComma(sourceCode, lastProperty) ? '' : ',';
-  return (fixer) => fixer.replaceTextRange([lastProperty.range[1], closingBrace.range[0]], `${separator} ${encText} `);
-};
-
-/**
- * @param {import('eslint').SourceCode} sourceCode
- * @param {any} metadata
- * @param {any} valueNode
- */
-const buildFix = (sourceCode, metadata, valueNode) => {
-  const valueFix = valueNode && ((fixer) => fixer.replaceText(valueNode.property, 'None'));
-  if (valueNode && valueNode.object.type !== 'Identifier') return valueFix;
-  if (valueNode && resolveIdentifier(sourceCode, valueNode.object)?.source) return valueFix;
-
-  const fixes = [];
-  const angularCoreImport = findAngularCoreImport(sourceCode);
-  const importFix = angularCoreImport
-    ? buildAngularCoreImportFix(sourceCode, angularCoreImport)
-    : buildMissingAngularCoreImportFix(sourceCode);
-
-  if (importFix) fixes.push(importFix);
-
-  const metadataFix = valueFix ?? buildMetadataFix(sourceCode, metadata);
-  if (metadataFix) fixes.push(metadataFix);
-
-  return (fixer) => fixes.map((applyFix) => applyFix(fixer));
-};
+const SPEC = { property: 'encapsulation', importName: 'ViewEncapsulation', member: 'None' };
 
 /** @type {import('eslint').Rule.RuleModule} */
 const requireViewEncapsulationNone = {
@@ -221,6 +12,7 @@ const requireViewEncapsulationNone = {
     type: 'suggestion',
     docs: {
       description: 'Require `encapsulation: ViewEncapsulation.None` in all @Component decorators.',
+      recommended: true,
     },
     fixable: 'code',
     messages: {
@@ -251,7 +43,7 @@ const requireViewEncapsulationNone = {
           context.report({
             node: metadata,
             messageId: 'missing',
-            fix: buildFix(sourceCode, metadata, null),
+            fix: buildRequiredEnumFix(sourceCode, metadata, null, SPEC),
           });
           return;
         }
@@ -267,7 +59,7 @@ const requireViewEncapsulationNone = {
             node: value,
             messageId: 'notNone',
             data: { value: value.property.name },
-            fix: buildFix(sourceCode, metadata, value),
+            fix: buildRequiredEnumFix(sourceCode, metadata, value, SPEC),
           });
         }
       },

package/src/rules/template-member-accessibility.js

@@ -35,15 +35,22 @@ const buildRemoveProtectedFix = (node, sourceCode) => {
   return (fixer) => fixer.removeRange([protectedToken.range[0], nextToken.range[0]]);
 };
 
+const MEMBER_TYPES = new Set([
+  'PropertyDefinition',
+  'AccessorProperty',
+  'TSAbstractPropertyDefinition',
+  'TSAbstractAccessorProperty',
+]);
+
 /**
  * @param {any} node
  */
 const isSupportedMember = (node) => {
-  if (node.type === 'PropertyDefinition') {
+  if (MEMBER_TYPES.has(node.type)) {
     return true;
   }
 
-  if (node.type === 'MethodDefinition') {
+  if (node.type === 'MethodDefinition' || node.type === 'TSAbstractMethodDefinition') {
     return node.kind !== 'constructor';
   }
 
@@ -134,6 +141,7 @@ const templateMemberAccessibility = {
       }
 
       if (node.accessibility !== 'protected') return;
+      if (node.type.startsWith('TSAbstract')) return;
 
       context.report({
         node,
@@ -174,11 +182,11 @@ const templateMemberAccessibility = {
     };
 
     return {
-      PropertyDefinition(node) {
+      'PropertyDefinition, AccessorProperty, TSAbstractPropertyDefinition, TSAbstractAccessorProperty'(node) {
         checkMember(node);
         checkImplicitPublicMember(node);
       },
-      MethodDefinition(node) {
+      'MethodDefinition, TSAbstractMethodDefinition'(node) {
         checkMember(node);
         checkImplicitPublicMember(node);
       },