feat(schematics): Super charge the schematics (#2836)

Co-authored-by: Tomek Sułkowski <sulco@users.noreply.github.com>

.github/workflows/test.yml

@@ -155,8 +155,14 @@ jobs:
           yarn config set yarn-offline-mirror ~/.npm-packages-offline-cache
           yarn install --frozen-lockfile --prefer-offline --ignore-engines
       - name: Build
-        id: yarn-pack-dir
         run: yarn build
+      # Seeing some flakes on windows, skip for now
+      # https://github.com/angular/angularfire/runs/3593478229
+      # not just windows
+      # https://github.com/angular/angularfire/runs/3593535123
+      # - name: Test
+      #   if: runner.os != 'windows'
+      #   run: yarn test
 
   headless:
     runs-on: ubuntu-latest

package.json

@@ -52,22 +52,25 @@
     "@angular/platform-browser": "^12.0.0",
     "@angular/platform-browser-dynamic": "^12.0.0",
     "@angular/router": "^12.0.0",
+    "@schematics/angular": "^12.0.0",
     "firebase": "^9.0.0",
-    "firebase-admin": "^8.10.0",
+    "firebase-admin": "^9.11.1",
     "firebase-functions": "^3.6.0",
     "firebase-tools": "^9.0.0",
     "fs-extra": "^8.0.1",
     "fuzzy": "^0.1.3",
     "husky": "^4.2.5",
-    "inquirer": "^6.2.2",
     "inquirer-autocomplete-prompt": "^1.0.1",
     "jsonc-parser": "^3.0.0",
-    "open": "^7.0.3",
+    "open": "^7.0.3 || ^8.0.0",
+    "ora": "^5.3.0",
     "rxfire": "^6.0.0",
     "rxjs": "~6.6.0",
     "semver": "^7.1.3",
+    "triple-beam": "^1.3.0",
     "tslib": "^2.1.0",
     "webpack": "^5.35.0",
+    "winston": "^3.0.0",
     "zone.js": "~0.11.4"
   },
   "devDependencies": {
@@ -84,6 +87,8 @@
     "@types/node": "^12.6.2 < 12.12.42",
     "@types/request": "0.0.30",
     "@types/semver": "^7.1.0",
+    "@types/triple-beam": "^1.3.0",
+    "@types/winston": "^2.4.4",
     "codelyzer": "^6.0.0",
     "concurrently": "^2.2.0",
     "conventional-changelog-cli": "^1.2.0",

src/package.json

@@ -32,7 +32,14 @@
     "rxjs": "~6.6.0"
   },
   "dependencies": {
-    "tslib": "^2.0.0"
+    "tslib": "^2.0.0",
+    "fuzzy": "^0.1.3",
+    "inquirer-autocomplete-prompt": "^1.0.1",
+    "open": "^8.0.0",
+    "jsonc-parser": "^3.0.0",
+    "ora": "^5.3.0",
+    "winston": "^3.0.0",
+    "triple-beam": "^1.3.0"
   },
   "ngPackage": {
     "lib": {
@@ -45,7 +52,12 @@
       },
       "entryFile": "public_api.ts"
     },
-    "dest": "../dist/packages-dist"
+    "dest": "../dist/packages-dist",
+    "allowedNonPeerDependencies": [
+      "fuzzy", "inquirer-autocomplete-prompt",
+      "open", "jsonc-parser", "ora", "winston",
+      "triple-beam"
+    ]
   },
   "ng-update": {
     "migrations": "./schematics/migration.json"

src/schematics/add/index.ts

@@ -0,0 +1,34 @@
+import { chain, Rule, SchematicContext, TaskId, Tree } from '@angular-devkit/schematics';
+import { DeployOptions } from '../interfaces';
+import { addDependencies } from '../common';
+import { peerDependencies } from '../versions.json';
+import { NodePackageInstallTask, RunSchematicTask } from '@angular-devkit/schematics/tasks';
+
+const addFirebaseHostingDependencies = () => (tree: Tree, context: SchematicContext) => {
+  addDependencies(
+    tree,
+    peerDependencies,
+    context
+  );
+  return tree;
+};
+
+let npmInstallTaskId: TaskId;
+
+const npmInstall = () => (tree: Tree, context: SchematicContext) => {
+  npmInstallTaskId = context.addTask(new NodePackageInstallTask());
+  return tree;
+};
+
+const runSetup = (options: DeployOptions) => (tree: Tree, context: SchematicContext) => {
+  context.addTask(new RunSchematicTask('ng-add-setup-project', options), [npmInstallTaskId]);
+  return tree;
+};
+
+export const ngAdd = (options: DeployOptions): Rule => {
+  return chain([
+    addFirebaseHostingDependencies(),
+    npmInstall(),
+    runSetup(options),
+  ]);
+};

src/schematics/add/schema.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "angular-fire-ng-add",
+    "title": "AngularFire ng-add",
+    "type": "object",
+    "properties": {
+      "project": {
+        "type": "string",
+        "description": "The name of the project.",
+        "$default": {
+          "$source": "projectName"
+        }
+      }
+    },
+    "required": []
+  }

src/schematics/collection.json

@@ -3,11 +3,13 @@
   "schematics": {
     "ng-add": {
       "description": "Add firebase deploy schematic",
-      "factory": "./public_api#ngAdd"
+      "factory": "./add#ngAdd",
+      "schema": "./add/schema.json"
     },
     "ng-add-setup-project": {
       "description": "Setup ng deploy",
-      "factory": "./public_api#ngAddSetupProject"
+      "factory": "./setup#ngAddSetupProject",
+      "schema": "./setup/schema.json"
     }
   }
 }