refactor(@schematics/angular): clean up web-worker schematic

Remove code that used to handle version 8 applications. These should have migrated to the new structure when using ng-update.

Author: alan-agius4

packages/schematics/angular/web-worker/index.ts

@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { dirname, join, normalize, strings, tags } from '@angular-devkit/core';
+import { join, normalize, strings, tags } from '@angular-devkit/core';
 import {
   Rule,
   SchematicContext,
@@ -20,42 +20,11 @@ import {
   noop,
   url,
 } from '@angular-devkit/schematics';
-import { JSONFile } from '../utility/json-file';
 import { parseName } from '../utility/parse-name';
 import { relativePathToWorkspaceRoot } from '../utility/paths';
 import { buildDefaultPath, getWorkspace, updateWorkspace } from '../utility/workspace';
-import { BrowserBuilderOptions } from '../utility/workspace-models';
 import { Schema as WebWorkerOptions } from './schema';
 
-function addConfig(options: WebWorkerOptions, root: string, tsConfigPath: string): Rule {
-  return (host: Tree, context: SchematicContext) => {
-    context.logger.debug('updating project configuration.');
-
-    // Add worker glob exclusion to tsconfig.app.json.
-    // Projects pre version 8 should to have tsconfig.app.json inside their application
-    const isInSrc = dirname(normalize(tsConfigPath)).endsWith('src');
-    const workerGlob = `${isInSrc ? '' : 'src/'}**/*.worker.ts`;
-
-    try {
-      const json = new JSONFile(host, tsConfigPath);
-      const exclude = json.get(['exclude']);
-      if (exclude && Array.isArray(exclude) && !exclude.includes(workerGlob)) {
-        json.modify(['exclude'], [...exclude, workerGlob]);
-      }
-    } catch {}
-
-    return mergeWith(
-      apply(url('./files/worker-tsconfig'), [
-        applyTemplates({
-          ...options,
-          relativePathToWorkspaceRoot: relativePathToWorkspaceRoot(root),
-        }),
-        move(root),
-      ]),
-    );
-  };
-}
-
 function addSnippet(options: WebWorkerOptions): Rule {
   return (host: Tree, context: SchematicContext) => {
     context.logger.debug('Updating appmodule');
@@ -109,63 +78,60 @@ export default function (options: WebWorkerOptions): Rule {
     if (!options.project) {
       throw new SchematicsException('Option "project" is required.');
     }
-    if (!options.target) {
-      throw new SchematicsException('Option "target" is required.');
-    }
+
     const project = workspace.projects.get(options.project);
     if (!project) {
       throw new SchematicsException(`Invalid project name (${options.project})`);
     }
+
     const projectType = project.extensions['projectType'];
     if (projectType !== 'application') {
       throw new SchematicsException(`Web Worker requires a project type of "application".`);
     }
 
-    const projectTarget = project.targets.get(options.target);
-    if (!projectTarget) {
-      throw new Error(`Target is not defined for this project.`);
-    }
-    const projectTargetOptions = (projectTarget.options || {}) as unknown as BrowserBuilderOptions;
-
     if (options.path === undefined) {
       options.path = buildDefaultPath(project);
     }
     const parsedPath = parseName(options.path, options.name);
     options.name = parsedPath.name;
     options.path = parsedPath.path;
-    const root = project.root || '';
 
-    const needWebWorkerConfig = !projectTargetOptions.webWorkerTsConfig;
-    if (needWebWorkerConfig) {
-      const workerConfigPath = join(normalize(root), 'tsconfig.worker.json');
-      projectTargetOptions.webWorkerTsConfig = workerConfigPath;
-    }
-
-    const projectTestTarget = project.targets.get('test');
-    if (projectTestTarget) {
-      const projectTestTargetOptions = (projectTestTarget.options ||
-        {}) as unknown as BrowserBuilderOptions;
-
-      const needWebWorkerConfig = !projectTestTargetOptions.webWorkerTsConfig;
-      if (needWebWorkerConfig) {
-        const workerConfigPath = join(normalize(root), 'tsconfig.worker.json');
-        projectTestTargetOptions.webWorkerTsConfig = workerConfigPath;
-      }
-    }
-
-    const templateSource = apply(url('./files/worker'), [
+    const templateSourceWorkerCode = apply(url('./files/worker'), [
       applyTemplates({ ...options, ...strings }),
       move(parsedPath.path),
     ]);
 
+    const root = project.root || '';
+    const templateSourceWorkerConfig = apply(url('./files/worker-tsconfig'), [
+      applyTemplates({
+        ...options,
+        relativePathToWorkspaceRoot: relativePathToWorkspaceRoot(root),
+      }),
+      move(root),
+    ]);
+
     return chain([
       // Add project configuration.
-      needWebWorkerConfig ? addConfig(options, root, projectTargetOptions.tsConfig) : noop(),
-      needWebWorkerConfig ? updateWorkspace(workspace) : noop(),
+      updateWorkspace((workspace) => {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const project = workspace.projects.get(options.project)!;
+        const buildTarget = project.targets.get('build');
+        const testTarget = project.targets.get('test');
+        if (!buildTarget) {
+          throw new Error(`Build target is not defined for this project.`);
+        }
+
+        const workerConfigPath = join(normalize(root), 'tsconfig.worker.json');
+        (buildTarget.options ??= {}).webWorkerTsConfig ??= workerConfigPath;
+        if (testTarget) {
+          (testTarget.options ??= {}).webWorkerTsConfig ??= workerConfigPath;
+        }
+      }),
       // Create the worker in a sibling module.
       options.snippet ? addSnippet(options) : noop(),
       // Add the worker.
-      mergeWith(templateSource),
+      mergeWith(templateSourceWorkerCode),
+      mergeWith(templateSourceWorkerConfig),
     ]);
   };
 }

packages/schematics/angular/web-worker/index_spec.ts

@@ -77,21 +77,6 @@ describe('Web Worker Schematic', () => {
     );
   });
 
-  it('should add exclusions to tsconfig.app.json', async () => {
-    const oldTsConfig = {
-      extends: '../../tsconfig.json',
-      include: ['src/**/*.ts'],
-      exclude: ['src/test.ts', 'src/**/*.spec.ts'],
-    };
-    appTree.overwrite('projects/bar/tsconfig.app.json', JSON.stringify(oldTsConfig, undefined, 2));
-
-    const tree = await schematicRunner
-      .runSchematicAsync('web-worker', defaultOptions, appTree)
-      .toPromise();
-    const { exclude } = JSON.parse(tree.readContent('/projects/bar/tsconfig.app.json'));
-    expect(exclude).toContain('src/**/*.worker.ts');
-  });
-
   it('should add snippet to sibling file', async () => {
     const tree = await schematicRunner
       .runSchematicAsync('web-worker', defaultOptions, appTree)
@@ -118,24 +103,4 @@ describe('Web Worker Schematic', () => {
     const { compilerOptions } = parseJson(tree.readContent(path).toString());
     expect(compilerOptions.outDir).toBe('./out-tsc/worker');
   });
-
-  it('supports pre version 8 structure', async () => {
-    const workspace = JSON.parse(appTree.readContent('/angular.json'));
-    const tsConfigPath = '/projects/bar/src/tsconfig.app.json';
-    workspace.projects.bar.architect.build.options.tsConfig = tsConfigPath;
-    appTree.overwrite('/angular.json', JSON.stringify(workspace));
-
-    const oldTsConfig = {
-      extends: '../../../tsconfig.json',
-      include: ['**/*.ts'],
-      exclude: ['test.ts', '**/*.spec.ts'],
-    };
-    appTree.create('projects/bar/src/tsconfig.app.json', JSON.stringify(oldTsConfig, undefined, 2));
-
-    const tree = await schematicRunner
-      .runSchematicAsync('web-worker', defaultOptions, appTree)
-      .toPromise();
-    const { exclude } = JSON.parse(tree.readContent(tsConfigPath));
-    expect(exclude).toContain('**/*.worker.ts');
-  });
 });

packages/schematics/angular/web-worker/schema.json

@@ -22,7 +22,8 @@
     "target": {
       "type": "string",
       "description": "The target to apply web worker to.",
-      "default": "build"
+      "default": "build",
+      "x-deprecated": "No longer has an effect."
     },
     "name": {
       "type": "string",