@simondotm/nx-firebase 1.1.0 → 2.0.0-beta.0

package/README.md

@@ -1,11 +1,11 @@
 # @simondotm/nx-firebase
 
-![npm](https://img.shields.io/npm/dw/@simondotm/nx-firebase.svg)
-
-A plugin for [Nx](https://nx.dev) that provides support for Firebase projects in an Nx monorepo workspace.
+A plugin for [Nx](https://nx.dev) v16.1.1+ that provides support for Firebase projects in an Nx monorepo workspace.
 
 See [CHANGELOG](https://github.com/simondotm/nx-firebase/blob/main/CHANGELOG.md) for release notes.
 
+This plugin was completely rewritten since V2.x. For documentation of the legacy v1.x plugin version see [here](https://github.com/simondotm/nx-firebase/tree/release/v1.1.0).
+
 ## Overview
 
 Nx provides a great way to manage monorepo workflows and this plugin helps to integrate Firebase projects with Nx, by:
@@ -13,27 +13,27 @@ Nx provides a great way to manage monorepo workflows and this plugin helps to in
 1. Enabling & promoting use of shared Typescript code libraries within Firebase functions
 2. Retaining a familiar usage of all Firebase features in a way that feels integrated with Nx workflow
 3. Requiring minimal friction/setup for configuration of an Nx workspace in order to be productive with development, building & deployment of Firebase projects
-4. Supporting multiple firebase projects within an Nx workspace
+4. Supporting multiple firebase projects & apps within an Nx workspace
 
 ## Nx-Firebase Features
 
 Supports:
 
-- Typescript Firebase functions as Nx applications
 - Single or multiple Firebase projects in one Nx workspace
-- Use of shared Nx buildable libraries in Firebase functions
+- Firebase functions as Typescript Nx applications, now bundled using esbuild
+- Use of shared Nx libraries in Firebase functions
 - Nx provides automatic dependency checking for builds
-- Building & serving functions with watch mode
-- Firebase Emulators
+- Building & serving functions with watch mode & Firebase Emulators
 - Convenience Nx `getconfig` target to fetch remote firebase functions configuration variables to local `.runtimeconfig.json` file
-- Convenience Nx `deploy`, `emulate`, and `serve` targets for functions
+- Convenience Nx `deploy` , and `serve` targets for functions
 
 Additionally:
 
-- Auto generates Firebase functions `package.json` ready for no fuss deployment using the Firebase CLI
+- Auto bundles & generates Firebase functions `package.json` ready for no fuss deployment using the Firebase CLI
 - Auto generates default `firebase.json` configurations, rules and indexes for each Firebase app
 - Only very lightly opinionated about your Firebase configurations and workspace layouts; you can just use the Firebase CLI as usual
 - Keeps all of your firebase rules and indexes within your app folder, to keep your workspace root free of clutter
+- Use the plugin `sync` generator to easily manage firebase workspaces & configurations
 
 ## Further Information
 

package/executors.json

@@ -1,10 +1,2 @@
 {
-  "$schema": "http://json-schema.org/schema",
-  "executors": {
-    "build": {
-      "implementation": "./src/executors/build/build",
-      "schema": "./src/executors/build/schema.json",
-      "description": "build executor"
-    }
-  }
 }

package/generators.json

@@ -14,6 +14,17 @@
       "schema": "./src/generators/application/schema.json",
       "description": "nx-firebase application generator",
       "aliases": ["app"]
+    },
+    "function": {
+      "factory": "./src/generators/function/function",
+      "schema": "./src/generators/function/schema.json",
+      "description": "nx-firebase function generator",
+      "aliases": ["func"]
+    },
+    "sync": {
+      "factory": "./src/generators/sync/sync",
+      "schema": "./src/generators/sync/schema.json",
+      "description": "nx-firebase project sync tool"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simondotm/nx-firebase",
-  "version": "1.1.0",
+  "version": "2.0.0-beta.0",
   "description": "A Firebase plugin for Nx monorepo workspaces.",
   "author": "Simon Morris",
   "license": "MIT",
@@ -21,11 +21,14 @@
   "generators": "./generators.json",
   "executors": "./executors.json",
   "peerDependencies": {
-    "@nx/workspace": ">= 13.10.6",
-    "nx": ">= 13.10.6"
+    "@nx/workspace": ">= 16.1.1",
+    "nx": ">= 16.1.1"
   },
   "dependencies": {
-    "fs-extra": "11.1.1"
+    "@nrwl/devkit": "16.1.1",
+    "@nrwl/node": "16.1.1",
+    "@nx/esbuild": "^16.1.1",
+    "@nx/node": "^16.1.1"
   },
   "types": "./src/index.d.ts"
 }

package/src/generators/application/application.d.ts

@@ -1,8 +1,8 @@
 import { GeneratorCallback, Tree } from '@nx/devkit';
-import type { ApplicationGeneratorOptions } from './schema';
+import type { ApplicationGeneratorOptions, NormalizedOptions } from './schema';
+export declare function normalizeOptions(tree: Tree, options: ApplicationGeneratorOptions): NormalizedOptions;
 /**
- * Firebase 'functions' application generator
- * Uses the `@nx/node` application generator as a base implementation
+ * Firebase application generator
  *
  * @param tree
  * @param rawOptions

package/src/generators/application/application.js

@@ -1,15 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applicationSchematic = exports.applicationGenerator = void 0;
+exports.applicationSchematic = exports.applicationGenerator = exports.normalizeOptions = void 0;
 const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
-const node_1 = require("@nx/node");
-const init_1 = require("../init/init");
 const lib_1 = require("./lib");
-const delete_files_1 = require("./lib/delete-files");
+const utils_1 = require("../../utils");
+const init_1 = require("../init/init");
+function normalizeOptions(tree, options) {
+    const { projectName, projectRoot } = (0, utils_1.getProjectName)(tree, options.name, options.directory);
+    /**
+     * Plugin filename naming convention for firebase.json config is:
+     *  firebase config will be `firebase.json` for the first firebase app
+     *  additional apps will use `firebase.<projectname>.json`
+     *  this makes the config filename deterministic for the plugin
+     *
+     * - plugin can try `firebase.<projectname>.json` and use if exists
+     * - otherwise fallback is `firebase.json`
+     */
+    const firebaseConfigName = tree.exists('firebase.json')
+        ? `firebase.${projectName}.json`
+        : 'firebase.json';
+    // firebase config name has to be unique.
+    if (tree.exists(firebaseConfigName)) {
+        throw Error(`There is already a firebase configuration called '${firebaseConfigName}' in this workspace. Please use a different project name.`);
+    }
+    return Object.assign(Object.assign({}, options), { projectRoot,
+        projectName,
+        firebaseConfigName });
+}
+exports.normalizeOptions = normalizeOptions;
 /**
- * Firebase 'functions' application generator
- * Uses the `@nx/node` application generator as a base implementation
+ * Firebase application generator
  *
  * @param tree
  * @param rawOptions
@@ -17,21 +38,100 @@ const delete_files_1 = require("./lib/delete-files");
  */
 function applicationGenerator(tree, rawOptions) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const options = (0, lib_1.normalizeOptions)(tree, rawOptions);
-        const initTask = yield (0, init_1.initGenerator)(tree, {
-            unitTestRunner: options.unitTestRunner,
-            skipFormat: true,
+        const options = normalizeOptions(tree, rawOptions);
+        const initTask = yield (0, init_1.default)(tree, {});
+        const firebaseCliProject = options.project
+            ? ` --project=${options.project}`
+            : '';
+        const tags = [`firebase:app`, `firebase:name:${options.projectName}`];
+        if (options.tags) {
+            options.tags.split(',').map((s) => {
+                s.trim();
+                tags.push(s);
+            });
+        }
+        (0, devkit_1.addProjectConfiguration)(tree, options.projectName, {
+            root: options.projectRoot,
+            projectType: 'application',
+            targets: {
+                build: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        command: `echo Build succeeded.`,
+                    },
+                },
+                watch: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        command: `nx run-many --targets=build --projects=tag:firebase:dep:${options.projectName} --parallel=100 --watch`,
+                    },
+                },
+                lint: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        command: `nx run-many --targets=lint --projects=tag:firebase:dep:${options.projectName} --parallel=100`,
+                    },
+                },
+                test: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        command: `nx run-many --targets=test --projects=tag:firebase:dep:${options.projectName} --parallel=100`,
+                    },
+                },
+                firebase: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        command: `firebase --config=${options.firebaseConfigName}${firebaseCliProject}`,
+                    },
+                    configurations: {
+                        production: {
+                            command: `firebase --config=${options.firebaseConfigName}${firebaseCliProject}`,
+                        },
+                    },
+                },
+                killports: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        command: `kill-port --port 9099,5001,8080,9000,5000,8085,9199,9299,4000,4400,4500`,
+                    },
+                },
+                getconfig: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        command: `nx run ${options.projectName}:firebase functions:config:get > ${options.projectRoot}/.runtimeconfig.json`,
+                    },
+                },
+                emulate: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        commands: [
+                            `nx run ${options.projectName}:killports`,
+                            `nx run ${options.projectName}:firebase emulators:start --import=${options.projectRoot}/.emulators --export-on-exit`,
+                        ],
+                        parallel: false,
+                    },
+                },
+                serve: {
+                    executor: 'nx:run-commands',
+                    options: {
+                        commands: [
+                            `nx run ${options.projectName}:watch`,
+                            `nx run ${options.projectName}:emulate`,
+                        ],
+                    },
+                },
+                deploy: {
+                    executor: 'nx:run-commands',
+                    dependsOn: ['build'],
+                    options: {
+                        command: `nx run ${options.projectName}:firebase deploy`,
+                    },
+                },
+            },
+            tags,
         });
-        const nodeApplicationTask = yield (0, node_1.applicationGenerator)(tree, (0, lib_1.toNodeApplicationGeneratorOptions)(options));
-        (0, delete_files_1.deleteFiles)(tree, options);
         (0, lib_1.createFiles)(tree, options);
-        (0, lib_1.updateTsConfig)(tree, options);
-        (0, lib_1.addProject)(tree, options);
-        // ensures newly added files are formatted to match workspace style
-        if (!options.skipFormat) {
-            yield (0, devkit_1.formatFiles)(tree);
-        }
-        return (0, devkit_1.runTasksInSerial)(initTask, nodeApplicationTask);
+        return (0, devkit_1.runTasksInSerial)(initTask);
     });
 }
 exports.applicationGenerator = applicationGenerator;

package/src/generators/application/application.js.map

@@ -1 +1 @@
-{"version":3,"file":"application.js","sourceRoot":"","sources":["../../../../../../packages/nx-firebase/src/generators/application/application.ts"],"names":[],"mappings":";;;;AAEA,uCAA8E;AAC9E,mCAA2E;AAC3E,uCAA4C;AAC5C,+BAMc;AACd,qDAAgD;AAGhD;;;;;;;GAOG;AACH,SAAsB,oBAAoB,CACxC,IAAU,EACV,UAAuC;;QAEvC,MAAM,OAAO,GAAG,IAAA,sBAAgB,EAAC,IAAI,EAAE,UAAU,CAAC,CAAA;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAa,EAAC,IAAI,EAAE;YACzC,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,UAAU,EAAE,IAAI;SACjB,CAAC,CAAA;QACF,MAAM,mBAAmB,GAAG,MAAM,IAAA,2BAAwB,EACxD,IAAI,EACJ,IAAA,uCAAiC,EAAC,OAAO,CAAC,CAE3C,CAAA;QACD,IAAA,0BAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAC1B,IAAA,iBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAC1B,IAAA,oBAAc,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAC7B,IAAA,gBAAU,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAEzB,mEAAmE;QACnE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YACvB,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAA;SACxB;QAED,OAAO,IAAA,yBAAgB,EAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAA;IACxD,CAAC;CAAA;AAzBD,oDAyBC;AAED,kBAAe,oBAAoB,CAAA;AAEtB,QAAA,oBAAoB,GAAG,IAAA,2BAAkB,EAAC,oBAAoB,CAAC,CAAA"}
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../../../../../../packages/nx-firebase/src/generators/application/application.ts"],"names":[],"mappings":";;;;AAAA,uCAMmB;AAEnB,+BAAmC;AAEnC,uCAA4C;AAE5C,uCAAwC;AAExC,SAAgB,gBAAgB,CAC9B,IAAU,EACV,OAAoC;IAEpC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,IAAA,sBAAc,EACjD,IAAI,EACJ,OAAO,CAAC,IAAI,EACZ,OAAO,CAAC,SAAS,CAClB,CAAA;IAED;;;;;;;;OAQG;IACH,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;QACrD,CAAC,CAAC,YAAY,WAAW,OAAO;QAChC,CAAC,CAAC,eAAe,CAAA;IAEnB,yCAAyC;IACzC,IAAI,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE;QACnC,MAAM,KAAK,CACT,qDAAqD,kBAAkB,2DAA2D,CACnI,CAAA;KACF;IAED,uCACK,OAAO,KACV,WAAW;QACX,WAAW;QACX,kBAAkB,IACnB;AACH,CAAC;AApCD,4CAoCC;AAED;;;;;;GAMG;AACH,SAAsB,oBAAoB,CACxC,IAAU,EACV,UAAuC;;QAEvC,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAA,cAAa,EAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QAE9C,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO;YACxC,CAAC,CAAC,cAAc,OAAO,CAAC,OAAO,EAAE;YACjC,CAAC,CAAC,EAAE,CAAA;QAEN,MAAM,IAAI,GAAG,CAAC,cAAc,EAAE,iBAAiB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;QACrE,IAAI,OAAO,CAAC,IAAI,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBAChC,CAAC,CAAC,IAAI,EAAE,CAAA;gBACR,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACd,CAAC,CAAC,CAAA;SACH;QAED,IAAA,gCAAuB,EAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE;YACjD,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,uBAAuB;qBACjC;iBACF;gBACD,KAAK,EAAE;oBACL,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,2DAA2D,OAAO,CAAC,WAAW,yBAAyB;qBACjH;iBACF;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,0DAA0D,OAAO,CAAC,WAAW,iBAAiB;qBACxG;iBACF;gBACD,IAAI,EAAE;oBACJ,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,0DAA0D,OAAO,CAAC,WAAW,iBAAiB;qBACxG;iBACF;gBACD,QAAQ,EAAE;oBACR,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,qBAAqB,OAAO,CAAC,kBAAkB,GAAG,kBAAkB,EAAE;qBAChF;oBACD,cAAc,EAAE;wBACd,UAAU,EAAE;4BACV,OAAO,EAAE,qBAAqB,OAAO,CAAC,kBAAkB,GAAG,kBAAkB,EAAE;yBAChF;qBACF;iBACF;gBACD,SAAS,EAAE;oBACT,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,yEAAyE;qBACnF;iBACF;gBACD,SAAS,EAAE;oBACT,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,OAAO,EAAE,UAAU,OAAO,CAAC,WAAW,oCAAoC,OAAO,CAAC,WAAW,sBAAsB;qBACpH;iBACF;gBACD,OAAO,EAAE;oBACP,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,QAAQ,EAAE;4BACR,UAAU,OAAO,CAAC,WAAW,YAAY;4BACzC,UAAU,OAAO,CAAC,WAAW,sCAAsC,OAAO,CAAC,WAAW,8BAA8B;yBACrH;wBACD,QAAQ,EAAE,KAAK;qBAChB;iBACF;gBACD,KAAK,EAAE;oBACL,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE;wBACP,QAAQ,EAAE;4BACR,UAAU,OAAO,CAAC,WAAW,QAAQ;4BACrC,UAAU,OAAO,CAAC,WAAW,UAAU;yBACxC;qBACF;iBACF;gBACD,MAAM,EAAE;oBACN,QAAQ,EAAE,iBAAiB;oBAC3B,SAAS,EAAE,CAAC,OAAO,CAAC;oBACpB,OAAO,EAAE;wBACP,OAAO,EAAE,UAAU,OAAO,CAAC,WAAW,kBAAkB;qBACzD;iBACF;aACF;YACD,IAAI;SACL,CAAC,CAAA;QAEF,IAAA,iBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAE1B,OAAO,IAAA,yBAAgB,EAAC,QAAQ,CAAC,CAAA;IACnC,CAAC;CAAA;AAvGD,oDAuGC;AAED,kBAAe,oBAAoB,CAAA;AACtB,QAAA,oBAAoB,GAAG,IAAA,2BAAkB,EAAC,oBAAoB,CAAC,CAAA"}

package/src/generators/application/files/readme.md__tmpl__

@@ -1,4 +1,4 @@
-# <%= name %>
+# <%= projectName %>
 
 This Nx Firebase application was generated by [@simondotm/nx-firebase](https://github.com/simondotm/nx-firebase).
 
@@ -6,31 +6,34 @@ This Nx Firebase application was generated by [@simondotm/nx-firebase](https://g
 
 * `database.rules.json` - Default Firebase Realtime Database Rules
 * `firestore.indexes.json` - Default Firebase Firestore Database Rules
-* `package.json` - Default Firebase Functions package
 * `storage.rules` - Default Firebase Storage Rules
-* `src/index.ts` - Default Firebase Functions entry point
 * `public/index.ts` - Default Firebase hosting site
 
 ## Generated Workspace Root Files
 
 * `<%= firebaseAppConfig %>` - Firebase CLI Configuration for this project
 * `.firebaserc` - Default Firebase CLI Deployment Targets Configuration
-* `firebase.json` - Intentionally Empty Firebase CLI Configuration (only needed to allow Firebase CLI to run in your workspace)
 
-## Generated modules
+## Generated dependencies
 
-Nx-Firebase will add `firebase-admin` and `firebase-functions` to your workspace `package.json` at the `'latest'` version. You may wish to set these to a specific version.
+Nx-Firebase will add `firebase-tools`, `firebase-admin` and `firebase-functions` to your workspace if they do not already exist.
 
 ## Next Steps
 
-* `npm install -g firebase-tools` - Install the [Firebase CLI](https://firebase.google.com/docs/cli)
+* Read about the [Firebase CLI here](https://firebase.google.com/docs/cli)
 * `firebase login` - Authenticate the Firebase CLI
 * `firebase use --add` - Add your Firebase Project as a target to `.firebaserc`
-* You do not need to `npm install` in the app project directory, but can still add and run custom npm scripts to the app `package.json` if you wish
+* `nx g @simondotm/nx-firebase:function my-function --firebaseApp <%= projectName %>` - Add a firebase function to this project
 
+See the plugin [README](https://github.com/simondotm/nx-firebase/blob/main/README.md) for more information.
 
+## Commands
 
-See the plugin [README](https://github.com/simondotm/nx-firebase/blob/main/README.md) for more information.
+* `nx run <%= projectName %>:deploy` - Deploy this app to firebase
+* `nx run <%= projectName %>:serve` - Serve this app using the firebase emulator
+* `nx run <%= projectName %>:build` - Build all functions associated with this app
+* `nx run <%= projectName %>:test` - Test all functions associated with this app
+* `nx run <%= projectName %>:lint` - Lint all functions associated with this app
 
 
 

package/src/generators/application/files_firebase/firebase.json__tmpl__

@@ -1,13 +1,13 @@
 {
   "database": {
-    "rules": "<%= root %>/database.rules.json"
+    "rules": "<%= projectRoot %>/database.rules.json"
   },
   "firestore": {
-    "rules": "<%= root %>/firestore.rules",
-    "indexes": "<%= root %>/firestore.indexes.json"
+    "rules": "<%= projectRoot %>/firestore.rules",
+    "indexes": "<%= projectRoot %>/firestore.indexes.json"
   },    
   "hosting": {
-    "public": "<%= root %>/public",
+    "public": "<%= projectRoot %>/public",
     "ignore": [
       "firebase.json",
       "**/.*",
@@ -21,16 +21,9 @@
     ]
   },
   "storage": {
-      "rules": "<%= root %>/storage.rules"
-  },
-  "functions": {
-    "codebase": "<%= name %>",
-    "predeploy": [
-      "npx nx build <%= name %>"
-    ],
-    "runtime": "<%= firebaseNodeRuntime %>",      
-    "source": "dist/<%= root %>"
+      "rules": "<%= projectRoot %>/storage.rules"
   },
+  "functions": [],
   "emulators": {
     "auth": {
       "port": 9099

package/src/generators/application/files_workspace/{firebase.__name__.json__tmpl__ → firebase.__projectName__.json__tmpl__}

@@ -1,13 +1,13 @@
 {
   "database": {
-    "rules": "<%= root %>/database.rules.json"
+    "rules": "<%= projectRoot %>/database.rules.json"
   },
   "firestore": {
-    "rules": "<%= root %>/firestore.rules",
-    "indexes": "<%= root %>/firestore.indexes.json"
+    "rules": "<%= projectRoot %>/firestore.rules",
+    "indexes": "<%= projectRoot %>/firestore.indexes.json"
   },    
   "hosting": {
-    "public": "<%= root %>/public",
+    "public": "<%= projectRoot %>/public",
     "ignore": [
       "firebase.json",
       "**/.*",
@@ -21,16 +21,9 @@
     ]
   },
   "storage": {
-      "rules": "<%= root %>/storage.rules"
-  },
-  "functions": {
-    "codebase": "<%= name %>",
-    "predeploy": [
-      "npx nx build <%= name %>"
-    ],
-    "runtime": "<%= firebaseNodeRuntime %>",
-    "source": "dist/<%= root %>"
+      "rules": "<%= projectRoot %>/storage.rules"
   },
+  "functions": [],
   "emulators": {
     "auth": {
       "port": 9099

package/src/generators/application/lib/create-files.js

@@ -2,8 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFiles = void 0;
 const devkit_1 = require("@nx/devkit");
-const devkit_2 = require("@nx/devkit");
-const utils_1 = require("../../../utils");
 /**
  * Generate the firebase app specific files
  *
@@ -12,16 +10,11 @@ const utils_1 = require("../../../utils");
  */
 function createFiles(tree, options) {
     const firebaseAppConfig = options.firebaseConfigName;
-    const firebaseAppConfigPath = (0, devkit_2.joinPathFragments)((0, devkit_1.offsetFromRoot)(options.projectRoot), firebaseAppConfig);
     const substitutions = {
         tmpl: '',
-        name: options.projectName,
-        root: options.projectRoot,
-        firebaseAppName: options.name,
+        projectName: options.projectName,
+        projectRoot: options.projectRoot,
         firebaseAppConfig,
-        firebaseAppConfigPath,
-        firebaseNodeRuntime: utils_1.firebaseNodeRuntime,
-        firebaseNodeEngine: utils_1.firebaseNodeEngine,
     };
     // The default functions package.json & templated typescript source files are added here
     // to match the `firebase init` cli setup
@@ -30,29 +23,21 @@ function createFiles(tree, options) {
     // Rules and index files also get generated in the application folder;
     // 1. so that they dont clutter up the root workspace
     // 2. so that they are located within the nx firebase application project they relate to
-    (0, devkit_2.generateFiles)(tree, (0, devkit_2.joinPathFragments)(__dirname, '..', 'files'), options.projectRoot, substitutions);
-    // app project, so that it can be easily located with the cli command, and also enables nx workspaces
-    // to contain multiple firebase projects
-    // firebase.*.json files have to go in the root of the workspace, because firebase function deployment only allows
-    //  the deployed package for functions to exist in a sub directory from where the firebase.json config is located
-    // In principle for users that are not using the firebase functions feature, they could put this firebase.json config
-    //  inside their app folder, but it's better to have consistent behaviour for every workspace
-    // generate these firebase files in the root workspace only if they dont already exist
-    // ( since we dont want to overwrite any existing configs)
-    // create firebase config file in the root of the workspace.
-    // use `firebase.json` as the first firebase project config
-    // use `firebase.<project-name>.json` for subsequent project configs
-    if (!tree.exists('firebase.json')) {
-        (0, devkit_2.generateFiles)(tree, (0, devkit_2.joinPathFragments)(__dirname, '..', 'files_firebase'), '', substitutions);
+    (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, '..', 'files'), options.projectRoot, substitutions);
+    // The first firebase app project in a workspace will always use `firebase.json` as its config file
+    // Subsequent firebase app projects will be assigned a config file based on the project name, so `firebase.<project-name>.json`
+    if (firebaseAppConfig === 'firebase.json') {
+        //  if (!tree.exists('firebase.json')) {
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, '..', 'files_firebase'), '', substitutions);
     }
     else {
-        (0, devkit_2.generateFiles)(tree, (0, devkit_2.joinPathFragments)(__dirname, '..', 'files_workspace'), '', // SM: this is a tree path, not a file system path
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, '..', 'files_workspace'), '', // SM: this is a tree path, not a file system path
         substitutions);
     }
     // For a fresh workspace, the firebase CLI needs at least a firebase.json and an empty .firebaserc
     //  in order to use commands like 'firebase use --add'
     if (!tree.exists('.firebaserc')) {
-        (0, devkit_2.generateFiles)(tree, (0, devkit_2.joinPathFragments)(__dirname, '..', 'files_firebaserc'), '', substitutions);
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, '..', 'files_firebaserc'), '', substitutions);
     }
     // else {
     //   logger.log('✓ .firebaserc already exists in this workspace')

package/src/generators/application/lib/create-files.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-files.js","sourceRoot":"","sources":["../../../../../../../packages/nx-firebase/src/generators/application/lib/create-files.ts"],"names":[],"mappings":";;;AAAA,uCAAiD;AACjD,uCAA6D;AAC7D,0CAAwE;AAGxE;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,IAAU,EAAE,OAA0B;IAChE,MAAM,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAA;IACpD,MAAM,qBAAqB,GAAG,IAAA,0BAAiB,EAC7C,IAAA,uBAAc,EAAC,OAAO,CAAC,WAAW,CAAC,EACnC,iBAAiB,CAClB,CAAA;IAED,MAAM,aAAa,GAAG;QACpB,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,OAAO,CAAC,WAAW;QACzB,IAAI,EAAE,OAAO,CAAC,WAAW;QAEzB,eAAe,EAAE,OAAO,CAAC,IAAI;QAC7B,iBAAiB;QACjB,qBAAqB;QAErB,mBAAmB,EAAnB,2BAAmB;QACnB,kBAAkB,EAAlB,0BAAkB;KACnB,CAAA;IAED,wFAAwF;IACxF,yCAAyC;IACzC,uGAAuG;IACvG,EAAE;IACF,sEAAsE;IACtE,qDAAqD;IACrD,wFAAwF;IACxF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,EAC3C,OAAO,CAAC,WAAW,EACnB,aAAa,CACd,CAAA;IAED,qGAAqG;IACrG,wCAAwC;IACxC,kHAAkH;IAClH,iHAAiH;IACjH,qHAAqH;IACrH,6FAA6F;IAE7F,sFAAsF;IACtF,0DAA0D;IAE1D,4DAA4D;IAC5D,2DAA2D;IAC3D,oEAAoE;IACpE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;QACjC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,gBAAgB,CAAC,EACpD,EAAE,EACF,aAAa,CACd,CAAA;KACF;SAAM;QACL,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC,EACrD,EAAE,EAAE,kDAAkD;QACtD,aAAa,CACd,CAAA;KACF;IAED,kGAAkG;IAClG,sDAAsD;IACtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;QAC/B,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,kBAAkB,CAAC,EACtD,EAAE,EACF,aAAa,CACd,CAAA;KACF;IACD,SAAS;IACT,iEAAiE;IACjE,IAAI;AACN,CAAC;AA5ED,kCA4EC"}
+{"version":3,"file":"create-files.js","sourceRoot":"","sources":["../../../../../../../packages/nx-firebase/src/generators/application/lib/create-files.ts"],"names":[],"mappings":";;;AAAA,uCAAmE;AAInE;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,IAAU,EAAE,OAA0B;IAChE,MAAM,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAA;IAEpD,MAAM,aAAa,GAAG;QACpB,IAAI,EAAE,EAAE;QACR,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,iBAAiB;KAClB,CAAA;IAED,wFAAwF;IACxF,yCAAyC;IACzC,uGAAuG;IACvG,EAAE;IACF,sEAAsE;IACtE,qDAAqD;IACrD,wFAAwF;IACxF,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,EAC3C,OAAO,CAAC,WAAW,EACnB,aAAa,CACd,CAAA;IAED,mGAAmG;IACnG,+HAA+H;IAC/H,IAAI,iBAAiB,KAAK,eAAe,EAAE;QACzC,wCAAwC;QACxC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,gBAAgB,CAAC,EACpD,EAAE,EACF,aAAa,CACd,CAAA;KACF;SAAM;QACL,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC,EACrD,EAAE,EAAE,kDAAkD;QACtD,aAAa,CACd,CAAA;KACF;IAED,kGAAkG;IAClG,sDAAsD;IACtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;QAC/B,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,IAAI,EAAE,kBAAkB,CAAC,EACtD,EAAE,EACF,aAAa,CACd,CAAA;KACF;IACD,SAAS;IACT,iEAAiE;IACjE,IAAI;AACN,CAAC;AAxDD,kCAwDC"}

package/src/generators/application/lib/index.d.ts

@@ -1,4 +1 @@
 export * from './create-files';
-export * from './normalize-options';
-export * from './update-tsconfig';
-export * from './add-project';

package/src/generators/application/lib/index.js

@@ -2,7 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./create-files"), exports);
-tslib_1.__exportStar(require("./normalize-options"), exports);
-tslib_1.__exportStar(require("./update-tsconfig"), exports);
-tslib_1.__exportStar(require("./add-project"), exports);
 //# sourceMappingURL=index.js.map

package/src/generators/application/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/nx-firebase/src/generators/application/lib/index.ts"],"names":[],"mappings":";;;AAAA,yDAA8B;AAC9B,8DAAmC;AACnC,4DAAiC;AACjC,wDAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/nx-firebase/src/generators/application/lib/index.ts"],"names":[],"mappings":";;;AAAA,yDAA8B"}

package/src/generators/application/schema.d.ts

@@ -1,23 +1,15 @@
-import { Linter } from '@nx/linter'
-import { UnitTestRunner } from '../../utils/test-runners'
-
 export interface ApplicationGeneratorOptions {
   // standard @nx/node:app options
   name: string
   directory?: string
-  frontendProject?: string
-  linter?: Linter
-  skipFormat?: boolean
-  skipPackageJson?: boolean
-  standaloneConfig?: boolean
   tags?: string
-  unitTestRunner?: UnitTestRunner
-  setParserOptionsProject?: boolean
   // extra options for @simondotm/nx-firebase:app generator
   project?: string
+  // firebaseProject?: string
+  // firebaseConfig?: string
 }
 
-interface NormalizedOptions extends ApplicationGeneratorOptions {
+export interface NormalizedOptions extends ApplicationGeneratorOptions {
   projectRoot: Path
   projectName: string
   firebaseConfigName: string

package/src/generators/application/schema.json

@@ -18,51 +18,10 @@
       "description": "The directory of the new application.",
       "type": "string"
     },
-    "skipFormat": {
-      "description": "Skip formatting files.",
-      "type": "boolean",
-      "default": false
-    },
-    "skipPackageJson": {
-      "description": "Do not add dependencies to `package.json`.",
-      "type": "boolean",
-      "default": false
-    },
-    "linter": {
-      "description": "The tool to use for running lint checks.",
-      "type": "string",
-      "enum": [
-        "eslint",
-        "none"
-      ],
-      "default": "eslint"
-    },
-    "unitTestRunner": {
-      "description": "Test runner to use for unit tests.",
-      "type": "string",
-      "enum": [
-        "jest",
-        "none"
-      ],
-      "default": "jest"
-    },
     "tags": {
       "description": "Add tags to the application (used for linting).",
       "type": "string"
     },
-    "frontendProject": {
-      "description": "Frontend project that needs to access this application. This sets up proxy configuration.",
-      "type": "string"
-    },
-    "standaloneConfig": {
-      "description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
-      "type": "boolean"
-    },
-    "setParserOptionsProject": {
-      "type": "boolean",
-      "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
-      "default": false
-    },
     "project": {
       "type": "string",
       "description": "The firebase project that should be associated with this application",

package/src/generators/function/files/package.json__tmpl__

@@ -0,0 +1,19 @@
+{
+  "name": "<%= projectName %>",
+  "description": "Firebase Function, auto generated by @simondotm/nx-firebase",
+  "scripts": {
+    "test": "nx test <%= projectName %>",
+    "lint": "nx lint <%= projectName %>",
+    "build": "nx build <%= projectName %>",
+    "deploy": "nx deploy <%= projectName %>",
+  },
+  "type": "<%= moduleType %>",
+  "engines": {
+    "node": "<%= firebaseNodeEngine %>"
+  },
+  "dependencies": {
+  },
+  "devDependencies": {
+  },  
+  "private": true
+}

package/src/generators/function/files/readme.md__tmpl__

@@ -0,0 +1,31 @@
+# <%= projectName %>
+
+This Nx Firebase function was generated by [@simondotm/nx-firebase](https://github.com/simondotm/nx-firebase).
+
+## Generated Application Files
+
+* `src/main.ts` - Default Firebase Functions entry point
+
+## Generated Workspace Root Files
+
+* `<%= firebaseAppConfig %>` - Firebase CLI Configuration for this project
+* `.firebaserc` - Default Firebase CLI Deployment Targets Configuration
+* `firebase.json` - Intentionally Empty Firebase CLI Configuration (only needed to allow Firebase CLI to run in your workspace)
+
+## Generated modules
+
+Nx-Firebase will add `firebase-admin` and `firebase-functions` to your workspace `package.json` at the `'latest'` version. You may wish to set these to a specific version.
+
+## Next Steps
+
+* `npm install -g firebase-tools` - Install the [Firebase CLI](https://firebase.google.com/docs/cli)
+* `firebase login` - Authenticate the Firebase CLI
+* `firebase use --add` - Add your Firebase Project as a target to `.firebaserc`
+* You do not need to `npm install` in the app project directory, but can still add and run custom npm scripts to the app `package.json` if you wish
+
+
+
+See the plugin [README](https://github.com/simondotm/nx-firebase/blob/main/README.md) for more information.
+
+
+