refactor(@schematics/angular): use new dependency management utilities

clydin · alan-agius4 · commit 6713cd107e39 · 2025-08-12T17:44:43.000+02:00
Refactors several schematics (`application`, `library`, `service-worker`, and two migrations) to use the new, centralized dependency management utilities (`addDependency`, `removeDependency`, `getDependency`).

This change migrates away from the older, class-based `dependencies.ts` helper and consolidates all dependency logic on the more robust, functional `dependency.ts` utility. This improves consistency and leverages the enhanced features of the new utilities, such as automatic and configurable installation task management.
diff --git a/packages/schematics/angular/application/index.ts b/packages/schematics/angular/application/index.ts
@@ -25,7 +25,12 @@ import {
 } from '@angular-devkit/schematics';
 import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
 import { Schema as ComponentOptions } from '../component/schema';
-import { NodeDependencyType, addPackageJsonDependency } from '../utility/dependencies';
+import {
+  DependencyType,
+  ExistingBehavior,
+  InstallBehavior,
+  addDependency,
+} from '../utility/dependency';
 import { JSONFile } from '../utility/json-file';
 import { latestVersions } from '../utility/latest-versions';
 import { relativePathToWorkspaceRoot } from '../utility/paths';
@@ -130,48 +135,46 @@ export default function (options: ApplicationOptions): Rule {
   };
 }
 
-function addDependenciesToPackageJson(options: ApplicationOptions) {
-  return (host: Tree, context: SchematicContext) => {
-    [
-      {
-        type: NodeDependencyType.Dev,
-        name: '@angular/compiler-cli',
-        version: latestVersions.Angular,
-      },
-      {
-        type: NodeDependencyType.Dev,
-        name: '@angular/build',
-        version: latestVersions.AngularBuild,
-      },
-      {
-        type: NodeDependencyType.Dev,
-        name: 'typescript',
-        version: latestVersions['typescript'],
-      },
-    ].forEach((dependency) => addPackageJsonDependency(host, dependency));
-
-    if (!options.zoneless) {
-      addPackageJsonDependency(host, {
-        type: NodeDependencyType.Default,
-        name: 'zone.js',
-        version: latestVersions['zone.js'],
-      });
-    }
+function addDependenciesToPackageJson(options: ApplicationOptions): Rule {
+  const rules: Rule[] = [
+    addDependency('@angular/compiler-cli', latestVersions.Angular, {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+    addDependency('@angular/build', latestVersions.AngularBuild, {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+    addDependency('typescript', latestVersions['typescript'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+      install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+    }),
+  ];
 
-    if (options.style === Style.Less) {
-      addPackageJsonDependency(host, {
-        type: NodeDependencyType.Dev,
-        name: 'less',
-        version: latestVersions['less'],
-      });
-    }
+  if (!options.zoneless) {
+    rules.push(
+      addDependency('zone.js', latestVersions['zone.js'], {
+        type: DependencyType.Default,
+        existing: ExistingBehavior.Skip,
+        install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+      }),
+    );
+  }
 
-    if (!options.skipInstall) {
-      context.addTask(new NodePackageInstallTask());
-    }
+  if (options.style === Style.Less) {
+    rules.push(
+      addDependency('less', latestVersions['less'], {
+        type: DependencyType.Dev,
+        existing: ExistingBehavior.Skip,
+        install: options.skipInstall ? InstallBehavior.None : InstallBehavior.Auto,
+      }),
+    );
+  }
 
-    return host;
-  };
+  return chain(rules);
 }
 
 function addAppToWorkspaceFile(options: ApplicationOptions, appDir: string): Rule {
diff --git a/packages/schematics/angular/library/index.ts b/packages/schematics/angular/library/index.ts
@@ -23,10 +23,11 @@ import {
 import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
 import { join } from 'node:path/posix';
 import {
-  NodeDependencyType,
-  addPackageJsonDependency,
-  getPackageJsonDependency,
-} from '../utility/dependencies';
+  DependencyType,
+  ExistingBehavior,
+  addDependency,
+  getDependency,
+} from '../utility/dependency';
 import { JSONFile } from '../utility/json-file';
 import { latestVersions } from '../utility/latest-versions';
 import { relativePathToWorkspaceRoot } from '../utility/paths';
@@ -62,38 +63,29 @@ function addTsProjectReference(...paths: string[]) {
   };
 }
 
-function addDependenciesToPackageJson() {
-  return (host: Tree) => {
-    [
-      {
-        type: NodeDependencyType.Dev,
-        name: '@angular/compiler-cli',
-        version: latestVersions.Angular,
-      },
-      {
-        type: NodeDependencyType.Dev,
-        name: '@angular/build',
-        version: latestVersions.AngularBuild,
-      },
-      {
-        type: NodeDependencyType.Dev,
-        name: 'ng-packagr',
-        version: latestVersions.NgPackagr,
-      },
-      {
-        type: NodeDependencyType.Default,
-        name: 'tslib',
-        version: latestVersions['tslib'],
-      },
-      {
-        type: NodeDependencyType.Dev,
-        name: 'typescript',
-        version: latestVersions['typescript'],
-      },
-    ].forEach((dependency) => addPackageJsonDependency(host, dependency));
-
-    return host;
-  };
+function addDependenciesToPackageJson(): Rule {
+  return chain([
+    addDependency('@angular/compiler-cli', latestVersions.Angular, {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+    }),
+    addDependency('@angular/build', latestVersions.AngularBuild, {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+    }),
+    addDependency('ng-packagr', latestVersions.NgPackagr, {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+    }),
+    addDependency('tslib', latestVersions['tslib'], {
+      type: DependencyType.Default,
+      existing: ExistingBehavior.Skip,
+    }),
+    addDependency('typescript', latestVersions['typescript'], {
+      type: DependencyType.Dev,
+      existing: ExistingBehavior.Skip,
+    }),
+  ]);
 }
 
 function addLibToWorkspaceFile(
@@ -177,7 +169,7 @@ export default function (options: LibraryOptions): Rule {
       move(libDir),
     ]);
 
-    const hasZoneDependency = getPackageJsonDependency(host, 'zone.js') !== null;
+    const hasZoneDependency = getDependency(host, 'zone.js') !== null;
 
     return chain([
       mergeWith(templateSource),
diff --git a/packages/schematics/angular/migrations/replace-provide-server-rendering-import/migration.ts b/packages/schematics/angular/migrations/replace-provide-server-rendering-import/migration.ts
@@ -7,8 +7,8 @@
  */
 
 import { DirEntry, Rule } from '@angular-devkit/schematics';
-import * as ts from '../../third_party/github.com/Microsoft/TypeScript/lib/typescript';
-import { NodeDependencyType, addPackageJsonDependency } from '../../utility/dependencies';
+import ts from '../../third_party/github.com/Microsoft/TypeScript/lib/typescript';
+import { addDependency } from '../../utility/dependency';
 import { latestVersions } from '../../utility/latest-versions';
 
 function* visit(directory: DirEntry): IterableIterator<[fileName: string, contents: string]> {
@@ -39,7 +39,7 @@ function* visit(directory: DirEntry): IterableIterator<[fileName: string, conten
 
 export default function (): Rule {
   return async (tree) => {
-    let angularSSRAdded = false;
+    let rule: Rule | undefined;
 
     for (const [filePath, content] of visit(tree.root)) {
       let updatedContent = content;
@@ -100,17 +100,12 @@ export default function (): Rule {
       if (content !== updatedContent) {
         tree.overwrite(filePath, updatedContent);
 
-        if (!angularSSRAdded) {
-          addPackageJsonDependency(tree, {
-            name: '@angular/ssr',
-            version: latestVersions.AngularSSR,
-            type: NodeDependencyType.Default,
-            overwrite: false,
-          });
-
-          angularSSRAdded = true;
+        if (rule === undefined) {
+          rule = addDependency('@angular/ssr', latestVersions.AngularSSR);
         }
       }
     }
+
+    return rule;
   };
 }
diff --git a/packages/schematics/angular/migrations/use-application-builder/migration.ts b/packages/schematics/angular/migrations/use-application-builder/migration.ts
@@ -15,12 +15,11 @@ import {
   externalSchematic,
 } from '@angular-devkit/schematics';
 import { dirname, join } from 'node:path/posix';
-import { removePackageJsonDependency } from '../../utility/dependencies';
 import {
   DependencyType,
   ExistingBehavior,
-  InstallBehavior,
   addDependency,
+  removeDependency,
 } from '../../utility/dependency';
 import { JSONFile } from '../../utility/json-file';
 import { latestVersions } from '../../utility/latest-versions';
@@ -270,13 +269,10 @@ function updateProjects(tree: Tree, context: SchematicContext) {
       rules.push(
         addDependency('@angular/build', latestVersions.DevkitBuildAngular, {
           type: DependencyType.Dev,
-          // Always is set here since removePackageJsonDependency below does not automatically
-          // trigger the package manager execution.
-          install: InstallBehavior.Always,
           existing: ExistingBehavior.Replace,
         }),
+        removeDependency('@angular-devkit/build-angular'),
       );
-      removePackageJsonDependency(tree, '@angular-devkit/build-angular');
 
       // Add less dependency if any projects contain a Less stylesheet file.
       // This check does not consider Node.js packages due to the performance
diff --git a/packages/schematics/angular/service-worker/index.ts b/packages/schematics/angular/service-worker/index.ts
@@ -23,7 +23,7 @@ import * as ts from '../third_party/github.com/Microsoft/TypeScript/lib/typescri
 import { addDependency, addRootProvider, readWorkspace, writeWorkspace } from '../utility';
 import { addSymbolToNgModuleMetadata, insertImport } from '../utility/ast-utils';
 import { applyToUpdateRecorder } from '../utility/change';
-import { getPackageJsonDependency } from '../utility/dependencies';
+import { getDependency } from '../utility/dependency';
 import { getAppModulePath, isStandaloneApp } from '../utility/ng-ast-utils';
 import { relativePathToWorkspaceRoot } from '../utility/paths';
 import { targetBuildNotFoundError } from '../utility/project-targets';
@@ -34,7 +34,7 @@ import { Schema as ServiceWorkerOptions } from './schema';
 
 function addDependencies(): Rule {
   return (host: Tree) => {
-    const coreDep = getPackageJsonDependency(host, '@angular/core');
+    const coreDep = getDependency(host, '@angular/core');
     if (!coreDep) {
       throw new SchematicsException('Could not find "@angular/core" version.');
     }
