Skip to content

Commit 3add585

Browse files
author
jwngr
committed
Added gulp, Travis, a test framework, and made it Catapult-enabled
1 parent ca970a1 commit 3add585

15 files changed

+223
-214
lines changed

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
node_modules
1+
coverage/
2+
node_modules/
3+
24
.DS_Store
35
.idea
46
*.iml

‎.travis.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
language: node_js
2+
node_js:
3+
- '0.10'
4+
install:
5+
- npm install
6+
script:
7+
- npm run travis
8+
after_script:
9+
- cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js

‎CHANGELOG.md

-39
This file was deleted.

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 Firebase
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+15-57
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,43 @@
11
# firebase-tools
22

3+
[![Build Status](https://travis-ci.org/firebase/firebase-tools.svg?branch=master)](https://travis-ci.org/firebase/firebase-tools)
4+
[![Coverage Status](https://img.shields.io/coveralls/firebase/firebase-tools.svg)](https://coveralls.io/r/firebase/firebase-tools)
35
[![NPM version](https://badge.fury.io/js/firebase-tools.svg)](http://badge.fury.io/js/firebase-tools)
46

57
These are the Firebase Command Line (CLI) Tools. They can be used to:
68

79
* Administer your Firebase account
8-
* Interact with [Firebase Hosting](https://www.firebase.com/hosting.html), our product to host your HTML, JS, CSS, images, etc.
10+
* Interact with [Firebase Hosting](https://www.firebase.com/hosting.html), our product to host your
11+
static HTML, JS, CSS, images, etc.
912

1013
To get started with the Firebase CLI, [read through our hosting quickstart guide](https://www.firebase.com/docs/hosting.html).
1114

15+
1216
## Installation
1317

1418
To install the Firebase CLI, you first need to [sign up for a Firebase account](https://www.firebase.com/signup/).
15-
Then you need to install [Node.js](http://nodejs.org/) and [npm](https://npmjs.org/).
16-
Note that installing Node.js should install npm as well.
1719

18-
Once npm is installed, get the Firebase CLI by running the following shell command:
20+
Then you need to install [Node.js](http://nodejs.org/) and [npm](https://npmjs.org/). Note that
21+
installing Node.js should install npm as well.
22+
23+
Once npm is installed, get the Firebase CLI by running the following command:
1924

20-
```shell
25+
```bash
2126
npm install -g firebase-tools
2227
```
2328

2429
This will provide you with the globally accessible `firebase` command.
2530

26-
## Commands
27-
28-
The command `firebase --help` lists the available commands and
29-
`firebase <command> --help` shows more details for an individual command.
30-
31-
Here is the output of running `firebase --help`:
32-
33-
```shell
34-
Usage: firebase <command>
35-
36-
Available commands are:
37-
38-
bootstrap
39-
Creates a new Firebase powered app from a prebuilt template to quickly
40-
get a project up and running. This creates a new folder and prompts
41-
you through all the required settings.
42-
43-
deploy
44-
Deploys the current app to Firebase Hosting and creates your subdomain on
45-
firebaseapp.com if it doesn't exist already.
4631

47-
init
48-
Initializes an existing Firebase app in the current directory and prompts
49-
you through configuring it for firebaseapp.com.
50-
51-
open
52-
Opens the URL of the current Firebase app in a browser.
53-
54-
list
55-
Lists the Firebases available to the currently logged in user.
56-
57-
delete-site
58-
Deletes the current app from Firebase Hosting and displays a
59-
'Site not Found' page as if the site had never been deployed to.
60-
61-
login
62-
Logs the user into Firebase. All commands that require login will prompt
63-
you if you're not currently logged in.
64-
65-
logout
66-
Logs the user out of Firebase.
32+
## Commands
6733

68-
-h, --help
69-
Shows this help screen. Use `firebase <command> --help` for more
70-
detailed help instructions.
34+
The command `firebase --help` lists the available commands and `firebase <command> --help` shows
35+
more details for an individual command.
7136

72-
-v, --version
73-
Displays the current version.
37+
You can get more information about the available commands in our
38+
[command line documentation](https://www.firebase.com/docs/hosting/command-line-tool.html).
7439

75-
-s, --silent
76-
Silent mode for scripting - commands will error with non-zero status code
77-
instead of waiting for prompt if not enough information supplied.
78-
```
7940

8041
## Credit
8142

8243
Inspired by [Luke Vivier](https://github.com/lvivier/)'s Firebase command line tools.
83-
84-
## License
85-
[MIT](http://firebase.mit-license.org)

‎changelog.txt

Whitespace-only changes.

‎gulpfile.js

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/**************/
2+
/* REQUIRES */
3+
/**************/
4+
var gulp = require('gulp');
5+
6+
// File I/O
7+
var exit = require('gulp-exit');
8+
var jshint = require('gulp-jshint');
9+
10+
// Testing
11+
var mocha = require('gulp-mocha');
12+
var istanbul = require('gulp-istanbul');
13+
14+
15+
/****************/
16+
/* FILE PATHS */
17+
/****************/
18+
var paths = {
19+
js: [
20+
'lib/*.js'
21+
],
22+
23+
tests: [
24+
'test/*.spec.js'
25+
]
26+
};
27+
28+
29+
/***********/
30+
/* TASKS */
31+
/***********/
32+
// Lints the JavaScript files
33+
gulp.task('lint', function() {
34+
return gulp.src(paths.js)
35+
.pipe(jshint())
36+
.pipe(jshint.reporter('jshint-stylish'))
37+
.pipe(jshint.reporter('fail'))
38+
.on('error', function(error) {
39+
throw error;
40+
});
41+
});
42+
43+
// Runs the Mocha test suite
44+
gulp.task('test', function() {
45+
return gulp.src(paths.js)
46+
.pipe(istanbul())
47+
.pipe(istanbul.hookRequire())
48+
.on('finish', function () {
49+
gulp.src(paths.tests)
50+
.pipe(mocha({
51+
reporter: 'spec',
52+
timeout: 5000
53+
}))
54+
.pipe(istanbul.writeReports())
55+
.pipe(exit());
56+
});
57+
});
58+
59+
// Reruns the linter every time a JavaScript file changes
60+
gulp.task('watch', function() {
61+
gulp.watch(paths.js, ['lint']);
62+
});
63+
64+
// Default task
65+
gulp.task('default', ['lint', 'test']);

‎package.json

+50-31
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,48 @@
11
{
22
"name": "firebase-tools",
3-
"preferGlobal": true,
4-
"version": "1.1.4",
5-
"description": "The Firebase Command Line Tools",
3+
"description": "Firebase command line tools",
4+
"version": "0.0.0",
5+
"author": "Firebase <[email protected]> (https://www.firebase.com/)",
6+
"homepage": "https://github.com/firebase/firebase-tools/",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/firebase/firebase-tools.git"
10+
},
11+
"bugs": {
12+
"url": "https://github.com/firebase/firebase-tools/issues"
13+
},
14+
"licenses": [
15+
{
16+
"type": "MIT",
17+
"url": "http://firebase.mit-license.org/"
18+
}
19+
],
620
"keywords": [
7-
"firebase",
8-
"hosting",
9-
"ssl",
1021
"cdn",
1122
"cli",
12-
"synchronization",
13-
"real-time",
23+
"ssl",
24+
"cloud",
25+
"hosting",
26+
"firebase",
27+
"realtime",
1428
"websockets",
15-
"cloud"
29+
"synchronization"
1630
],
17-
"author": "Firebase <[email protected]>",
18-
"contributors": [
19-
{
20-
"name": "Chris Raynor",
21-
"email": "[email protected]"
22-
},
23-
{
24-
"name": "Adam Putinski",
25-
"email": "[email protected]"
26-
},
27-
{
28-
"name": "Rob DiMarco",
29-
"email": "[email protected]"
30-
}
31+
"preferGlobal": true,
32+
"bin": {
33+
"firebase": "./bin/firebase"
34+
},
35+
"engines": {
36+
"node": ">=0.10.0"
37+
},
38+
"engineStrict": true,
39+
"files": [
40+
"bin/**",
41+
"lib/**",
42+
"LICENSE",
43+
"README.md",
44+
"package.json"
3145
],
32-
"repository": "https://github.com/firebase/firebase-tools.git",
33-
"homepage": "https://github.com/firebase/firebase-tools",
3446
"dependencies": {
3547
"optimist": "0.6.x",
3648
"prompt": "0.2.x",
@@ -44,11 +56,18 @@
4456
"when": "3.1.0",
4557
"chalk": "~0.4.0"
4658
},
47-
"bin": {
48-
"firebase": "./bin/firebase"
49-
},
50-
"engines": {
51-
"node": ">=0.10.0"
59+
"devDependencies": {
60+
"chai": "^1.10.0",
61+
"coveralls": "2.11.2",
62+
"gulp": "3.8.10",
63+
"gulp-exit": "0.0.2",
64+
"gulp-istanbul": "0.5.0",
65+
"gulp-jshint": "1.9.0",
66+
"gulp-mocha": "2.0.0",
67+
"jshint-stylish": "1.0.0"
5268
},
53-
"engineStrict": true
69+
"scripts": {
70+
"test": "gulp test",
71+
"travis": "gulp"
72+
}
5473
}

0 commit comments

Comments
 (0)