refactor(@schematics/angular): make interaction with architect targets type safe

Author: alan-agius4

packages/schematics/angular/app-shell/index.ts

@@ -5,7 +5,7 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
-import { JsonObject, dirname, experimental, join, normalize } from '@angular-devkit/core';
+import { dirname, experimental, join, normalize } from '@angular-devkit/core';
 import {
   Rule,
   SchematicContext,
@@ -26,19 +26,13 @@ import {
   isImported,
 } from '../utility/ast-utils';
 import { Change, InsertChange } from '../utility/change';
-import { getWorkspace, getWorkspacePath } from '../utility/config';
+import { getWorkspace, updateWorkspace } from '../utility/config';
 import { getAppModulePath } from '../utility/ng-ast-utils';
-import { getProjectTargets } from '../utility/project-targets';
+import { getProject } from '../utility/project';
+import { getProjectTargets, targetBuildNotFoundError } from '../utility/project-targets';
+import { Builders, WorkspaceProject } from '../utility/workspace-models';
 import { Schema as AppShellOptions } from './schema';
 
-
-// Helper functions. (possible refactors to utils)
-function formatMissingAppMsg(label: string, nameOrIndex: string | undefined): string {
-  const nameOrIndexText = nameOrIndex ? ` (${nameOrIndex})` : '';
-
-  return `${label} app ${nameOrIndexText} not found.`;
-}
-
 function getSourceFile(host: Tree, path: string): ts.SourceFile {
   const buffer = host.read(path);
   if (!buffer) {
@@ -103,9 +97,13 @@ function getComponentTemplate(host: Tree, compPath: string, tmplInfo: TemplateIn
 
 function getBootstrapComponentPath(
   host: Tree,
-  project: experimental.workspace.WorkspaceProject,
+  project: WorkspaceProject,
 ): string {
   const projectTargets = getProjectTargets(project);
+  if (!projectTargets.build) {
+    throw targetBuildNotFoundError();
+  }
+
   const mainPath = projectTargets.build.options.main;
   const modulePath = getAppModulePath(host, mainPath);
   const moduleSource = getSourceFile(host, modulePath);
@@ -137,7 +135,7 @@ function validateProject(options: AppShellOptions): Rule {
   return (host: Tree, context: SchematicContext) => {
     const routerOutletCheckRegex = /<router\-outlet.*?>([\s\S]*?)<\/router\-outlet>/;
 
-    const clientProject = getClientProject(host, options);
+    const clientProject = getProject(host, options.clientProject);
     if (clientProject.projectType !== 'application') {
       throw new SchematicsException(`App shell requires a project type of "application".`);
     }
@@ -155,11 +153,9 @@ function validateProject(options: AppShellOptions): Rule {
 
 function addUniversalTarget(options: AppShellOptions): Rule {
   return (host: Tree, context: SchematicContext) => {
-    const architect = getClientArchitect(host, options);
-    if (architect !== null) {
-      if (architect.server !== undefined) {
-        return host;
-      }
+    const architect = getProjectTargets(host, options.clientProject);
+    if (architect.server) {
+      return host;
     }
 
     // Copy options.
@@ -187,10 +183,9 @@ function addAppShellConfigToWorkspace(options: AppShellOptions): Rule {
     }
 
     const workspace = getWorkspace(host);
-    const workspacePath = getWorkspacePath(host);
-
-    const appShellTarget: JsonObject = {
-      builder: '@angular-devkit/build-angular:app-shell',
+    const projectTargets = getProjectTargets(workspace, options.clientProject);
+    projectTargets['app-shell'] = {
+      builder: Builders.AppShell,
       options: {
         browserTarget: `${options.clientProject}:build`,
         serverTarget: `${options.clientProject}:server`,
@@ -203,23 +198,17 @@ function addAppShellConfigToWorkspace(options: AppShellOptions): Rule {
       },
     };
 
-    if (!workspace.projects[options.clientProject]) {
-      throw new SchematicsException(`Client app ${options.clientProject} not found.`);
-    }
-    const clientProject = workspace.projects[options.clientProject];
-    const projectTargets = getProjectTargets(clientProject);
-    projectTargets['app-shell'] = appShellTarget;
-
-    host.overwrite(workspacePath, JSON.stringify(workspace, null, 2));
-
-    return host;
+    return updateWorkspace(workspace);
   };
 }
 
 function addRouterModule(options: AppShellOptions): Rule {
   return (host: Tree) => {
-    const clientArchitect = getClientArchitect(host, options);
-    const mainPath = clientArchitect.build.options.main;
+    const projectTargets = getProjectTargets(host, options.clientProject);
+    if (!projectTargets.build) {
+      throw targetBuildNotFoundError();
+    }
+    const mainPath = projectTargets.build.options.main;
     const modulePath = getAppModulePath(host, mainPath);
     const moduleSource = getSourceFile(host, modulePath);
     const changes = addImportToModule(moduleSource, modulePath, 'RouterModule', '@angular/router');
@@ -256,8 +245,8 @@ function getMetadataProperty(metadata: ts.Node, propertyName: string): ts.Proper
 
 function addServerRoutes(options: AppShellOptions): Rule {
   return (host: Tree) => {
-    const clientProject = getClientProject(host, options);
-    const architect = getClientArchitect(host, options);
+    const clientProject = getProject(host, options.clientProject);
+    const architect = getProjectTargets(clientProject);
     // const mainPath = universalArchitect.build.options.main;
     const modulePath = getServerModulePath(host, clientProject, architect);
     if (modulePath === null) {
@@ -322,27 +311,6 @@ function addShellComponent(options: AppShellOptions): Rule {
   return schematic('component', componentOptions);
 }
 
-function getClientProject(
-  host: Tree, options: AppShellOptions,
-): experimental.workspace.WorkspaceProject {
-  const workspace = getWorkspace(host);
-  const clientProject = workspace.projects[options.clientProject];
-  if (!clientProject) {
-    throw new SchematicsException(formatMissingAppMsg('Client', options.clientProject));
-  }
-
-  return clientProject;
-}
-
-function getClientArchitect(
-  host: Tree, options: AppShellOptions,
-): experimental.workspace.WorkspaceTool {
-  const clientProject = getClientProject(host, options);
-  const projectTargets = getProjectTargets(clientProject);
-
-  return projectTargets;
-}
-
 export default function (options: AppShellOptions): Rule {
   return chain([
     validateProject(options),

packages/schematics/angular/application/index.ts

@@ -24,14 +24,18 @@ import {
 } from '@angular-devkit/schematics';
 import { Schema as E2eOptions } from '../e2e/schema';
 import {
-  WorkspaceProject,
-  WorkspaceSchema,
   addProjectToWorkspace,
   getWorkspace,
 } from '../utility/config';
 import { NodeDependencyType, addPackageJsonDependency } from '../utility/dependencies';
 import { latestVersions } from '../utility/latest-versions';
 import { validateProjectName } from '../utility/validation';
+import {
+  Builders,
+  ProjectType,
+  WorkspaceProject,
+  WorkspaceSchema,
+} from '../utility/workspace-models';
 import { Schema as ApplicationOptions } from './schema';
 
 
@@ -133,12 +137,12 @@ function addAppToWorkspaceFile(options: ApplicationOptions, workspace: Workspace
   const project: WorkspaceProject = {
     root: projectRoot,
     sourceRoot: join(normalize(projectRoot), 'src'),
-    projectType: 'application',
+    projectType: ProjectType.Application,
     prefix: options.prefix || 'app',
     schematics,
     targets: {
       build: {
-        builder: '@angular-devkit/build-angular:browser',
+        builder: Builders.Browser,
         options: {
           outputPath: `dist/${options.name}`,
           index: `${projectRoot}src/index.html`,
@@ -173,7 +177,7 @@ function addAppToWorkspaceFile(options: ApplicationOptions, workspace: Workspace
         },
       },
       serve: {
-        builder: '@angular-devkit/build-angular:dev-server',
+        builder: Builders.DevServer,
         options: {
           browserTarget: `${options.name}:build`,
         },
@@ -184,13 +188,13 @@ function addAppToWorkspaceFile(options: ApplicationOptions, workspace: Workspace
         },
       },
       'extract-i18n': {
-        builder: '@angular-devkit/build-angular:extract-i18n',
+        builder: Builders.ExtractI18n,
         options: {
           browserTarget: `${options.name}:build`,
         },
       },
       test: {
-        builder: '@angular-devkit/build-angular:karma',
+        builder: Builders.Karma,
         options: {
           main: `${projectRoot}src/test.ts`,
           polyfills: `${projectRoot}src/polyfills.ts`,
@@ -207,7 +211,7 @@ function addAppToWorkspaceFile(options: ApplicationOptions, workspace: Workspace
         },
       },
       lint: {
-        builder: '@angular-devkit/build-angular:tslint',
+        builder: Builders.TsLint,
         options: {
           tsConfig: [
             `${rootFilesRoot}tsconfig.app.json`,

packages/schematics/angular/class/index.ts

@@ -20,18 +20,17 @@ import {
   template,
   url,
 } from '@angular-devkit/schematics';
-import { getWorkspace } from '../utility/config';
 import { parseName } from '../utility/parse-name';
-import { buildDefaultPath } from '../utility/project';
+import { buildDefaultPath, getProject } from '../utility/project';
 import { Schema as ClassOptions } from './schema';
 
 export default function (options: ClassOptions): Rule {
   return (host: Tree, context: SchematicContext) => {
-    const workspace = getWorkspace(host);
     if (!options.project) {
       throw new SchematicsException('Option (project) is required.');
     }
-    const project = workspace.projects[options.project];
+
+    const project = getProject(host, options.project);
 
     if (options.path === undefined) {
       options.path = buildDefaultPath(project);

packages/schematics/angular/component/index.ts

@@ -27,11 +27,10 @@ import {
   addExportToModule,
 } from '../utility/ast-utils';
 import { InsertChange } from '../utility/change';
-import { getWorkspace } from '../utility/config';
 import { buildRelativePath, findModuleFromOptions } from '../utility/find-module';
 import { applyLintFix } from '../utility/lint-fix';
 import { parseName } from '../utility/parse-name';
-import { buildDefaultPath } from '../utility/project';
+import { buildDefaultPath, getProject } from '../utility/project';
 import { validateHtmlSelector, validateName } from '../utility/validation';
 import { Schema as ComponentOptions } from './schema';
 
@@ -128,11 +127,10 @@ function buildSelector(options: ComponentOptions, projectPrefix: string) {
 
 export default function(options: ComponentOptions): Rule {
   return (host: Tree) => {
-    const workspace = getWorkspace(host);
     if (!options.project) {
       throw new SchematicsException('Option (project) is required.');
     }
-    const project = workspace.projects[options.project];
+    const project = getProject(host, options.project);
 
     if (options.path === undefined) {
       options.path = buildDefaultPath(project);

packages/schematics/angular/directive/index.ts

@@ -23,11 +23,10 @@ import {
 import * as ts from 'typescript';
 import { addDeclarationToModule, addExportToModule } from '../utility/ast-utils';
 import { InsertChange } from '../utility/change';
-import { getWorkspace } from '../utility/config';
 import { buildRelativePath, findModuleFromOptions } from '../utility/find-module';
 import { applyLintFix } from '../utility/lint-fix';
 import { parseName } from '../utility/parse-name';
-import { buildDefaultPath } from '../utility/project';
+import { buildDefaultPath, getProject } from '../utility/project';
 import { validateHtmlSelector } from '../utility/validation';
 import { Schema as DirectiveOptions } from './schema';
 
@@ -104,11 +103,10 @@ function buildSelector(options: DirectiveOptions, projectPrefix: string) {
 
 export default function (options: DirectiveOptions): Rule {
   return (host: Tree) => {
-    const workspace = getWorkspace(host);
     if (!options.project) {
       throw new SchematicsException('Option (project) is required.');
     }
-    const project = workspace.projects[options.project];
+    const project = getProject(host, options.project);
 
     if (options.path === undefined) {
       options.path = buildDefaultPath(project);