Firebase Bolt Security and Modeling Language Compiler
npm install firebase-bolt
Bolt is an experimental security and rules compiler for Firebase Realtime Database (not for Firebase Cloud Storage).
It is currently in beta. The language definition is converging, but not yet finalized. We welcome
experimentation, but ask that you hand-verify the resulting JSON output before
using with production applications.
Otherwise, we'd love to have feedback from early adopters. You can email questions
to firebase-talk@googlegroups.com using "Bolt" in the subject line, or post bugs
on our Issue Tracker.
- Guide to Using Firebase Bolt - Introduction to using Bolt.
- Firebase Security and Modeling Language - Language documentation and syntax.
You can easily install the bolt compiler using npm:
$ npm install --global firebase-bolt
Execute the Bolt compiler from the command line:
$ firebase-bolt rules.bolt
Will create a rules.json which you can then upload via the Firebase Web Console
or the Firebase command
line:
$ firebase deploy
_The firebase command line tool version 2 will also compile your Bolt file directly if you have firebase-bolt
installed and you use the .bolt file extension in the rules property of your firebase.json
configuration file._
You should have node.js and npm installed to use this repository.
Setup command line environment and build and test.
$ source tools/use
$ configure-project
$ gulp
Check JavaScript source files for required formatting conventions:
$ gulp lint
Build Bolt parser from PEG grammar:
$ gulp build
Run command line tests:
$ gulp test
More extensive tests which include running against a sandboxed Firebase app:
$ run-tests
Run browser-based tests:
$ browser-tests