refactor: replace string literals with TestRunner enum for test runner options.

alan-agius4 · alan-agius4 · commit 21ef18156427 · 2025-11-20T15:24:04.000Z
Replace string with enum
diff --git a/packages/angular/build/src/builders/unit-test/options.ts b/packages/angular/build/src/builders/unit-test/options.ts
@@ -12,7 +12,7 @@ import path from 'node:path';
 import { normalizeCacheOptions } from '../../utils/normalize-cache';
 import { getProjectRootPaths } from '../../utils/project-metadata';
 import { isTTY } from '../../utils/tty';
-import type { Schema as UnitTestBuilderOptions } from './schema';
+import { Runner, type Schema as UnitTestBuilderOptions } from './schema';
 
 export type NormalizedUnitTestBuilderOptions = Awaited<ReturnType<typeof normalizeOptions>>;
 
@@ -56,7 +56,7 @@ export async function normalizeOptions(
 
   const { runner, browsers, progress, filter, browserViewport, ui, runnerConfig } = options;
 
-  if (ui && runner !== 'vitest') {
+  if (ui && runner !== Runner.Vitest) {
     throw new Error('The "ui" option is only available for the "vitest" runner.');
   }
 
@@ -95,7 +95,7 @@ export async function normalizeOptions(
     include: options.include ?? ['**/*.spec.ts'],
     exclude: options.exclude,
     filter,
-    runnerName: runner ?? 'vitest',
+    runnerName: runner ?? Runner.Vitest,
     coverage: {
       enabled: options.coverage,
       exclude: options.coverageExclude,
diff --git a/packages/angular/build/src/builders/unit-test/tests/setup.ts b/packages/angular/build/src/builders/unit-test/tests/setup.ts
@@ -14,7 +14,7 @@ import {
   ApplicationBuilderOptions as ApplicationSchema,
   buildApplication,
 } from '../../../builders/application';
-import { Schema } from '../schema';
+import { Runner, Schema } from '../schema';
 
 // TODO: Consider using package.json imports field instead of relative path
 //       after the switch to rules_js.
@@ -61,7 +61,7 @@ export const UNIT_TEST_BUILDER_INFO = Object.freeze({
 export const BASE_OPTIONS = Object.freeze<Schema>({
   buildTarget: 'test:build',
   tsConfig: 'src/tsconfig.spec.json',
-  runner: 'vitest' as any,
+  runner: Runner.Vitest,
 });
 
 /**
diff --git a/packages/schematics/angular/application/index.ts b/packages/schematics/angular/application/index.ts
@@ -35,7 +35,7 @@ import { latestVersions } from '../utility/latest-versions';
 import { relativePathToWorkspaceRoot } from '../utility/paths';
 import { getWorkspace, updateWorkspace } from '../utility/workspace';
 import { Builders, ProjectType } from '../utility/workspace-models';
-import { Schema as ApplicationOptions, Style } from './schema';
+import { Schema as ApplicationOptions, Style, TestRunner } from './schema';
 
 const APPLICATION_DEV_DEPENDENCIES = [
   { name: '@angular/compiler-cli', version: latestVersions.Angular },
@@ -189,7 +189,7 @@ function addDependenciesToPackageJson(options: ApplicationOptions): Rule {
 
   if (!options.skipTests) {
     rules.push(
-      ...getTestRunnerDependencies(options.testRunner === 'vitest', !!options.skipInstall),
+      ...getTestRunnerDependencies(options.testRunner === TestRunner.Vitest, !!options.skipInstall),
     );
   }
 
@@ -343,7 +343,7 @@ function addAppToWorkspaceFile(options: ApplicationOptions, appDir: string): Rul
           : {
               builder: Builders.BuildUnitTest,
               options:
-                options.testRunner === 'vitest'
+                options.testRunner === TestRunner.Vitest
                   ? {}
                   : {
                       runner: 'karma',
diff --git a/packages/schematics/angular/application/index_spec.ts b/packages/schematics/angular/application/index_spec.ts
@@ -10,7 +10,7 @@ import { SchematicTestRunner, UnitTestTree } from '@angular-devkit/schematics/te
 import { parse as parseJson } from 'jsonc-parser';
 import { latestVersions } from '../utility/latest-versions';
 import { Schema as WorkspaceOptions } from '../workspace/schema';
-import { Schema as ApplicationOptions, Style, ViewEncapsulation } from './schema';
+import { Schema as ApplicationOptions, Style, TestRunner, ViewEncapsulation } from './schema';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function readJsonFile(tree: UnitTestTree, path: string): any {
@@ -442,7 +442,7 @@ describe('Application Schematic', () => {
     });
 
     it('should set values in angular.json correctly when testRunner is karma', async () => {
-      const options = { ...defaultOptions, projectRoot: '', testRunner: 'karma' as const };
+      const options = { ...defaultOptions, projectRoot: '', testRunner: TestRunner.Karma };
       const tree = await schematicRunner.runSchematic('application', options, workspaceTree);
 
       const config = JSON.parse(tree.readContent('/angular.json'));
diff --git a/packages/schematics/angular/library/index.ts b/packages/schematics/angular/library/index.ts
@@ -33,7 +33,7 @@ import { latestVersions } from '../utility/latest-versions';
 import { relativePathToWorkspaceRoot } from '../utility/paths';
 import { getWorkspace, updateWorkspace } from '../utility/workspace';
 import { Builders, ProjectType } from '../utility/workspace-models';
-import { Schema as LibraryOptions } from './schema';
+import { Schema as LibraryOptions, TestRunner } from './schema';
 
 const LIBRARY_DEV_DEPENDENCIES = [
   { name: '@angular/compiler-cli', version: latestVersions.Angular },
@@ -79,7 +79,7 @@ function addDependenciesToPackageJson({ skipInstall, testRunner }: LibraryOption
         install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
       }),
     ),
-    ...getTestRunnerDependencies(testRunner === 'vitest', !!skipInstall),
+    ...getTestRunnerDependencies(testRunner === TestRunner.Vitest, !!skipInstall),
     addDependency('tslib', latestVersions['tslib'], {
       type: DependencyType.Default,
       existing: ExistingBehavior.Skip,
@@ -115,7 +115,7 @@ function addLibToWorkspaceFile(
           },
         },
         test:
-          options.testRunner === 'vitest'
+          options.testRunner === TestRunner.Vitest
             ? {
                 builder: Builders.BuildUnitTest,
                 options: {
@@ -173,7 +173,7 @@ export default function (options: LibraryOptions): Rule {
         angularLatestVersion: latestVersions.Angular.replace(/~|\^/, ''),
         tsLibLatestVersion: latestVersions['tslib'].replace(/~|\^/, ''),
         folderName,
-        testTypesPackage: options.testRunner === 'vitest' ? 'vitest/globals' : 'jasmine',
+        testTypesPackage: options.testRunner === TestRunner.Vitest ? 'vitest/globals' : 'jasmine',
       }),
       move(libDir),
     ]);
diff --git a/packages/schematics/angular/ng-new/index_spec.ts b/packages/schematics/angular/ng-new/index_spec.ts
@@ -7,7 +7,7 @@
  */
 
 import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
-import { Schema as NgNewOptions } from './schema';
+import { Schema as NgNewOptions, TestRunner } from './schema';
 
 describe('Ng New Schematic', () => {
   const schematicRunner = new SchematicTestRunner(
@@ -159,7 +159,7 @@ describe('Ng New Schematic', () => {
   });
 
   it(`should set 'testRunner' to 'karma'`, async () => {
-    const options = { ...defaultOptions, testRunner: 'karma' as const };
+    const options = { ...defaultOptions, testRunner: TestRunner.Karma };
     const tree = await schematicRunner.runSchematic('ng-new', options);
 
     const {
@@ -178,7 +178,7 @@ describe('Ng New Schematic', () => {
   });
 
   it(`should set 'testRunner' to 'karma' in workspace schematic options`, async () => {
-    const options = { ...defaultOptions, testRunner: 'karma' as const };
+    const options = { ...defaultOptions, testRunner: TestRunner.Karma };
     const tree = await schematicRunner.runSchematic('ng-new', options);
 
     const { schematics } = JSON.parse(tree.readContent('/bar/angular.json'));
