@angular-eslint/schematics 22.3.1-alpha.7 → 22.3.1-alpha.8

package/dist/angular-version-compat.d.ts

@@ -24,4 +24,16 @@ export declare function findAngularVersionMismatches(workspacePackageJson: Packa
 export declare function hasDetectableAngularVersion(workspacePackageJson: PackageJsonLike, installedMajors?: Partial<Record<string, number | null>>): boolean;
 export declare function formatAngularVersionMismatchMessage(expectedMajor: number, mismatches: AngularVersionMismatch[]): string;
 export declare function formatAngularVersionMatchMessage(expectedMajor: number): string;
+/**
+ * The Angular major that the user should install angular-eslint for, based on
+ * the mismatches found. `@angular/core` is the source of truth for the
+ * workspace's Angular version, so prefer it over `@angular/cli`.
+ */
+export declare function getRecommendedAngularMajor(mismatches: AngularVersionMismatch[]): number | null;
+/**
+ * Error shown by `ng add` when the workspace Angular major does not match the
+ * angular-eslint major being added. Unlike the warning used by `ng lint`, this
+ * stops the schematic and tells the user exactly what to rerun.
+ */
+export declare function formatAngularVersionMismatchError(expectedMajor: number, mismatches: AngularVersionMismatch[]): string;
 //# sourceMappingURL=angular-version-compat.d.ts.map

package/dist/angular-version-compat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"angular-version-compat.d.ts","sourceRoot":"","sources":["../src/angular-version-compat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,yBAAyB,4CAG5B,CAAC;AAEX,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GACnC,MAAM,GAAG,IAAI,CAwBf;AAED,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,eAAe,EACpB,IAAI,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CAMpB;AAED,wBAAgB,4BAA4B,CAC1C,oBAAoB,EAAE,eAAe,EACrC,aAAa,EAAE,MAAM,EACrB,eAAe,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,GACvD,sBAAsB,EAAE,CAgB1B;AAED,wBAAgB,2BAA2B,CACzC,oBAAoB,EAAE,eAAe,EACrC,eAAe,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,GACvD,OAAO,CAWT;AAED,wBAAgB,mCAAmC,CACjD,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,sBAAsB,EAAE,GACnC,MAAM,CAcR;AAED,wBAAgB,gCAAgC,CAC9C,aAAa,EAAE,MAAM,GACpB,MAAM,CAER"}
+{"version":3,"file":"angular-version-compat.d.ts","sourceRoot":"","sources":["../src/angular-version-compat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,yBAAyB,4CAG5B,CAAC;AAEX,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GACnC,MAAM,GAAG,IAAI,CAwBf;AAED,wBAAgB,sBAAsB,CACpC,GAAG,EAAE,eAAe,EACpB,IAAI,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CAMpB;AAED,wBAAgB,4BAA4B,CAC1C,oBAAoB,EAAE,eAAe,EACrC,aAAa,EAAE,MAAM,EACrB,eAAe,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,GACvD,sBAAsB,EAAE,CAgB1B;AAED,wBAAgB,2BAA2B,CACzC,oBAAoB,EAAE,eAAe,EACrC,eAAe,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC,GACvD,OAAO,CAWT;AAsBD,wBAAgB,mCAAmC,CACjD,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,sBAAsB,EAAE,GACnC,MAAM,CAMR;AAED,wBAAgB,gCAAgC,CAC9C,aAAa,EAAE,MAAM,GACpB,MAAM,CAER;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,sBAAsB,EAAE,GACnC,MAAM,GAAG,IAAI,CAKf;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAC/C,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,sBAAsB,EAAE,GACnC,MAAM,CAgBR"}

package/dist/angular-version-compat.js

@@ -11,6 +11,8 @@ exports.findAngularVersionMismatches = findAngularVersionMismatches;
 exports.hasDetectableAngularVersion = hasDetectableAngularVersion;
 exports.formatAngularVersionMismatchMessage = formatAngularVersionMismatchMessage;
 exports.formatAngularVersionMatchMessage = formatAngularVersionMatchMessage;
+exports.getRecommendedAngularMajor = getRecommendedAngularMajor;
+exports.formatAngularVersionMismatchError = formatAngularVersionMismatchError;
 exports.ANGULAR_PACKAGES_TO_CHECK = [
     '@angular/core',
     '@angular/cli',
@@ -74,7 +76,8 @@ function hasDetectableAngularVersion(workspacePackageJson, installedMajors) {
             null);
     });
 }
-function formatAngularVersionMismatchMessage(expectedMajor, mismatches) {
+const ANGULAR_VERSION_SUPPORT_DOCS_URL = 'https://github.com/angular-eslint/angular-eslint/blob/main/docs/ANGULAR_VERSION_SUPPORT.md';
+function formatAngularVersionMismatchDetails(expectedMajor, mismatches) {
     const details = mismatches
         .map((mismatch) => `  - ${mismatch.packageName}@${mismatch.specifier} (v${mismatch.foundMajor})`)
         .join('\n');
@@ -82,10 +85,45 @@ function formatAngularVersionMismatchMessage(expectedMajor, mismatches) {
 angular-eslint v${expectedMajor} is intended for Angular v${expectedMajor}.
 This workspace is using a different Angular major:
 ${details}
+`.trim();
+}
+function formatAngularVersionMismatchMessage(expectedMajor, mismatches) {
+    return `
+${formatAngularVersionMismatchDetails(expectedMajor, mismatches)}
 
-See https://github.com/angular-eslint/angular-eslint/blob/main/docs/ANGULAR_VERSION_SUPPORT.md
+See ${ANGULAR_VERSION_SUPPORT_DOCS_URL}
 `.trim();
 }
 function formatAngularVersionMatchMessage(expectedMajor) {
     return `angular-eslint v${expectedMajor} matches this workspace's Angular v${expectedMajor}.`;
 }
+/**
+ * The Angular major that the user should install angular-eslint for, based on
+ * the mismatches found. `@angular/core` is the source of truth for the
+ * workspace's Angular version, so prefer it over `@angular/cli`.
+ */
+function getRecommendedAngularMajor(mismatches) {
+    const core = mismatches.find((mismatch) => mismatch.packageName === '@angular/core');
+    return core?.foundMajor ?? mismatches[0]?.foundMajor ?? null;
+}
+/**
+ * Error shown by `ng add` when the workspace Angular major does not match the
+ * angular-eslint major being added. Unlike the warning used by `ng lint`, this
+ * stops the schematic and tells the user exactly what to rerun.
+ */
+function formatAngularVersionMismatchError(expectedMajor, mismatches) {
+    const major = getRecommendedAngularMajor(mismatches) ?? '<your Angular major>';
+    return `
+${formatAngularVersionMismatchDetails(expectedMajor, mismatches)}
+
+\`ng add\` installs the latest angular-eslint by default, which does not match this workspace.
+Rerun the command with the Angular major of this workspace:
+
+  ng add angular-eslint@${major}
+
+If you added @angular-eslint/schematics directly, rerun \`ng add @angular-eslint/schematics@${major}\` instead.
+The mismatched package that \`ng add\` just installed will be replaced when you rerun it.
+
+See ${ANGULAR_VERSION_SUPPORT_DOCS_URL}
+`.trim();
+}

package/dist/ng-add/index.d.ts

@@ -1,4 +1,9 @@
 import type { Rule } from '@angular-devkit/schematics';
 import type { Schema } from './schema';
+/**
+ * Entry point for the ng-add schematic.
+ *
+ * @param options Configuration options passed to the schematic.
+ */
 export default function (options: Schema): Rule;
 //# sourceMappingURL=index.d.ts.map

package/dist/ng-add/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ng-add/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAA0B,MAAM,4BAA4B,CAAC;AAG/E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAsNvC,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,MAAM,GAAG,IAAI,CAc9C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ng-add/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAA0B,MAAM,4BAA4B,CAAC;AAO/E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AA0NvC;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,MAAM,GAAG,IAAI,CAc9C"}

package/dist/ng-add/index.js

@@ -137,29 +137,38 @@ Please see https://github.com/angular-eslint/angular-eslint for more information
     };
 }
 /**
- * Entry point for the ng-add schematic.
+ * `ng add` always resolves to the `latest` angular-eslint unless the user
+ * pins a major (the Angular CLI only consults `peerDependencies` when picking
+ * a version, and we intentionally do not declare a peer on `@angular/cli`, see
+ * docs/ANGULAR_VERSION_SUPPORT.md). So when the workspace is on a different
+ * Angular major we fail fast, before touching any files, and tell the user
+ * exactly which command to rerun.
  *
- * @param options Configuration options passed to the schematic.
+ * `ng lint` and `ng update` migrations only warn on the same mismatch.
  */
-function reportAngularVersionCompatibility(workspacePackageJson, context) {
+function assertAngularVersionCompatibility(workspacePackageJson, context) {
     const expectedMajor = (0, angular_version_compat_1.parseMajorVersion)(packageJSON.version);
     if (expectedMajor == null) {
         return;
     }
     const mismatches = (0, angular_version_compat_1.findAngularVersionMismatches)(workspacePackageJson, expectedMajor);
     if (mismatches.length > 0) {
-        context.logger.warn((0, angular_version_compat_1.formatAngularVersionMismatchMessage)(expectedMajor, mismatches));
-        return;
+        throw new schematics_1.SchematicsException((0, angular_version_compat_1.formatAngularVersionMismatchError)(expectedMajor, mismatches));
     }
     if ((0, angular_version_compat_1.hasDetectableAngularVersion)(workspacePackageJson)) {
         context.logger.info((0, angular_version_compat_1.formatAngularVersionMatchMessage)(expectedMajor));
     }
 }
+/**
+ * Entry point for the ng-add schematic.
+ *
+ * @param options Configuration options passed to the schematic.
+ */
 function default_1(options) {
     return (host, context) => {
         const workspacePackageJSON = host.read('package.json').toString('utf-8');
         const json = JSON.parse(workspacePackageJSON);
-        reportAngularVersionCompatibility(json, context);
+        assertAngularVersionCompatibility(json, context);
         return (0, schematics_1.chain)([
             addAngularESLintPackages(json, options),
             applyESLintConfigIfSingleProjectWithNoExistingTSLint(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-eslint/schematics",
-  "version": "22.3.1-alpha.7",
+  "version": "22.3.1-alpha.8",
   "description": "Angular Schematics for angular-eslint",
   "license": "MIT",
   "main": "dist/index.js",
@@ -39,8 +39,8 @@
   "dependencies": {
     "@angular-devkit/core": ">= 22.0.0 < 23.0.0",
     "@angular-devkit/schematics": ">= 22.0.0 < 23.0.0",
-    "@angular-eslint/eslint-plugin": "22.3.1-alpha.7",
-    "@angular-eslint/eslint-plugin-template": "22.3.1-alpha.7",
+    "@angular-eslint/eslint-plugin": "22.3.1-alpha.8",
+    "@angular-eslint/eslint-plugin-template": "22.3.1-alpha.8",
     "ignore": "7.0.8",
     "semver": "7.8.5",
     "strip-json-comments": "3.1.1"