Package Exports

firebase-tools-extra

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (firebase-tools-extra) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

firebase-tools-extra

Extra functionality for firebase-tools with support for emulators and auth through service account

Installation

npm i --save-dev firebase-tools-extra

Setup

Generate a service account from within the settings section of the Firebase console
Save the service account to serviceAccount.json within your firebase project repo (or set SERVICE_ACCOUNT environment variable)
Make sure you add serviceAccount.json to your .gitignore so it is not committed as part of your changes - THIS IS EXTREMELY IMPORTANT

To use with emulators:

Do one of the following:
- Pass the --emulator flag along with your command
- Set FIREBASE_DATABASE_EMULATOR_HOST and FIRESTORE_EMULATOR_HOST variabes to your environment
Use firebase-tools-extra the same way you would firebase-tools: firebase-extra database:get /users

Usage

firebase-tools-extra should be used the same way that firebase-tools is used - the API is as close to the same as possible:

firebase-extra database:get --limit-to-last 10 /users

Tests

To run all unit tests, run yarn test. This starts emulators, runs tests, then shuts down emulators.

Local Test Dev

Start emulators: yarn emulate
Run tests and watch for changes: yarn test:watch (NOTE: if you don't want the file watcher on use yarn test:base)

Why

firebase-tools does not have the following:

support for emulators (feature request to add this to firebase-tools)
full Firestore interactions including get, add, set, and update

License

MIT