# Sinon.JS

Standalone and test framework agnostic JavaScript test spies, stubs and mocks.

## Installation 

via [npm (node package manager)](http://github.com/isaacs/npm)

    $ sudo npm install sinon

or install via git by cloning the repository and including sinon.js 
in your project, as you would any other third party library.

Don't forget to include the parts of Sinon.JS that you want to use as well
(i.e. spy.js).

## Usage

See the [sinon project homepage](http://sinonjs.org/)

## Goals

* No global pollution
* Easy to use
* Require minimal “integration”
* Easy to embed seamlessly with any testing framework
* Easily fake any interface
* Ship with ready-to-use fakes for XMLHttpRequest, timers and more

## Develop? 

Check out [todo.org](http://github.com/cjohansen/Sinon.JS/raw/1.0.0/todo.org) in the project repository

## Running tests on Rhino

I've added a rudimentary setup for running the tests on Rhino with env.js (as
this is a fairly common test setup, Sinon should support it). The files are
located in test/rhino, but there are currently quite a few test failures. I
believe these are not all bugs - many are probably problems with the tests
running in Rhino. Run tests from the project root (load paths depend on it):

    $ java -jar js.jar -opt -1 test/rhino/run.js

# Sinon.JS

Standalone and test framework agnostic JavaScript test spies, stubs and mocks.

## Installation 

via [npm (node package manager)](http://github.com/isaacs/npm)

    $ npm install sinon

or install via git by cloning the repository and including sinon.js 
in your project, as you would any other third party library.

Don't forget to include the parts of Sinon.JS that you want to use as well
(i.e. spy.js).

## Usage

See the [sinon project homepage](http://sinonjs.org/)

## Goals

* No global pollution
* Easy to use
* Require minimal “integration”
* Easy to embed seamlessly with any testing framework
* Easily fake any interface
* Ship with ready-to-use fakes for XMLHttpRequest, timers and more

## Develop? 

Check out [todo.org](http://github.com/cjohansen/Sinon.JS/raw/1.0.0/todo.org) in the project repository

## Running tests on Rhino

I've added a rudimentary setup for running the tests on Rhino with env.js (as
this is a fairly common test setup, Sinon should support it). The files are
located in test/rhino, but there are currently quite a few test failures. I
believe these are not all bugs - many are probably problems with the tests
running in Rhino. Run tests from the project root (load paths depend on it):

    $ java -jar js.jar -opt -1 test/rhino/run.js

Remove sudo from install instructions
Remove sudo from install instructions

Sudo is not needed / recommended when installing npm modules locally.