feat(@angular/cli): Add VsCode extension recommendations

Author: mrmeku

packages/schematics/angular/migrations/migration-collection.json

@@ -29,6 +29,11 @@
       "version": "7.0.3",
       "factory": "./update-7/index#updateDevkitBuildNgPackagr",
       "description": "Update an Angular CLI project to version 7."
+    },
+    "migration-07": {
+      "version": "8.0.0",
+      "factory": "./update-vscode-recommendations/update-8.0.0",
+      "description": "Update an Angular CLI project to version 8.0.0"
     }
   }
 }

packages/schematics/angular/migrations/update-vscode-recommendations/ast-utils.ts

@@ -0,0 +1,41 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * 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 { Rule, Tree } from '@angular-devkit/schematics';
+
+export function readJsonInTree<T>(host: Tree, path: string): T {
+  if (!host.exists(path)) {
+    throw new Error(`Cannot find ${path}`);
+  }
+
+  const json = host.read(path);
+  if (!json) {
+    throw new Error(`Cannot read ${path}`);
+  }
+
+  return JSON.parse(json.toString('utf-8'));
+}
+
+export function serializeJson<T>(json: T): string {
+  return `${JSON.stringify(json, null, 2)}\n`;
+}
+
+export function updateJsonInTree<T, O = T>(
+  path: string,
+  callback: (json: T) => O,
+): Rule {
+  return (host: Tree): Tree => {
+    if (!host.exists(path)) {
+      host.create(path, serializeJson(callback({} as T)));
+
+      return host;
+    }
+    host.overwrite(path, serializeJson(callback(readJsonInTree(host, path))));
+
+    return host;
+  };
+}

packages/schematics/angular/migrations/update-vscode-recommendations/update-8.0.0.ts

@@ -0,0 +1,27 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * 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 { Rule, chain } from '@angular-devkit/schematics';
+import { updateJsonInTree } from './ast-utils';
+
+export default function (): Rule {
+  return chain([addExtensionRecommendations]);
+}
+
+const addExtensionRecommendations = updateJsonInTree(
+  '.vscode/extensions.json',
+  (json: { recommendations?: string[] }) => {
+    ['angular.ng-template', 'ms-vscode.vscode-typescript-tslint-plugin'].forEach(extension => {
+      json.recommendations = json.recommendations || [];
+      if (!json.recommendations.includes(extension)) {
+        json.recommendations.push(extension);
+      }
+    });
+
+    return json;
+  },
+);

packages/schematics/angular/migrations/update-vscode-recommendations/update-8.0.0_spec.ts

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * 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 { Tree } from '@angular-devkit/schematics';
+import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
+import { readJsonInTree, serializeJson, updateJsonInTree } from './ast-utils';
+
+describe('Update 8.0.0', () => {
+  let initialTree: Tree;
+  let schematicRunner: SchematicTestRunner;
+
+  beforeEach(() => {
+    initialTree = Tree.empty();
+
+    initialTree.create(
+      'package.json',
+      serializeJson({
+        devDependencies: { '@angular/cli': '7.1.0', typescript: '~3.1.0' },
+      }),
+    );
+
+    schematicRunner = new SchematicTestRunner(
+      'migrations',
+      require.resolve('../migration-collection.json'),
+    );
+  });
+
+  it('should add vscode extension recommendations', async () => {
+    const result = await schematicRunner
+      .runSchematicAsync('migration-07', {}, initialTree)
+      .toPromise();
+
+    expect(readJsonInTree(result, '.vscode/extensions.json')).toEqual({
+      recommendations: ['angular.ng-template', 'ms-vscode.vscode-typescript-tslint-plugin'],
+    });
+  });
+
+  it('should add to existing vscode extension recommendations', async () => {
+    initialTree = await schematicRunner
+      .callRule(
+        updateJsonInTree('.vscode/extensions.json', () => ({
+          recommendations: [
+            'eamodio.gitlens', 'angular.ng-template', 'ms-vscode.vscode-typescript-tslint-plugin'],
+        })),
+        initialTree,
+      )
+      .toPromise();
+
+    const result = await schematicRunner
+      .runSchematicAsync('migration-07', {}, initialTree)
+      .toPromise();
+
+    expect(readJsonInTree(result, '.vscode/extensions.json')).toEqual({
+      recommendations: [
+        'eamodio.gitlens', 'angular.ng-template', 'ms-vscode.vscode-typescript-tslint-plugin'],
+    });
+  });
+});

packages/schematics/angular/workspace/files/__dot__vscode/extensions.json.template

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "angular.ng-template",
+    "ms-vscode.vscode-typescript-tslint-plugin
+  ]
+}