feat(schematics): add ng-add schematics implementation

Author: tomastrajan

package-lock.json

@@ -1,5 +1,5 @@
-import * as assert from 'assert';
-import * as sinon from 'sinon';
+import assert from 'assert';
+import sinon from 'sinon';
 
 import { ModelFactory } from './model';
 

src/model/model.test.ts

@@ -1,5 +1,5 @@
-import * as assert from 'assert';
-import * as path from 'path';
+import assert from 'assert';
+import path from 'path';
 import {
   SchematicTestRunner,
   UnitTestTree
@@ -36,7 +36,7 @@ const runner = new SchematicTestRunner('schematics', collectionPath);
 
 let appTree: UnitTestTree;
 
-describe('Model Schematic', () => {
+describe('Schematic: Model', () => {
   beforeEach(() => {
     appTree = runner.runExternalSchematic(
       '@schematics/angular',
@@ -114,7 +114,7 @@ describe('Model Schematic', () => {
     const content = tree.readContent(
       '/projects/bar/src/app/foo/foo.service.ts'
     );
-    assert(content.includes("providedIn: 'root'"));
+    assert(content.includes(`providedIn: 'root'`));
   });
 
   it('should not be tree-shakeable if module is set', () => {
@@ -124,7 +124,7 @@ describe('Model Schematic', () => {
     const content = tree.readContent(
       '/projects/bar/src/app/foo/foo.service.ts'
     );
-    assert(!content.includes("providedIn: 'root'"));
+    assert(!content.includes(`providedIn: 'root'`));
   });
 
   it('should create model interface', () => {
@@ -152,15 +152,15 @@ describe('Model Schematic', () => {
 
     const tree = runner.runSchematic('model', options, appTree);
     const content = tree.readContent('/projects/bar/src/app/app.module.ts');
-    assert(!content.includes("import { FooService } from './foo/foo.service'"));
+    assert(!content.includes(`import { FooService } from './foo/foo.service'`));
   });
 
   it('should import into a specified module', () => {
     const options = { ...defaultOptions, module: 'app.module.ts' };
 
     const tree = runner.runSchematic('model', options, appTree);
     const content = tree.readContent('/projects/bar/src/app/app.module.ts');
-    assert(content.includes("import { FooService } from './foo/foo.service'"));
+    assert(content.includes(`import { FooService } from './foo/foo.service'`));
   });
 
   it('should fail if specified module does not exist', () => {

src/schematics/model/index.test.ts

@@ -0,0 +1,75 @@
+import assert from 'assert';
+import path from 'path';
+import {
+  SchematicTestRunner,
+  UnitTestTree
+} from '@angular-devkit/schematics/testing';
+import { Schema as ApplicationOptions } from '@schematics/angular/application/schema';
+import { Schema as WorkspaceOptions } from '@schematics/angular/workspace/schema';
+
+import packageJson from '../../../package.json';
+
+import { Schema as NgAddOptions } from './schema';
+
+const workspaceOptions: WorkspaceOptions = {
+  name: 'workspace',
+  newProjectRoot: 'projects',
+  version: '6.0.0'
+};
+
+const appOptions: ApplicationOptions = {
+  name: 'bar',
+  inlineStyle: false,
+  inlineTemplate: false,
+  routing: false,
+  style: 'css',
+  skipTests: false,
+  skipPackageJson: false
+};
+
+const defaultOptions: NgAddOptions = {
+  skipInstall: false
+};
+
+const collectionPath = path.join(__dirname, '../collection.json');
+const runner = new SchematicTestRunner('schematics', collectionPath);
+const version = packageJson.version;
+
+let appTree: UnitTestTree;
+
+describe('Schematic: ng-add', () => {
+  beforeEach(() => {
+    appTree = runner.runExternalSchematic(
+      '@schematics/angular',
+      'workspace',
+      workspaceOptions
+    );
+    appTree = runner.runExternalSchematic(
+      '@schematics/angular',
+      'application',
+      appOptions,
+      appTree
+    );
+  });
+
+  it('should add @angular-extensions/model to dependencies in package.json', () => {
+    const options = { ...defaultOptions };
+
+    const tree = runner.runSchematic('ng-add', options, appTree);
+    const content = tree.readContent('/package.json');
+    const contentAsObject = JSON.parse(content);
+    assert.equal(runner.tasks.length, 1);
+    assert(content.includes(`"@angular-extensions/model": "^${version}"`));
+    assert.equal(
+      contentAsObject.dependencies['@angular-extensions/model'],
+      `^${version}`
+    );
+  });
+
+  it('should respect skipInstall flag', () => {
+    const options = { ...defaultOptions, skipInstall: true };
+
+    const tree = runner.runSchematic('ng-add', options, appTree);
+    assert.equal(runner.tasks.length, 0);
+  });
+});

src/schematics/ng-add/index.test.ts

@@ -0,0 +1,23 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+import { NodePackageInstallTask } from '@angular-devkit/schematics/tasks';
+
+import packageJson from '../../../package.json';
+import { addPackageToPackageJson } from '../utils';
+
+import { Schema as NgAddOptions } from './schema';
+
+export default function(options: NgAddOptions): Rule {
+  return (host: Tree, context: SchematicContext) => {
+    const version = packageJson.version;
+    addPackageToPackageJson(host, '@angular-extensions/model', `^${version}`);
+    context.logger.log(
+      'info',
+      `✅️ Added "@angular-extensions/model@^${version}" into dependencies`
+    );
+
+    if (!options.skipInstall) {
+      context.addTask(new NodePackageInstallTask());
+    }
+    return host;
+  };
+}

src/schematics/ng-add/index.ts

@@ -1,4 +1,3 @@
-export interface Schema {
-  name: string;
-  skipInstall: boolean;
-}
+export interface Schema {
+  skipInstall: boolean;
+}

src/schematics/ng-add/schema.d.ts

@@ -1,21 +1,16 @@
-{
-  "$schema": "http://json-schema.org/schema",
-  "id": "@angular-extensions/model/ng-add",
-  "title": "Add Angular model to the project",
-  "description": "NOTE: Does not work in the --dry-run mode",
-  "type": "object",
-  "properties": {
-    "skipInstall": {
-      "type": "boolean",
-      "description": "Skip installing after adding @angular-extensions/model",
-      "default": false
-    },
-    "name": {
-      "type": "string",
-      "description": "Project name.",
-      "$default": {
-        "$source": "projectName"
-      }
-    }
-  }
-}
+{
+  "$schema": "http://json-schema.org/schema",
+  "id": "@angular-extensions/model/ng-add",
+  "title": "Add Angular model to the project",
+  "description": "NOTE: Does not work in the --dry-run mode",
+  "type": "object",
+  "properties": {
+    "skipInstall": {
+      "type": "boolean",
+      "description": "Skip installing after adding @angular-extensions/model",
+      "default": false
+    }
+  },
+  "required": [],
+  "additionalProperties": false
+}

src/schematics/ng-add/schema.json

@@ -17,6 +17,7 @@
     "skipLibCheck": true,
     "sourceMap": false,
     "strictNullChecks": true,
+    "resolveJsonModule": true,
     "target": "es6",
     "types": ["node", "mocha"]
   },

src/schematics/tsconfig.json

@@ -0,0 +1,34 @@
+import { Tree } from '@angular-devkit/schematics';
+
+export function addPackageToPackageJson(
+  host: Tree,
+  pkg: string,
+  version: string
+): Tree {
+  if (host.exists('package.json')) {
+    const sourceText = host.read('package.json')!.toString('utf-8');
+    const json = JSON.parse(sourceText);
+
+    if (!json.dependencies) {
+      json.dependencies = {};
+    }
+
+    if (!json.dependencies[pkg]) {
+      json.dependencies[pkg] = version;
+      json.dependencies = sortObjectByKeys(json.dependencies);
+    }
+
+    host.overwrite('package.json', JSON.stringify(json, null, 2));
+  }
+
+  return host;
+}
+
+function sortObjectByKeys(obj: any) {
+  return Object.keys(obj)
+    .sort()
+    .reduce((result: any, key) => {
+      result[key] = obj[key];
+      return result;
+    }, {});
+}

src/schematics/utils.ts

@@ -2,6 +2,9 @@
   "compilerOptions": {
     "lib": ["es2017", "dom"],
     "experimentalDecorators": true,
+    "module": "commonjs",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
     "strict": true
   }
 }