feat(@schematics/angular): JSON schema for service worker config

Author: cyrilletuzi

packages/schematics/angular/service-worker/files/ngsw-config.json.template

@@ -1,4 +1,5 @@
 {
+  "$schema": "<%= relativePathToWorkspaceRoot %>/node_modules/@angular/service-worker/config/schema.json",
   "index": "/index.html",
   "assetGroups": [
     {

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

@@ -169,13 +169,16 @@ export default function (options: ServiceWorkerOptions): Rule {
       throw new SchematicsException(`Service worker requires a project type of "application".`);
     }
 
+    const relativePathToWorkspaceRoot = project.root ?
+      project.root.split('/').filter(x => x !== '').map(x => '..').join('/') : '.';
+
     let { resourcesOutputPath = '' } = getProjectConfiguration(workspace, options);
     if (resourcesOutputPath) {
       resourcesOutputPath = '/' + resourcesOutputPath.split('/').filter(x => !!x).join('/');
     }
 
     const templateSource = apply(url('./files'), [
-      applyTemplates({ ...options, resourcesOutputPath }),
+      applyTemplates({ ...options, resourcesOutputPath, relativePathToWorkspaceRoot }),
       move(project.root),
     ]);
 

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

@@ -101,6 +101,31 @@ describe('Service Worker Schematic', () => {
       .toBe('projects/bar/ngsw-config.json');
   });
 
+  it('should add $schema in ngsw-config.json with correct relative path', () => {
+    const pathToNgswConfigSchema = 'node_modules/@angular/service-worker/config/schema.json';
+
+    const name = 'foo';
+    const rootAppOptions: ApplicationOptions = {
+      ...appOptions,
+      name,
+      projectRoot: '',
+    };
+    const rootSWOptions: ServiceWorkerOptions = {
+      ...defaultOptions,
+      project: name,
+    };
+    const rootAppTree = schematicRunner.runSchematic('application', rootAppOptions, appTree);
+    const treeInRoot = schematicRunner.runSchematic('service-worker', rootSWOptions, rootAppTree);
+    const pkgTextInRoot = treeInRoot.readContent('/ngsw-config.json');
+    const configInRoot = JSON.parse(pkgTextInRoot);
+    expect(configInRoot.$schema).toBe(`./${pathToNgswConfigSchema}`);
+
+    const treeNotInRoot = schematicRunner.runSchematic('service-worker', defaultOptions, appTree);
+    const pkgTextNotInRoot = treeNotInRoot.readContent('/projects/bar/ngsw-config.json');
+    const configNotInRoot = JSON.parse(pkgTextNotInRoot);
+    expect(configNotInRoot.$schema).toBe(`../../${pathToNgswConfigSchema}`);
+  });
+
   it('should add root assets RegExp', () => {
     const tree = schematicRunner.runSchematic('service-worker', defaultOptions, appTree);
     const pkgText = tree.readContent('/projects/bar/ngsw-config.json');