refactor(cdk/schematics): use @schematics/angular/utility for workspace helpers

The `@schematics/angular` package's `utility` entry point provides access
to several Angular workspace helper functions and types. Usage of this
avoids deep importing into this package for the equivalent functionality
as well as removing the need in several cases of importing from `@angular-devkit/core`.

Author: clydin

src/cdk/schematics/ng-update/devkit-migration-rule.ts

@@ -6,9 +6,9 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {workspaces} from '@angular-devkit/core';
 import {Rule, SchematicContext, Tree} from '@angular-devkit/schematics';
 import {NodePackageInstallTask} from '@angular-devkit/schematics/tasks';
+import {ProjectDefinition} from '@schematics/angular/utility';
 
 import {UpdateProject} from '../update-tool';
 import {WorkspacePath} from '../update-tool/file-system';
@@ -141,7 +141,7 @@ export function createMigrationSchematicRule(
 
     /** Runs the migrations for the specified workspace project. */
     function runMigrations(
-      project: workspaces.ProjectDefinition,
+      project: ProjectDefinition,
       projectName: string,
       tsconfigPath: WorkspacePath,
       additionalStylesheetPaths: string[],

src/cdk/schematics/ng-update/devkit-migration.ts

@@ -7,7 +7,7 @@
  */
 
 import {SchematicContext, Tree} from '@angular-devkit/schematics';
-import {workspaces} from '@angular-devkit/core';
+import {ProjectDefinition} from '@schematics/angular/utility';
 import {Constructor, Migration, PostMigrationAction} from '../update-tool/migration';
 import {TargetVersion} from '../update-tool/target-version';
 
@@ -17,7 +17,7 @@ export type DevkitContext = {
   /** Name of the project the migrations run against. */
   projectName: string;
   /** Workspace project the migrations run against. */
-  project: workspaces.ProjectDefinition;
+  project: ProjectDefinition;
   /** Whether the migrations run for a test target. */
   isTestTarget: boolean;
 };

src/cdk/schematics/utils/ast.ts

@@ -9,11 +9,10 @@
 import {SchematicsException, Tree} from '@angular-devkit/schematics';
 import {Schema as ComponentOptions} from '@schematics/angular/component/schema';
 import {InsertChange} from '@schematics/angular/utility/change';
-import {getWorkspace} from '@schematics/angular/utility/workspace';
+import {ProjectDefinition, readWorkspace} from '@schematics/angular/utility';
 import {findModuleFromOptions as internalFindModule} from '@schematics/angular/utility/find-module';
 import {addImportToModule} from '@schematics/angular/utility/ast-utils';
 import {getAppModulePath} from '@schematics/angular/utility/ng-ast-utils';
-import {workspaces} from '@angular-devkit/core';
 import * as ts from 'typescript';
 import {getProjectMainFile} from './project-main-file';
 
@@ -31,7 +30,7 @@ export function addModuleImportToRootModule(
   host: Tree,
   moduleName: string,
   src: string,
-  project: workspaces.ProjectDefinition,
+  project: ProjectDefinition,
 ) {
   const modulePath = getAppModulePath(host, getProjectMainFile(project));
   addModuleImportToModule(host, modulePath, moduleName, src);
@@ -73,7 +72,7 @@ export async function findModuleFromOptions(
   host: Tree,
   options: ComponentOptions,
 ): Promise<string | undefined> {
-  const workspace = await getWorkspace(host);
+  const workspace = await readWorkspace(host);
 
   if (!options.project) {
     options.project = Array.from(workspace.projects.keys())[0];

src/cdk/schematics/utils/build-component.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {strings, template as interpolateTemplate, workspaces} from '@angular-devkit/core';
+import {template as interpolateTemplate} from '@angular-devkit/core';
 import {
   apply,
   applyTemplates,
@@ -18,13 +18,14 @@ import {
   noop,
   Rule,
   SchematicsException,
+  strings,
   Tree,
   url,
 } from '@angular-devkit/schematics';
 import {FileSystemSchematicContext} from '@angular-devkit/schematics/tools';
 import {Schema as ComponentOptions, Style} from '@schematics/angular/component/schema';
 import {InsertChange} from '@schematics/angular/utility/change';
-import {getWorkspace} from '@schematics/angular/utility/workspace';
+import {ProjectDefinition, readWorkspace} from '@schematics/angular/utility';
 import {buildRelativePath, findModuleFromOptions} from '@schematics/angular/utility/find-module';
 import {parseName} from '@schematics/angular/utility/parse-name';
 import {validateHtmlSelector} from '@schematics/angular/utility/validation';
@@ -40,7 +41,7 @@ import {getDefaultComponentOptions, isStandaloneSchematic} from './schematic-opt
  * Build a default project path for generating.
  * @param project The project to build the path for.
  */
-function buildDefaultPath(project: workspaces.ProjectDefinition): string {
+function buildDefaultPath(project: ProjectDefinition): string {
   const root = project.sourceRoot ? `/${project.sourceRoot}/` : `/${project.root}/src/`;
 
   const projectDirName =
@@ -156,7 +157,7 @@ export function buildComponent(
 ): Rule {
   return async (host, ctx) => {
     const context = ctx as FileSystemSchematicContext;
-    const workspace = await getWorkspace(host);
+    const workspace = await readWorkspace(host);
     const project = getProjectFromWorkspace(workspace, options.project);
     const defaultComponentOptions = getDefaultComponentOptions(project);
 

src/cdk/schematics/utils/get-project.ts

@@ -6,17 +6,17 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {workspaces} from '@angular-devkit/core';
 import {SchematicsException} from '@angular-devkit/schematics';
+import {ProjectDefinition, WorkspaceDefinition} from '@schematics/angular/utility';
 
 /**
  * Finds the specified project configuration in the workspace. Throws an error if the project
  * couldn't be found.
  */
 export function getProjectFromWorkspace(
-  workspace: workspaces.WorkspaceDefinition,
+  workspace: WorkspaceDefinition,
   projectName: string | undefined,
-): workspaces.ProjectDefinition {
+): ProjectDefinition {
   if (!projectName) {
     // TODO(crisbeto): some schematics APIs have the project name as optional so for now it's
     // simpler to allow undefined and checking it at runtime. Eventually we should clean this up.

src/cdk/schematics/utils/project-index-file.ts

@@ -6,11 +6,12 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {Path, workspaces} from '@angular-devkit/core';
+import {Path} from '@angular-devkit/core';
 import {getProjectBuildTargets} from './project-targets';
+import {ProjectDefinition} from '@schematics/angular/utility';
 
 /** Gets the path of the index file in the given project. */
-export function getProjectIndexFiles(project: workspaces.ProjectDefinition): Path[] {
+export function getProjectIndexFiles(project: ProjectDefinition): Path[] {
   const paths = getProjectBuildTargets(project)
     .filter(t => t.options?.['index'])
     .map(t => t.options!['index'] as Path);

src/cdk/schematics/utils/project-main-file.ts

@@ -6,12 +6,13 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {Path, workspaces} from '@angular-devkit/core';
+import {Path} from '@angular-devkit/core';
 import {SchematicsException} from '@angular-devkit/schematics';
 import {getProjectTargetOptions} from './project-targets';
+import {ProjectDefinition} from '@schematics/angular/utility';
 
 /** Looks for the main TypeScript file in the given project and returns its path. */
-export function getProjectMainFile(project: workspaces.ProjectDefinition): Path {
+export function getProjectMainFile(project: ProjectDefinition): Path {
   const buildOptions = getProjectTargetOptions(project, 'build');
 
   // `browser` is for the `@angular-devkit/build-angular:application` builder while

src/cdk/schematics/utils/project-style-file.ts

@@ -6,8 +6,9 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {isJsonArray, normalize, workspaces} from '@angular-devkit/core';
+import {isJsonArray, normalize} from '@angular-devkit/core';
 import {getProjectTargetOptions} from './project-targets';
+import {ProjectDefinition} from '@schematics/angular/utility';
 
 /** Regular expression that matches all possible Angular CLI default style files. */
 const defaultStyleFileRegex = /styles\.(c|le|sc)ss/;
@@ -19,10 +20,7 @@ const validStyleFileRegex = /\.(c|le|sc)ss/;
  * Gets a style file with the given extension in a project and returns its path. If no
  * extension is specified, any style file with a valid extension will be returned.
  */
-export function getProjectStyleFile(
-  project: workspaces.ProjectDefinition,
-  extension?: string,
-): string | null {
+export function getProjectStyleFile(project: ProjectDefinition, extension?: string): string | null {
   const buildOptions = getProjectTargetOptions(project, 'build');
   const buildStyles = buildOptions['styles'];
 

src/cdk/schematics/utils/project-targets.ts

@@ -6,8 +6,9 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {JsonValue, workspaces} from '@angular-devkit/core';
+import {JsonValue} from '@angular-devkit/core';
 import {SchematicsException} from '@angular-devkit/schematics';
+import {ProjectDefinition, TargetDefinition} from '@schematics/angular/utility';
 
 /** Possible names of CLI builders used to configure the project. */
 const PROJECT_BUILDERS = new Set([
@@ -22,7 +23,7 @@ const TEST_BUILDERS = new Set(['@angular-devkit/build-angular:karma', '@angular/
 
 /** Resolves the architect options for the build target of the given project. */
 export function getProjectTargetOptions(
-  project: workspaces.ProjectDefinition,
+  project: ProjectDefinition,
   buildTarget: string,
 ): Record<string, JsonValue | undefined> {
   const options = project.targets?.get(buildTarget)?.options;
@@ -37,24 +38,20 @@ export function getProjectTargetOptions(
 }
 
 /** Gets all of the default CLI-provided build targets in a project. */
-export function getProjectBuildTargets(
-  project: workspaces.ProjectDefinition,
-): workspaces.TargetDefinition[] {
+export function getProjectBuildTargets(project: ProjectDefinition): TargetDefinition[] {
   return getTargetsByBuilderName(project, builder => !!builder && PROJECT_BUILDERS.has(builder));
 }
 
 /** Gets all of the default CLI-provided testing targets in a project. */
-export function getProjectTestTargets(
-  project: workspaces.ProjectDefinition,
-): workspaces.TargetDefinition[] {
+export function getProjectTestTargets(project: ProjectDefinition): TargetDefinition[] {
   return getTargetsByBuilderName(project, builder => !!builder && TEST_BUILDERS.has(builder));
 }
 
 /** Gets all targets from the given project that pass a predicate check. */
 function getTargetsByBuilderName(
-  project: workspaces.ProjectDefinition,
+  project: ProjectDefinition,
   predicate: (name: string | undefined) => boolean,
-): workspaces.TargetDefinition[] {
+): TargetDefinition[] {
   return Array.from(project.targets.keys())
     .filter(name => predicate(project.targets.get(name)?.builder))
     .map(name => project.targets.get(name)!);

src/cdk/schematics/utils/project-tsconfig-paths.ts

@@ -6,17 +6,17 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {normalize, workspaces} from '@angular-devkit/core';
+import {normalize} from '@angular-devkit/core';
 import {Tree} from '@angular-devkit/schematics';
-import {getWorkspace} from '@schematics/angular/utility/workspace';
+import {ProjectDefinition, readWorkspace, WorkspaceDefinition} from '@schematics/angular/utility';
 import {WorkspacePath} from '../update-tool/file-system';
 
 /** Name of the default Angular CLI workspace configuration files. */
 const defaultWorkspaceConfigPaths = ['/angular.json', '/.angular.json'];
 
 /** Gets the tsconfig path from the given target within the specified project. */
 export function getTargetTsconfigPath(
-  project: workspaces.ProjectDefinition,
+  project: ProjectDefinition,
   targetName: string,
 ): WorkspacePath | null {
   const tsconfig = project.targets?.get(targetName)?.options?.['tsConfig'];
@@ -26,15 +26,15 @@ export function getTargetTsconfigPath(
 /** Resolve the workspace configuration of the specified tree gracefully. */
 export async function getWorkspaceConfigGracefully(
   tree: Tree,
-): Promise<workspaces.WorkspaceDefinition | null> {
+): Promise<WorkspaceDefinition | null> {
   const path = defaultWorkspaceConfigPaths.find(filePath => tree.exists(filePath));
 
   if (!path) {
     return null;
   }
 
   try {
-    return getWorkspace(tree, path);
+    return readWorkspace(tree, path);
   } catch {
     return null;
   }