Make schematic deps peers by install deps and devDeps in ngAdd

Author: jamesdaniels

src/core/collection.json

@@ -3,7 +3,11 @@
     "schematics": {
       "ng-add": {
         "description": "Add firebase deploy schematic",
-        "factory": "./schematics/index#ngDeploy"
+        "factory": "./schematics/index#ngAdd"
+      },
+      "ng-add-setup-firebase-deploy": {
+        "description": "Setup ng deploy",
+        "factory": "./schematics/index#setupNgDeploy"
       }
     }
   }

src/core/package.json

@@ -21,22 +21,20 @@
   "author": "angular,firebase",
   "license": "MIT",
   "peerDependencies": {
+    "@angular-devkit/architect": "ANGULAR_DEVKIT_ARCH_VERSION",
+    "@angular-devkit/core": "ANGULAR_VERSION",
+    "@angular-devkit/schematics": "ANGULAR_VERSION",
     "@angular/common": "ANGULAR_VERSION",
     "@angular/core": "ANGULAR_VERSION",
     "@angular/platform-browser": "ANGULAR_VERSION",
     "@angular/platform-browser-dynamic": "ANGULAR_VERSION",
     "firebase": "FIREBASE_VERSION",
-    "rxjs": "RXJS_VERSION",
-    "zone.js": "ZONEJS_VERSION"
-  },
-  "dependencies": {
-    "@angular-devkit/architect": "ANGULAR_DEVKIT_ARCH_VERSION",
-    "@angular-devkit/core": "ANGULAR_VERSION",
-    "@angular-devkit/schematics": "ANGULAR_VERSION",
     "firebase-tools": "FIREBASE_TOOLS_VERSION",
     "fuzzy": "FUZZY_VERSION",
     "inquirer": "INQUIRER_VERSION",
-    "inquirer-autocomplete-prompt": "INQUIRER_AUTOCOMPLETE_VERSION"
+    "inquirer-autocomplete-prompt": "INQUIRER_AUTOCOMPLETE_VERSION",
+    "rxjs": "RXJS_VERSION",
+    "zone.js": "ZONEJS_VERSION"
   },
   "typings": "index.d.ts"
 }

src/schematics/ng-add.ts

@@ -1,10 +1,12 @@
-import { SchematicsException, Tree } from '@angular-devkit/schematics';
+import { SchematicsException, Tree, SchematicContext } from '@angular-devkit/schematics';
+import { NodePackageInstallTask, RunSchematicTask } from '@angular-devkit/schematics/tasks';
 import { FirebaseJSON, FirebaseRc, FirebaseHostingConfig } from './interfaces';
 import { experimental, JsonParseMode, parseJson } from '@angular-devkit/core';
-import { from } from 'rxjs';
+import { from, of } from 'rxjs';
 import { map, switchMap } from 'rxjs/operators';
 import { Project } from './interfaces';
 import { listProjects, projectPrompt } from './utils';
+import { dependencies as requiredDependencyVersions, devDependencies as requiredDevDependencyVersions } from './versions';
 
 const stringifyFormatted = (obj: any) => JSON.stringify(obj, null, 2);
 
@@ -155,13 +157,36 @@ interface DeployOptions {
 
 // You don't have to export the function as default. You can also have more than one rule factory
 // per file.
-export const ngDeploy = ({ project }: DeployOptions) => (host: Tree) =>
-  from(listProjects()).pipe(
+export const setupNgDeploy = ({ project }: DeployOptions) => (host: Tree) => {
+  return from(listProjects()).pipe(
     switchMap((projects: Project[]) => projectPrompt(projects)),
-    map(({ firebaseProject }: any) => ngAdd(host, { firebaseProject, project }))
+    map(({ firebaseProject }: any) => setupFirebaseProject(host, { firebaseProject, project }))
   );
+}
+
+export const ngAdd = (options: DeployOptions) => (host: Tree, context: SchematicContext) => {
+  const packageJson = host.exists('package.json') && safeReadJSON('package.json', host);
+
+  if (packageJson === undefined) {
+    throw new SchematicsException('Could not locate package.json');
+  }
+
+  Object.keys(requiredDependencyVersions).forEach(name => {
+    packageJson.dependencies[name] = packageJson.dependencies[name] || requiredDependencyVersions[name];
+  });
+
+  Object.keys(requiredDevDependencyVersions).forEach(name => {
+    packageJson.devDependencies[name] = packageJson.devDependencies[name] || requiredDevDependencyVersions[name];
+  });
+
+  overwriteIfExists(host, 'package.json', stringifyFormatted(packageJson));
+
+  const installTaskId = context.addTask(new NodePackageInstallTask());
+
+  context.addTask(new RunSchematicTask('ng-add-setup-firebase-deploy', options), [installTaskId]);
+}
 
-export function ngAdd(tree: Tree, options: NgAddOptions) {
+export function setupFirebaseProject(tree: Tree, options: NgAddOptions) {
   const { path: workspacePath, workspace } = getWorkspace(tree);
 
   if (!options.project) {

src/schematics/utils.ts

@@ -1,24 +1,15 @@
 import { readFileSync } from "fs";
-import * as inquirer from "inquirer";
 import { FirebaseRc, Project } from "./interfaces";
 import { join } from "path";
 
-const firebase = require("firebase-tools");
-
-const fuzzy = require("fuzzy");
-
 export function listProjects() {
+  const firebase = require('firebase-tools');
   return firebase.list().catch(
     /* If list failed, then login and try again. */
     () => firebase.login().then(() => firebase.list())
   );
 }
 
-inquirer.registerPrompt(
-  "autocomplete",
-  require("inquirer-autocomplete-prompt")
-);
-
 // `fuzzy` passes either the original list of projects or an internal object
 // which contains the project as a property.
 const isProject = (elem: Project | { original: Project }): elem is Project => {
@@ -28,7 +19,7 @@ const isProject = (elem: Project | { original: Project }): elem is Project => {
 const searchProjects = (projects: Project[]) => {
   return (_: any, input: string) => {
     return Promise.resolve(
-      fuzzy
+      require('fuzzy')
         .filter(input, projects, {
           extract(el: Project) {
             return `${el.id} ${el.name} ${el.permission}`;
@@ -52,7 +43,12 @@ const searchProjects = (projects: Project[]) => {
 };
 
 export const projectPrompt = (projects: Project[]) => {
-  return (inquirer as any).prompt({
+  const inquirer = require('inquirer');
+  inquirer.registerPrompt(
+    "autocomplete",
+    require("inquirer-autocomplete-prompt")
+  );
+  return inquirer.prompt({
     type: "autocomplete",
     name: "firebaseProject",
     source: searchProjects(projects),

src/schematics/versions.ts

@@ -0,0 +1,11 @@
+export const dependencies = {
+    "firebase": "FIREBASE_VERSION"
+};
+
+export const devDependencies = {
+    "@angular-devkit/architect": "ANGULAR_DEVKIT_ARCH_VERSION",
+    "firebase-tools": "FIREBASE_TOOLS_VERSION",
+    "fuzzy": "FUZZY_VERSION",
+    "inquirer": "INQUIRER_VERSION",
+    "inquirer-autocomplete-prompt": "INQUIRER_AUTOCOMPLETE_VERSION"
+};

tools/build.js

@@ -102,7 +102,9 @@ const SRC_PKG_PATHS = {
   functions: `${process.cwd()}/src/functions/package.json`,
   storage: `${process.cwd()}/src/storage/package.json`,
   messaging: `${process.cwd()}/src/messaging/package.json`,
-  performance: `${process.cwd()}/src/performance/package.json`
+  performance: `${process.cwd()}/src/performance/package.json`,
+  schematics: `${process.cwd()}/dist/packages-dist/schematics/versions.js`,
+  "schematics-es2015": `${process.cwd()}/dist/packages-dist/schematics/es2015/versions.js`
 };
 
 const DEST_PKG_PATHS = {
@@ -116,7 +118,9 @@ const DEST_PKG_PATHS = {
   functions: `${process.cwd()}/dist/packages-dist/functions/package.json`,
   storage: `${process.cwd()}/dist/packages-dist/storage/package.json`,
   messaging: `${process.cwd()}/dist/packages-dist/messaging/package.json`,
-  performance: `${process.cwd()}/dist/packages-dist/performance/package.json`
+  performance: `${process.cwd()}/dist/packages-dist/performance/package.json`,
+  schematics: `${process.cwd()}/dist/packages-dist/schematics/versions.js`,
+  "schematics-es2015": `${process.cwd()}/dist/packages-dist/schematics/es2015/versions.js`
 };
 
 // Constants for running typescript commands
@@ -367,6 +371,8 @@ function buildLibrary(globals) {
     switchMap(() => from(copyDocs())),
     switchMap(() => from(copyNodeFixes())),
     switchMap(() => from(copySchematicFiles())),
+    switchMap(() => replaceVersionsObservable('schematics', VERSIONS)),
+    switchMap(() => replaceVersionsObservable('schematics-es2015', VERSIONS)),
     switchMap(() => replaceVersionsObservable('firebase-node', VERSIONS)),
     switchMap(() => from(createTestUmd(globals))),
     tap(() => {