fix(@schematics/angular): support testRunner option in library schematic

alan-agius4 · alan-agius4 · commit a525c939a5f9 · 2025-11-20T18:52:28.000+01:00
This commit introduces the `testRunner` option to the library schematic, allowing users to explicitly select between `vitest` and `karma` as their test runner. Additionally, the `ng-new` schematic has been updated to configure the default `testRunner` for libraries in `angular.json` based on the workspace creation options. Closes #31887
diff --git a/packages/schematics/angular/application/index.ts b/packages/schematics/angular/application/index.ts
@@ -23,6 +23,7 @@ import {
   url,
 } from '@angular-devkit/schematics';
 import { Schema as ComponentOptions, Style as ComponentStyle } from '../component/schema';
+import { getTestRunnerDependencies } from '../utility/dependencies';
 import {
   DependencyType,
   ExistingBehavior,
@@ -187,62 +188,7 @@ function addDependenciesToPackageJson(options: ApplicationOptions): Rule {
   }
 
   if (!options.skipTests) {
-    if (options.testRunner === 'vitest') {
-      rules.push(
-        addDependency('vitest', latestVersions['vitest'], {
-          type: DependencyType.Dev,
-          existing: ExistingBehavior.Skip,
-          install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-        }),
-        addDependency('jsdom', latestVersions['jsdom'], {
-          type: DependencyType.Dev,
-          existing: ExistingBehavior.Skip,
-          install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-        }),
-      );
-    } else {
-      rules.push(
-        addDependency('karma', latestVersions['karma'], {
-          type: DependencyType.Dev,
-          existing: ExistingBehavior.Skip,
-          install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-        }),
-        addDependency('karma-chrome-launcher', latestVersions['karma-chrome-launcher'], {
-          type: DependencyType.Dev,
-          existing: ExistingBehavior.Skip,
-          install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-        }),
-        addDependency('karma-coverage', latestVersions['karma-coverage'], {
-          type: DependencyType.Dev,
-          existing: ExistingBehavior.Skip,
-          install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-        }),
-        addDependency('karma-jasmine', latestVersions['karma-jasmine'], {
-          type: DependencyType.Dev,
-          existing: ExistingBehavior.Skip,
-          install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-        }),
-        addDependency(
-          'karma-jasmine-html-reporter',
-          latestVersions['karma-jasmine-html-reporter'],
-          {
-            type: DependencyType.Dev,
-            existing: ExistingBehavior.Skip,
-            install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-          },
-        ),
-        addDependency('jasmine-core', latestVersions['jasmine-core'], {
-          type: DependencyType.Dev,
-          existing: ExistingBehavior.Skip,
-          install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-        }),
-        addDependency('@types/jasmine', latestVersions['@types/jasmine'], {
-          type: DependencyType.Dev,
-          existing: ExistingBehavior.Skip,
-          install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
-        }),
-      );
-    }
+    rules.push(...getTestRunnerDependencies(options.testRunner, !!options.skipInstall));
   }
 
   return chain(rules);
@@ -392,17 +338,15 @@ function addAppToWorkspaceFile(options: ApplicationOptions, appDir: string): Rul
       test:
         options.skipTests || options.minimal
           ? undefined
-          : options.testRunner === 'vitest'
-            ? {
-                builder: Builders.BuildUnitTest,
-                options: {},
-              }
-            : {
-                builder: Builders.BuildUnitTest,
-                options: {
-                  runner: 'karma',
-                },
-              },
+          : {
+              builder: Builders.BuildUnitTest,
+              options:
+                options.testRunner === 'vitest'
+                  ? {}
+                  : {
+                      runner: 'karma',
+                    },
+            },
     },
   };
 
diff --git a/packages/schematics/angular/library/index.ts b/packages/schematics/angular/library/index.ts
@@ -20,6 +20,7 @@ import {
   url,
 } from '@angular-devkit/schematics';
 import { join } from 'node:path/posix';
+import { getTestRunnerDependencies } from '../utility/dependencies';
 import {
   DependencyType,
   ExistingBehavior,
@@ -69,7 +70,7 @@ function addTsProjectReference(...paths: string[]) {
   };
 }
 
-function addDependenciesToPackageJson(skipInstall: boolean): Rule {
+function addDependenciesToPackageJson({ skipInstall, testRunner }: LibraryOptions): Rule {
   return chain([
     ...LIBRARY_DEV_DEPENDENCIES.map((dependency) =>
       addDependency(dependency.name, dependency.version, {
@@ -78,6 +79,7 @@ function addDependenciesToPackageJson(skipInstall: boolean): Rule {
         install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
       }),
     ),
+    ...getTestRunnerDependencies(testRunner, !!skipInstall),
     addDependency('tslib', latestVersions['tslib'], {
       type: DependencyType.Default,
       existing: ExistingBehavior.Skip,
@@ -91,7 +93,6 @@ function addLibToWorkspaceFile(
   projectRoot: string,
   projectName: string,
   hasZoneDependency: boolean,
-  hasVitest: boolean,
 ): Rule {
   return updateWorkspace((workspace) => {
     workspace.projects.add({
@@ -113,20 +114,21 @@ function addLibToWorkspaceFile(
             },
           },
         },
-        test: hasVitest
-          ? {
-              builder: Builders.BuildUnitTest,
-              options: {
-                tsConfig: `${projectRoot}/tsconfig.spec.json`,
+        test:
+          options.testRunner === 'vitest'
+            ? {
+                builder: Builders.BuildUnitTest,
+                options: {
+                  tsConfig: `${projectRoot}/tsconfig.spec.json`,
+                },
+              }
+            : {
+                builder: Builders.BuildKarma,
+                options: {
+                  tsConfig: `${projectRoot}/tsconfig.spec.json`,
+                  polyfills: hasZoneDependency ? ['zone.js', 'zone.js/testing'] : undefined,
+                },
               },
-            }
-          : {
-              builder: Builders.BuildKarma,
-              options: {
-                tsConfig: `${projectRoot}/tsconfig.spec.json`,
-                polyfills: hasZoneDependency ? ['zone.js', 'zone.js/testing'] : undefined,
-              },
-            },
       },
     });
   });
@@ -158,7 +160,6 @@ export default function (options: LibraryOptions): Rule {
 
     const distRoot = `dist/${folderName}`;
     const sourceDir = `${libDir}/src/lib`;
-    const hasVitest = getDependency(host, 'vitest') !== null;
 
     const templateSource = apply(url('./files'), [
       applyTemplates({
@@ -172,7 +173,7 @@ export default function (options: LibraryOptions): Rule {
         angularLatestVersion: latestVersions.Angular.replace(/~|\^/, ''),
         tsLibLatestVersion: latestVersions['tslib'].replace(/~|\^/, ''),
         folderName,
-        testTypesPackage: hasVitest ? 'vitest/globals' : 'jasmine',
+        testTypesPackage: options.testRunner === 'vitest' ? 'vitest/globals' : 'jasmine',
       }),
       move(libDir),
     ]);
@@ -181,8 +182,8 @@ export default function (options: LibraryOptions): Rule {
 
     return chain([
       mergeWith(templateSource),
-      addLibToWorkspaceFile(options, libDir, packageName, hasZoneDependency, hasVitest),
-      options.skipPackageJson ? noop() : addDependenciesToPackageJson(!!options.skipInstall),
+      addLibToWorkspaceFile(options, libDir, packageName, hasZoneDependency),
+      options.skipPackageJson ? noop() : addDependenciesToPackageJson(options),
       options.skipTsConfig ? noop() : updateTsConfig(packageName, './' + distRoot),
       options.skipTsConfig
         ? noop()
diff --git a/packages/schematics/angular/library/index_spec.ts b/packages/schematics/angular/library/index_spec.ts
@@ -407,11 +407,11 @@ describe('Library Schematic', () => {
     expect(workspace.projects.foo.architect.build.builder).toBe('@angular/build:ng-packagr');
   });
 
-  it(`should add 'karma' test builder`, async () => {
+  it(`should add 'unit-test' test builder`, async () => {
     const tree = await schematicRunner.runSchematic('library', defaultOptions, workspaceTree);
 
     const workspace = JSON.parse(tree.readContent('/angular.json'));
-    expect(workspace.projects.foo.architect.test.builder).toBe('@angular/build:karma');
+    expect(workspace.projects.foo.architect.test.builder).toBe('@angular/build:unit-test');
   });
 
   it(`should add 'unit-test' test builder`, async () => {
diff --git a/packages/schematics/angular/library/schema.json b/packages/schematics/angular/library/schema.json
@@ -53,6 +53,12 @@
       "type": "boolean",
       "default": true,
       "x-user-analytics": "ep.ng_standalone"
+    },
+    "testRunner": {
+      "description": "The unit testing runner to use.",
+      "type": "string",
+      "enum": ["vitest", "karma"],
+      "default": "vitest"
     }
   },
   "required": ["name"]
diff --git a/packages/schematics/angular/ng-new/index.ts b/packages/schematics/angular/ng-new/index.ts
@@ -67,16 +67,21 @@ export default function (options: NgNewOptions): Rule {
     mergeWith(
       apply(empty(), [
         schematic('workspace', workspaceOptions),
-        options.createApplication ? schematic('application', applicationOptions) : noop,
-        schematic('ai-config', {
-          tool: options.aiConfig?.length ? options.aiConfig : undefined,
-        }),
         (tree: Tree) => {
           if (options.testRunner === 'karma') {
             const file = new JSONFile(tree, 'angular.json');
-            file.modify(['schematics', '@schematics/angular:application', 'testRunner'], 'karma');
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const schematics = file.get(['schematics']) ?? ({} as any);
+            (schematics['@schematics/angular:application'] ??= {}).testRunner = 'karma';
+            (schematics['@schematics/angular:library'] ??= {}).testRunner = 'karma';
+
+            file.modify(['schematics'], schematics);
           }
         },
+        options.createApplication ? schematic('application', applicationOptions) : noop,
+        schematic('ai-config', {
+          tool: options.aiConfig?.length ? options.aiConfig : undefined,
+        }),
         move(options.directory),
       ]),
     ),
diff --git a/packages/schematics/angular/ng-new/index_spec.ts b/packages/schematics/angular/ng-new/index_spec.ts
@@ -183,6 +183,7 @@ describe('Ng New Schematic', () => {
 
     const { schematics } = JSON.parse(tree.readContent('/bar/angular.json'));
     expect(schematics['@schematics/angular:application'].testRunner).toBe('karma');
+    expect(schematics['@schematics/angular:library'].testRunner).toBe('karma');
   });
 
   it(`should not add type to class name when file name style guide is '2016'`, async () => {
diff --git a/packages/schematics/angular/utility/dependencies.ts b/packages/schematics/angular/utility/dependencies.ts
@@ -6,8 +6,11 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import { Tree } from '@angular-devkit/schematics';
+import { Rule, Tree } from '@angular-devkit/schematics';
+import { TestRunner } from '../ng-new/schema';
+import { DependencyType, ExistingBehavior, InstallBehavior, addDependency } from './dependency';
 import { JSONFile } from './json-file';
+import { latestVersions } from './latest-versions';
 
 const PKG_JSON_PATH = '/package.json';
 export enum NodeDependencyType {
@@ -78,3 +81,61 @@ export function getPackageJsonDependency(
 
   return null;
 }
+
+export function getTestRunnerDependencies(
+  testRunner: TestRunner | undefined,
+  skipInstall: boolean,
+): Rule[] {
+  if (testRunner === TestRunner.Vitest) {
+    return [
+      addDependency('vitest', latestVersions['vitest'], {
+        type: DependencyType.Dev,
+        existing: ExistingBehavior.Skip,
+        install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+      }),
+      addDependency('jsdom', latestVersions['jsdom'], {
+        type: DependencyType.Dev,
+        existing: ExistingBehavior.Skip,
+        install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+      }),
+    ];
+  }
+
+  return [
+    addDependency('karma', latestVersions['karma'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+    addDependency('karma-chrome-launcher', latestVersions['karma-chrome-launcher'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+    addDependency('karma-coverage', latestVersions['karma-coverage'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+    addDependency('karma-jasmine', latestVersions['karma-jasmine'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+    addDependency('karma-jasmine-html-reporter', latestVersions['karma-jasmine-html-reporter'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+    addDependency('jasmine-core', latestVersions['jasmine-core'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+    addDependency('@types/jasmine', latestVersions['@types/jasmine'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+  ];
+}
