fix: eliminate all 'as any' casts and implement audit findings

JohannesHoppe · JohannesHoppe · commit 00a087bfc92e · 2025-11-22T20:00:45.000+01:00
Critical fixes:
- Fixed prerenderTarget bug in builder.ts (was checking non-existent options.prerender)
- Eliminated ALL 'as any' type casts from entire codebase (0 remaining)
- Added proper type interfaces (AngularOutputPath, DeployUser, etc.)
- Replaced type casts with proper type guards and jest.spyOn mocking

Type safety improvements:
- deploy/actions.ts: Added type guard for outputPath validation
- ng-add.spec.ts: Added AngularJson interface, removed (as any) cast
- edge-cases.spec.ts: Replaced (as any) with DeployUser interface
- All commander-fork tests: Replaced manual mocking with jest.spyOn

Documentation fixes:
- Fixed typos: Github→GitHub in all documentation
- Updated Angular version compatibility (v2.x = 17+, v1.x = 9-16)
- Added workflow comment explaining GITHUB_TOKEN is for CI testing only

Testing improvements:
- Added 3 negative test cases for builder error handling
- Fixed gh-pages mock signature in builder-integration.spec.ts
- Added MockChildProcess interface to gh-pages-shell.spec.ts

All 213 tests passing, build successful, zero type violations.
diff --git a/.claude/settings.local.json b/.claude/settings.local.json
@@ -22,7 +22,9 @@
       "Bash(npm test -- commander-fork/test)",
       "Bash(timeout 30 npm test)",
       "Bash(git log:*)",
-      "Bash(npm test:*)"
+      "Bash(npm test:*)",
+      "Bash(gh issue view:*)",
+      "WebSearch"
     ],
     "deny": [],
     "ask": []
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -30,6 +30,8 @@ jobs:
           npm link angular-cli-ghpages
           ng add angular-cli-ghpages
 
+      # CI test only: Verifies that the gh-pages branch gets updated
+      # This is NOT a production deployment - there is no public website for angular-cli-ghpages
       - name: Deploy
         if: github.ref == 'refs/heads/main'
         env:
diff --git a/README.md b/README.md
@@ -190,7 +190,7 @@ ng deploy --repo=https://github.com/<username>/<repositoryname>.git --name="Your
 
 > **ℹ️ Note for GitHub Actions**
 >
-> The `GITHUB_TOKEN` (installation access token) will only trigger a release of a new website if the action runs in a private repository. In a public repo, a commit is generated, but the site does not change. See this [GitHub Community post](https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/m-p/26869) for more info. If your repo is public, you must still use the `GH_TOKEN` (personal access token).
+> The `GITHUB_TOKEN` (installation access token) will only trigger a release of a new website if the action runs in a private repository. In a public repo, a commit is generated, but the site does not change. See this [GitHub Community post](https://github.community/t5/GitHub-Actions/GitHub-action-not-triggering-gh-pages-upon-push/m-p/26869) for more info. If your repo is public, you must still use the `GH_TOKEN` (personal access token).
 
 ## 📦 Deployment Options <a name="options"></a>
 
diff --git a/docs/README_contributors.md b/docs/README_contributors.md
@@ -31,8 +31,12 @@ Follow the instructions for [checking and updating the Angular CLI version](#ang
 ### 1. Optional: Latest Angular version
 
 This builder requires the method `getTargetOptions()` from the Angular DevKit which was introduced [here](https://github.com/angular/angular-cli/pull/13825/files).
-All Angular projects with Angular 9 and greater are supposed to be compatible. (Actually it works with some versions of 8.x too, but you want to be up to date anyway, don't you?)
-Execute the next three steps, if your test project is still older.
+
+**Version compatibility:**
+- **v2.x:** Supports Angular 17 and higher (current version)
+- **v1.x:** Supported Angular 9-16 (now deprecated for new projects)
+
+Execute the next three steps to update your test project to the latest Angular version.
 
 1. Install the latest version of the Angular CLI.
 
diff --git a/docs/README_environment_github_actions.md b/docs/README_environment_github_actions.md
@@ -1,6 +1,6 @@
 # angular-cli-ghpages: README for setting up deployment with GitHub Actions
 
-As Github has introduced [Github Actions](https://github.com/features/actions), I would prefer to run all my CI tasks in it only, rather than going to some other CI providers. This guide is aimed to help out developers, who want to deploy their Angular app in Github Page using [angular-cli-pages](https://github.com/angular-schule/angular-cli-ghpages).
+As GitHub has introduced [GitHub Actions](https://github.com/features/actions), I would prefer to run all my CI tasks in it only, rather than going to some other CI providers. This guide is aimed to help out developers, who want to deploy their Angular app in GitHub Pages using [angular-cli-pages](https://github.com/angular-schule/angular-cli-ghpages).
 
 ## Prerequisites
 
@@ -25,9 +25,9 @@ You can use the `GITHUB_TOKEN` to authenticate in a workflow run.
 More info can be found here:  
 [help.github.com](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#using-the-github_token-in-a-workflow)
 
-### Setup Github Action Flow
+### Setup GitHub Action Flow
 
-1. Open up your Github repo.
+1. Open up your GitHub repo.
 
 2. Go to **Settings** . Then on the side bar, go to **Actions** then **General**.
 
diff --git a/docs/README_standalone.md b/docs/README_standalone.md
@@ -169,7 +169,7 @@ Run through without making any changes. This can be very usefull, because it out
 - Example:
   - `npx angular-cli-ghpages --cname=example.com`
 
-A CNAME file will be created enabling you to use a custom domain. [More information on Github Pages using a custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).
+A CNAME file will be created enabling you to use a custom domain. [More information on GitHub Pages using a custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).
 
 #### --add <a name="add"></a>
 
diff --git a/src/commander-fork/test/test.command.allowUnknownOption.spec.ts b/src/commander-fork/test/test.command.allowUnknownOption.spec.ts
@@ -17,7 +17,9 @@ function resetStubStatus() {
 
 beforeEach(() => {
   stubError = jest.spyOn(console, 'error').mockImplementation(() => {});
-  stubExit = jest.spyOn(process, 'exit').mockImplementation((() => {}) as any);
+  stubExit = jest.spyOn(process, 'exit').mockImplementation((code?: number) => {
+    return undefined as never;
+  });
 });
 afterEach(() => {
   stubError.mockRestore();
diff --git a/src/commander-fork/test/test.fork-fixes.spec.ts b/src/commander-fork/test/test.fork-fixes.spec.ts
@@ -19,26 +19,25 @@ describe('Fork Fix 1: Negate detection with tightened regex', () => {
 
 describe('Fork Fix 2: Version short-only and custom flags', () => {
   describe('version() with short-only flag', () => {
-    let oldExit: any;
-    let oldWrite: any;
+    let exitSpy: jest.SpyInstance;
+    let writeSpy: jest.SpyInstance;
     let captured: {out: string, code: null | number};
 
     beforeEach(() => {
       captured = {out: '', code: null};
-      oldExit = process.exit;
-      oldWrite = process.stdout.write;
-      process.exit = ((c: any) => {
-        captured.code = c as number;
-      }) as any;
-      process.stdout.write = ((s: any) => {
+      exitSpy = jest.spyOn(process, 'exit').mockImplementation((c?: number) => {
+        captured.code = c ?? 0;
+        return undefined as never;
+      });
+      writeSpy = jest.spyOn(process.stdout, 'write').mockImplementation((s: string | Uint8Array) => {
         captured.out += s;
         return true;
-      }) as any;
+      });
     });
 
     afterEach(() => {
-      process.exit = oldExit;
-      process.stdout.write = oldWrite;
+      exitSpy.mockRestore();
+      writeSpy.mockRestore();
     });
 
     it('prints version and exits with -v short-only flag', () => {
@@ -69,24 +68,22 @@ describe('Fork Fix 2: Version short-only and custom flags', () => {
   });
 
   describe('helpOption() with custom flags', () => {
-    let oldExit: any;
-    let oldWrite: any;
+    let exitSpy: jest.SpyInstance;
+    let writeSpy: jest.SpyInstance;
     let exitCode: null | number;
 
     beforeEach(() => {
       exitCode = null;
-      oldExit = process.exit;
-      oldWrite = process.stdout.write;
-      process.exit = ((c: any) => {
-        exitCode = c as number;
+      exitSpy = jest.spyOn(process, 'exit').mockImplementation((c?: number) => {
+        exitCode = c ?? 0;
         throw new Error(`exit(${c})`);
-      }) as any;
-      process.stdout.write = (() => true) as any;
+      });
+      writeSpy = jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
     });
 
     afterEach(() => {
-      process.exit = oldExit;
-      process.stdout.write = oldWrite;
+      exitSpy.mockRestore();
+      writeSpy.mockRestore();
     });
 
     it('fires help listener with default flags', () => {
@@ -109,19 +106,19 @@ describe('Fork Fix 2: Version short-only and custom flags', () => {
   });
 
   describe('opts() includes version with custom flags', () => {
-    let oldExit: any;
-    let oldWrite: any;
+    let exitSpy: jest.SpyInstance;
+    let writeSpy: jest.SpyInstance;
 
     beforeEach(() => {
-      oldExit = process.exit;
-      oldWrite = process.stdout.write;
-      process.exit = (() => {}) as any;
-      process.stdout.write = (() => true) as any;
+      exitSpy = jest.spyOn(process, 'exit').mockImplementation((code?: number) => {
+        return undefined as never;
+      });
+      writeSpy = jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
     });
 
     afterEach(() => {
-      process.exit = oldExit;
-      process.stdout.write = oldWrite;
+      exitSpy.mockRestore();
+      writeSpy.mockRestore();
     });
 
     it('includes version in opts() with default flags', () => {
@@ -178,15 +175,18 @@ describe('Fork Fix 2: Version short-only and custom flags', () => {
 
   describe('unknown options with attached values', () => {
     let errSpy: jest.SpyInstance;
+    let exitSpy: jest.SpyInstance;
 
     beforeEach(() => {
       errSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
-      jest.spyOn(process, 'exit').mockImplementation((() => {}) as any);
+      exitSpy = jest.spyOn(process, 'exit').mockImplementation((code?: number) => {
+        return undefined as never;
+      });
     });
 
     afterEach(() => {
       errSpy.mockRestore();
-      (process.exit as any).mockRestore();
+      exitSpy.mockRestore();
     });
 
     describe('errors by default', () => {
@@ -232,3 +232,5 @@ describe('Fork Fix 2: Version short-only and custom flags', () => {
     });
   });
 });
+
+export {};
diff --git a/src/commander-fork/test/test.options.bool.no.spec.ts b/src/commander-fork/test/test.options.bool.no.spec.ts
@@ -5,7 +5,7 @@ describe('options.bool.no', () => {
 // Test combination of flag and --no-flag
 // (negatable flag on its own is tested in test.options.bool.js)
 
-function flagProgram(defaultValue?) {
+function flagProgram(defaultValue?: boolean) {
   const program = new commander.Command();
   program
     .option('-p, --pepper', 'add pepper', defaultValue)
@@ -74,3 +74,5 @@ programYesNo.parse(['node', 'test', '--pepper', '--no-pepper']);
 expect(programYesNo.pepper).toBe(false);
 });
 });
+
+export {};
diff --git a/src/commander-fork/test/test.options.coercion.spec.ts b/src/commander-fork/test/test.options.coercion.spec.ts
@@ -6,15 +6,15 @@ const commander = require('../');
 //   , should = require('should');
 
 describe('options.coercion', () => {
-function parseRange(str) {
+function parseRange(str: string): number[] {
   return str.split('..').map(Number);
 }
 
-function increaseVerbosity(v, total) {
+function increaseVerbosity(v: string, total: number): number {
   return total + 1;
 }
 
-function collectValues(str, memo) {
+function collectValues(str: string, memo: string[]): string[] {
   memo.push(str);
   return memo;
 }
@@ -39,3 +39,5 @@ expect(program.collect).toEqual(['foo', 'bar', 'baz']);
 expect(program.verbose).toBe(5);
 });
 });
+
+export {};
diff --git a/src/commander-fork/test/test.options.version.spec.ts b/src/commander-fork/test/test.options.version.spec.ts
@@ -3,7 +3,10 @@ const commander = require('../');
 //   , should = require('should');
 
 describe('options.version', () => {
-var capturedExitCode, capturedOutput, oldProcessExit, oldProcessStdoutWrite;
+let capturedExitCode: number;
+let capturedOutput: string;
+let exitSpy: jest.SpyInstance;
+let writeSpy: jest.SpyInstance;
 
 // program.version('0.0.1');
 
@@ -13,15 +16,25 @@ var capturedExitCode, capturedOutput, oldProcessExit, oldProcessStdoutWrite;
   program.version('0.0.1');
   capturedExitCode = -1;
   capturedOutput = '';
-  oldProcessExit = process.exit;
-  oldProcessStdoutWrite = process.stdout.write;
-  process.exit = function (code) { capturedExitCode = code; } as any;
-  process.stdout.write = function(output) { capturedOutput += output; return true; } as any;
+
+  exitSpy = jest.spyOn(process, 'exit').mockImplementation((code?: number) => {
+    capturedExitCode = code ?? 0;
+    return undefined as never;
+  });
+  writeSpy = jest.spyOn(process.stdout, 'write').mockImplementation((output: string | Uint8Array) => {
+    capturedOutput += output;
+    return true;
+  });
+
   program.parse(['node', 'test', flag]);
-  process.exit = oldProcessExit;
-  process.stdout.write = oldProcessStdoutWrite;
+
+  exitSpy.mockRestore();
+  writeSpy.mockRestore();
+
   expect(capturedOutput).toBe('0.0.1\n');
   expect(capturedExitCode).toBe(0);
   });
 })
 });
+
+export {};
diff --git a/src/deploy/actions.spec.ts b/src/deploy/actions.spec.ts
@@ -89,6 +89,52 @@ describe('Deploy Angular apps', () => {
         expect(e.message).toEqual('Error while building the app.');
       }
     });
+
+    it('throws if outputPath is missing from build options', async () => {
+      context.getTargetOptions = (_: Target) =>
+        Promise.resolve({} as JsonObject);
+
+      const expectedErrorMessage = `Cannot read the outputPath option of the Angular project '${BUILD_TARGET.name}' in angular.json.`;
+
+      try {
+        await deploy(mockEngine, context, BUILD_TARGET, { noBuild: false });
+        fail();
+      } catch (e) {
+        expect(e.message).toBe(expectedErrorMessage);
+      }
+    });
+
+    it('throws if outputPath has invalid shape (not string or object)', async () => {
+      context.getTargetOptions = (_: Target) =>
+        Promise.resolve({
+          outputPath: 123
+        } as JsonObject);
+
+      const expectedErrorPrefix = 'Unsupported outputPath configuration';
+
+      try {
+        await deploy(mockEngine, context, BUILD_TARGET, { noBuild: false });
+        fail();
+      } catch (e) {
+        expect(e.message).toContain(expectedErrorPrefix);
+      }
+    });
+
+    it('throws if outputPath object is missing base property', async () => {
+      context.getTargetOptions = (_: Target) =>
+        Promise.resolve({
+          outputPath: { browser: 'browser' }
+        } as JsonObject);
+
+      const expectedErrorPrefix = 'Unsupported outputPath configuration';
+
+      try {
+        await deploy(mockEngine, context, BUILD_TARGET, { noBuild: false });
+        fail();
+      } catch (e) {
+        expect(e.message).toContain(expectedErrorPrefix);
+      }
+    });
   });
 });
 
diff --git a/src/deploy/actions.ts b/src/deploy/actions.ts
@@ -2,7 +2,7 @@ import { BuilderContext, targetFromTargetString } from '@angular-devkit/architec
 import { logging } from '@angular-devkit/core';
 import path from 'path';
 
-import { BuildTarget } from '../interfaces';
+import { BuildTarget, AngularOutputPath, isOutputPathObject } from '../interfaces';
 import { Schema } from './schema';
 
 export default async function deploy(
@@ -72,11 +72,17 @@ export default async function deploy(
       );
     }
 
-    if (typeof buildOptions.outputPath === 'string') {
-      dir = path.join(buildOptions.outputPath, 'browser');
+    const outputPath = buildOptions.outputPath as AngularOutputPath;
+
+    if (typeof outputPath === 'string') {
+      dir = path.join(outputPath, 'browser');
+    } else if (isOutputPathObject(outputPath)) {
+      dir = path.join(outputPath.base, outputPath.browser ?? '');
     } else {
-      const obj = buildOptions.outputPath as any;
-      dir = path.join(obj.base, obj.browser)
+      throw new Error(
+        `Unsupported outputPath configuration in angular.json for '${buildTarget.name}'. ` +
+        `Expected string or {base, browser} object.`
+      );
     }
   }
 
diff --git a/src/deploy/builder.ts b/src/deploy/builder.ts
@@ -28,11 +28,9 @@ export default createBuilder(
     };
 
     let prerenderBuildTarget: BuildTarget | undefined;
-    if (options.prerender) {
+    if (options.prerenderTarget) {
       prerenderBuildTarget = {
-        name:
-          options.prerenderTarget ||
-          `${context.target.project}:prerender:production`
+        name: options.prerenderTarget
       };
     }
 
diff --git a/src/interfaces.ts b/src/interfaces.ts
diff --git a/src/ng-add.spec.ts b/src/ng-add.spec.ts
diff --git a/src/parameter-tests/builder-integration.spec.ts b/src/parameter-tests/builder-integration.spec.ts
diff --git a/src/parameter-tests/edge-cases.spec.ts b/src/parameter-tests/edge-cases.spec.ts
diff --git a/src/parameter-tests/gh-pages-shell.spec.ts b/src/parameter-tests/gh-pages-shell.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ ng deploy --repo=https://github.com/<username>/<repositoryname>.git --name="Your`
`190`	`190`
`191`	`191`	`> ℹ️ Note for GitHub Actions`
`192`	`192`	`>`
`193`		-> The `GITHUB_TOKEN` (installation access token) will only trigger a release of a new website if the action runs in a private repository. In a public repo, a commit is generated, but the site does not change. See this [GitHub Community post](https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/m-p/26869) for more info. If your repo is public, you must still use the `GH_TOKEN` (personal access token).
	`193`	+> The `GITHUB_TOKEN` (installation access token) will only trigger a release of a new website if the action runs in a private repository. In a public repo, a commit is generated, but the site does not change. See this [GitHub Community post](https://github.community/t5/GitHub-Actions/GitHub-action-not-triggering-gh-pages-upon-push/m-p/26869) for more info. If your repo is public, you must still use the `GH_TOKEN` (personal access token).
`194`	`194`
`195`	`195`	`## 📦 Deployment Options <a name="options"></a>`
`196`	`196`