/bolt

Bolt Compiler (Firebase Security and Modeling)
  1. TypeScript 94.0%
  2. JavaScript 5.6%
  3. HTML 0.4%
TypeScript JavaScript HTML

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit 3878aad Feb 22, 2017 @jwngr jwngr committed on GitHub Added version number to package.json (#189) 
### Description

Catapult (the internal tool we use to release Firebase JavaScript libraries) now works without the `0.0.0` version placeholder in the `package.json` file. So, we can finally add the actual version numbers back into this file.

### Code sample

N/A
Permalink
Failed to load latest commit information.
bin Fix bug expanding type expression too early. Aug 10, 2016
docs simple typo fix Jan 15, 2017
samples Fix bug expanding type expression too early. Aug 10, 2016
src Fix bug expanding type expression too early. Aug 10, 2016
tools Add --all option to compare-samples. Aug 3, 2016
typings fix simulator types Aug 1, 2016
.eslintrc Mail test restructure - async issues. Aug 23, 2015
.gitignore Don't rely on system tmp being writable - for CI. Nov 12, 2015
.travis.yml Add other node_js versions to Travis. Sep 8, 2015
AUTHORS Google OSS license requirements. Aug 12, 2015
CONTRIBUTING.md Google OSS license requirements. Aug 12, 2015
CONTRIBUTORS Google OSS license requirements. Aug 12, 2015
LICENSE Google OSS license requirements. Aug 12, 2015
README.md s/yet/but/ Mar 12, 2016
gulpfile.js Add strictNullChecks in TS 2.0 and fix errors. Aug 2, 2016
package.json Added version number to package.json (#189) Feb 22, 2017
tsconfig.json Add strictNullChecks in TS 2.0 and fix errors. Aug 2, 2016
tslint.json fix simulator types Aug 1, 2016
typings.json Checkpoint - update typings and don't allow implicit any types. Feb 26, 2016

README.md

Bolt Icon Bolt Compiler

Build Status NPM Version NPM Downloads

Bolt is an experimental security and rules compiler for Firebase. 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.

Language Definition

Using the Bolt Compiler

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

Developing with this Repo

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

Useful commands

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