[](http://badge.fury.io/rb/boojs)
[](https://travis-ci.org/sotownsend/boojs)
[](https://bitdeli.com/free "Bitdeli Badge")
[](https://github.com/sotownsend/BooJS/blob/master/LICENSE)
# What is this?
**BooJS** allows you to execute javascript on the command line as if you were in a browser. It has well defined behavior that follows `unix` conventions and is built on-top of [PhantomJS](http://phantomjs.org/).
**BooJS** was purpose built for our continuous integration infrastructure at [Fittr®](http://www.fittr.com).
# Setup
```js
#Setup
gem install boojs
```
# Usage
#### SYNOPSIS
```js
boojs [-e statement] [-t timeout] [-v file] [file]
```
#### DESCRIPTION
The following options are available:
* `-e` - Pass a javascript statement to execute after the file (if a file is provided) and then immediately terminate unless `-t` is set.
* `-t` - Close the program after N seconds have passed, if an exception is raised before this, terminate immediately
* `-v` - Verify that a file contains no javascript syntax errors. Returns 0 if there are no errors.
* `-p` - Outputs the PID of the spawned sibling process as the first line of stdout. Used for unit specs.
#### EXAMPLES
Open a javascript pipe that reads from stdin, writes via console.log to stdout, prints exceptions via stderr, and exits with a return code of 1 if there are errors.
```js
(sh)>boojs
console.log("Hello world!"); //Output to $stdout
console.error("Goodbye cruel world!"); //Output to $stderr
```
Same as `boojs` but read the javascript file before reading from stdin. (i.e. preload a javascript file into your environment)
```js
(sh)>boojs jquery.js
$("body").html("Hello
");
console.log($("body").html())
```
Execute a javascript statement, and then immediately exit. Exceptions will return 1.
```js
(sh)>boojs -e "console.log(document);"
```
Execute a javascript statement, and then wait 4 seconds before exiting. Exceptions will return 1 and end execution early.
```js
(sh)>boojs -e "console.log(document);" -t 4
```
Verify that a file contains no javascript runtime initialization errors
```js
(sh)>boojs -v code.js
(sh)>echo $?
0
```
#### NOTES
* Calling `booPing()` will immediately return `"pong"` to `stdout`. You may use this to know when boo has started up fully.
* `console.error(msg)` will output to `$stderr`. `console.log(msg)` will output to `$stdout`.
## Requirements
- Ruby 2.1 or Higher
## Communication
- If you **found a bug**, submit a pull request.
- If you **have a feature request**, submit a pull request.
- If you **want to contribute**, submit a pull request.
---
## FAQ & Rants
### Wait, isn't this just NodeJS?
No, they are for different things. BooJS gives you the full DOM, you can call `document` in BooJS and import arbitrary browser javascript libraries.
### ...But PhantomJS has a perfectly good REPL, kids these days...
There are a myriad issues with the *PhantomJS repl*; most notably, the *PhantomJS repl*:
* Outputs special format characters even when not attached to a `tty`
* Does not have well defined behavior which makes it a nightmare to integrate with
* **Has no support for asynchronous stdin**
* Does not output `console.error` to `stderr`
* Changes what it considers a newline based on the attached terminal (A QT quirk)
* Is not a unix tool in any sense
I don't think any of this is the `PhantomJS`'s team fault; it's just not their focus or target.
### When should I use boojs?
When you need to test javascript code that needs to run in a browser but don't necessarily need to test the UI components.
### What's Fittr?
Fittr is a SaaS company that focuses on providing personalized workouts and health information to individuals and corporations through phenomenal interfaces and algorithmic data-collection and processing.
* * *
### Creator
- [Seo Townsend](http://github.com/sotownsend) ([@seotownsend](https://twitter.com/seotownsend))
## License
boojs is released under the MIT license. See LICENSE for details.