JSPM

  • Created
  • Published
  • Downloads 465
  • Score
    100M100P100Q92445F
  • License MIT

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

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

NPM version Build Status License Code Style

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

Installation

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

Setup

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

To use with emulators:

  1. 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
  2. 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

Tests are currently not set up since they were causing timeouts when trying to shut down the emulator. They will be re-enabled once that is solved.

Add back

  1. Install yarn add -D concurrently wait-port ts-mocha chai mocha @types/mocha @types/expect @firebase/testing

  2. Add the npm scripts:

    "test:full": "concurrently \"npm run emulate\" \"wait-port -o silent 8080 && npm run test\"",
    "test": "ts-mocha -p ./tsconfig.json test/**/*.spec.ts --exit",

Why

firebase-tools does not have the following:

License

MIT