feat(@schematics/angular): replace assets with public directory

The `assets` directory is confusing for the users and commonly users place "assets" which are not meant to be copied but instead processed by the build system. This causes some files both bundled and copied.

With this change we rename the `assets` directory to `public` and also move the `favicon.ico` inside this newly created directory.

Author: alan-agius4

goldens/public-api/angular_devkit/build_angular/index.md

@@ -79,7 +79,7 @@ export interface AssetPatternObject {
     glob: string;
     ignore?: string[];
     input: string;
-    output: string;
+    output?: string;
 }
 
 // @public

…/pwa/pwa/files/root/manifest.webmanifest …wa/pwa/files/assets/manifest.webmanifestpackages/angular/pwa/pwa/files/root/manifest.webmanifest renamed to packages/angular/pwa/pwa/files/assets/manifest.webmanifest packages/angular/pwa/pwa/files/root/manifest.webmanifest renamed to packages/angular/pwa/pwa/files/assets/manifest.webmanifest

@@ -15,7 +15,6 @@ import {
   externalSchematic,
   mergeWith,
   move,
-  template,
   url,
 } from '@angular-devkit/schematics';
 import { readWorkspace, writeWorkspace } from '@schematics/angular/utility';
@@ -104,23 +103,6 @@ export default function (options: PwaOptions): Rule {
       }
     }
 
-    // Add manifest to asset configuration
-    const assetEntry = posix.join(
-      project.sourceRoot ?? posix.join(project.root, 'src'),
-      'manifest.webmanifest',
-    );
-    for (const target of [...buildTargets, ...testTargets]) {
-      if (target.options) {
-        if (Array.isArray(target.options.assets)) {
-          target.options.assets.push(assetEntry);
-        } else {
-          target.options.assets = [assetEntry];
-        }
-      } else {
-        target.options = { assets: [assetEntry] };
-      }
-    }
-
     // Find all index.html files in build targets
     const indexFiles = new Set<string>();
     for (const target of buildTargets) {
@@ -146,11 +128,32 @@ export default function (options: PwaOptions): Rule {
     const { title, ...swOptions } = options;
 
     await writeWorkspace(host, workspace);
+    let assetsDir = posix.join(sourcePath, 'assets');
+
+    if (host.exists(assetsDir)) {
+      // Add manifest to asset configuration
+      const assetEntry = posix.join(
+        project.sourceRoot ?? posix.join(project.root, 'src'),
+        'manifest.webmanifest',
+      );
+      for (const target of [...buildTargets, ...testTargets]) {
+        if (target.options) {
+          if (Array.isArray(target.options.assets)) {
+            target.options.assets.push(assetEntry);
+          } else {
+            target.options.assets = [assetEntry];
+          }
+        } else {
+          target.options = { assets: [assetEntry] };
+        }
+      }
+    } else {
+      assetsDir = posix.join(project.root, 'public');
+    }
 
     return chain([
       externalSchematic('@schematics/angular', 'service-worker', swOptions),
-      mergeWith(apply(url('./files/root'), [template({ ...options }), move(sourcePath)])),
-      mergeWith(apply(url('./files/assets'), [move(posix.join(sourcePath, 'assets'))])),
+      mergeWith(apply(url('./files/assets'), [move(assetsDir)])),
       ...[...indexFiles].map((path) => updateIndexFile(path)),
     ]);
   };

packages/angular/pwa/pwa/index.ts

@@ -74,13 +74,13 @@ describe('PWA Schematic', () => {
 
   it('should create a manifest file', async () => {
     const tree = await schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
-    expect(tree.exists('/projects/bar/src/manifest.webmanifest')).toBeTrue();
+    expect(tree.exists('/projects/bar/public/manifest.webmanifest')).toBeTrue();
   });
 
   it('should set the name & short_name in the manifest file', async () => {
     const tree = await schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
 
-    const manifestText = tree.readContent('/projects/bar/src/manifest.webmanifest');
+    const manifestText = tree.readContent('/projects/bar/public/manifest.webmanifest');
     const manifest = JSON.parse(manifestText);
 
     expect(manifest.name).toEqual(defaultOptions.title);
@@ -91,7 +91,7 @@ describe('PWA Schematic', () => {
     const options = { ...defaultOptions, title: undefined };
     const tree = await schematicRunner.runSchematic('ng-add', options, appTree);
 
-    const manifestText = tree.readContent('/projects/bar/src/manifest.webmanifest');
+    const manifestText = tree.readContent('/projects/bar/public/manifest.webmanifest');
     const manifest = JSON.parse(manifestText);
 
     expect(manifest.name).toEqual(defaultOptions.project);
@@ -125,17 +125,6 @@ describe('PWA Schematic', () => {
     expect(content).toMatch(/<noscript>NO JAVASCRIPT<\/noscript>/);
   });
 
-  it('should update the build and test assets configuration', async () => {
-    const tree = await schematicRunner.runSchematic('ng-add', defaultOptions, appTree);
-    const configText = tree.readContent('/angular.json');
-    const config = JSON.parse(configText);
-    const targets = config.projects.bar.architect;
-
-    ['build', 'test'].forEach((target) => {
-      expect(targets[target].options.assets).toContain('projects/bar/src/manifest.webmanifest');
-    });
-  });
-
   describe('Legacy browser builder', () => {
     function convertBuilderToLegacyBrowser(): void {
       const config = JSON.parse(appTree.readContent('/angular.json'));

packages/angular/pwa/pwa/index_spec.ts

@@ -560,11 +560,12 @@
             },
             "output": {
               "type": "string",
+              "default": "",
               "description": "Absolute path within the output."
             }
           },
           "additionalProperties": false,
-          "required": ["glob", "input", "output"]
+          "required": ["glob", "input"]
         },
         {
           "type": "string"

packages/angular_devkit/build_angular/src/builders/application/schema.json

@@ -466,11 +466,12 @@
             },
             "output": {
               "type": "string",
+              "default": "",
               "description": "Absolute path within the output."
             }
           },
           "additionalProperties": false,
-          "required": ["glob", "input", "output"]
+          "required": ["glob", "input"]
         },
         {
           "type": "string"

packages/angular_devkit/build_angular/src/builders/browser-esbuild/schema.json

@@ -454,11 +454,12 @@
             },
             "output": {
               "type": "string",
+              "default": "",
               "description": "Absolute path within the output."
             }
           },
           "additionalProperties": false,
-          "required": ["glob", "input", "output"]
+          "required": ["glob", "input"]
         },
         {
           "type": "string"

packages/angular_devkit/build_angular/src/builders/browser/schema.json

@@ -290,6 +290,7 @@
             },
             "output": {
               "type": "string",
+              "default": "",
               "description": "Absolute path within the output."
             },
             "ignore": {
@@ -301,7 +302,7 @@
             }
           },
           "additionalProperties": false,
-          "required": ["glob", "input", "output"]
+          "required": ["glob", "input"]
         },
         {
           "type": "string"

packages/angular_devkit/build_angular/src/builders/karma/schema.json

@@ -251,11 +251,12 @@
             },
             "output": {
               "type": "string",
+              "default": "",
               "description": "Absolute path within the output."
             }
           },
           "additionalProperties": false,
-          "required": ["glob", "input", "output"]
+          "required": ["glob", "input"]
         },
         {
           "type": "string"

packages/angular_devkit/build_angular/src/builders/server/schema.json

@@ -269,6 +269,7 @@
             },
             "output": {
               "type": "string",
+              "default": "",
               "description": "Absolute path within the output."
             },
             "ignore": {
@@ -280,7 +281,7 @@
             }
           },
           "additionalProperties": false,
-          "required": ["glob", "input", "output"]
+          "required": ["glob", "input"]
         },
         {
           "type": "string"