Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions .github/FUNDING.yml

This file was deleted.

117 changes: 0 additions & 117 deletions docs/firebase-versions.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/nx-firebase-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ OR
| Options | Type | Description |
| ----------------- | -------- | ------------------------------------------------------------------ |
| `name` | required | the project name for your firebase app |
| `--directory=dir` | optional | the directory this app will be located in |
| `--directory=dir` | optional | the full path where this app will be located (e.g., `apps/my-app`) |
| `--project=proj` | optional | the `--project` option that will be used for firebase CLI commands |
| `--projectNameAndRootFormat` | optional | `derived` or `as-provided` see [projectNameAndRootFormat](https://nx.dev/nx-api/node/generators/application#projectnameandrootformat) |

## About Firebase Apps

Expand Down
5 changes: 2 additions & 3 deletions docs/nx-firebase-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,11 @@ OR
| --------------------------- | ------------- | ---------------------------------------------------------- |
| `name` | required | the project name for your function |
| `--app=<app-project-name>` | required | the firebase app this function will be a dependency of |
| `--directory=dir` | optional | the directory this function will be located in |
| `--directory=dir` | optional | the full path where this function will be located (e.g., `apps/my-function`) |
| `--format=<'cjs' or 'esm'>` | default 'esm' | specify if esbuild should generated commonJs or ES6 output |
| `--runTime=<node versions>` | optional | the nodejs runtime you wish to use for this function - 14, 16, 18, 20 |
| `--runTime=<node versions>` | optional | the nodejs runtime you wish to use for this function - 18, 20, 22 |
| `--tags` | optional | tags to set on the new project |
| `--setParserOptionsProject` | optional | set the parserOptions.project in the tsconfig.json file |
| `--projectNameAndRootFormat` | optional | `derived` or `as-provided` (see Nx docs for [projectNameAndRootFormat](https://nx.dev/nx-api/node/generators/application#projectnameandrootformat)) |


## Building a Firebase function
Expand Down
9 changes: 2 additions & 7 deletions docs/nx-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ From here, you can simply `nx build` and `nx deploy` your firebase application &

## Firebase SDK versions

Which version of the Firebase CLI + SDK's you use will depend on your particular project requirements, and although generally the latest SDK's are widely compatible, you may need to experiment to find specific compatible versions:
Which version of the Firebase CLI + SDK's you use will depend on your particular project requirements, and this plugin is not opinionated to any particular Firebase SDK.

- If you are using Angular/AngularFire libraries, depending on your version of Angular
- If you are using older runtimes than Node 16
- If you are using ES modules or commonjs.
- Use of at least Node 16 functions runtime is required for this plugin

The `nx-firebase` plugin will install Firebase dependencies in the workspace if they are not already present, but it does not require, enforce or change a specific version beyond that initial setup, so you are free to `npm install` whichever versions of the firebase SDK packages you need.
The `nx-firebase` plugin app generator will install Firebase dependencies in the workspace if they are not already present, but it does not require, enforce or change a specific version beyond that initial setup, so you are free to install whichever versions of the firebase SDK packages you need.
6 changes: 0 additions & 6 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,6 @@
- [Using Nx Libraries with Firebase Functions](./nx-libraries.md)
- [Migrating an existing Firebase project to Nx](./nx-migration.md)

**Version information**

- [Firebase Versions](./firebase-versions.md)

_Note: Some of these may not always be upto date - it's hard work keeping track of external releases and compatibilities!_

**Notes**

- [Plugin Development Notes](./nx-plugin-commands.md)
Expand Down
1 change: 0 additions & 1 deletion e2e/nx-firebase-e2e/jest.globalSetup.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ const pluginPath = 'dist/packages/nx-firebase'
const workspaceLayout = {
appsDir: 'apps',
libsDir: 'libs',
projectNameAndRootFormat: 'derived',
}

module.exports = async function globalSetup() {
Expand Down