browser-assert

Table of Contents
=================

* Assert
* Install
* Developer
* Test
* Start
* Cover
* Lint
* Clean
* Spec
* Instrument
* Readme
* License

Assert
======

> Stability: stable.

Featherwight assert function for the browser and node designed to work with browserify.

``javascript
function assert(expr, message) {
if(!Boolean(expr)) {
throw new Error(message || 'unknown assertion error');
}
}
`

Install

`
npm i browser-assert --save
`

Developer

Developer workflow is via gulp but should be executed as npm scripts to enable shell execution where necessary.

$3

Run the headless test suite using phantomjs:

`
npm test
`

To run the tests in a browser context open test/index.html or use the server npm start.

$3

Serve the test files from a web server with:

`
npm start
`

$3

Run the test suite and generate code coverage:

`
npm run cover
`

$3

Run the source tree through eslint:

`
npm run lint
`

$3

Remove generated files:

`
npm run clean
`

$3

Compile the test specifications:

`
npm run spec
`

$3

Generate instrumented code from lib in instrument:

`
npm run instrument
`

$3

Generate the project readme file (requires mdp):

`
npm run readme
``

License

Everything is MIT. Read the license if you feel inclined.

Generated by mdp(1).

[node]: http://nodejs.org
[npm]: http://www.npmjs.org
[gulp]: http://gulpjs.com
[phantomjs]: http://phantomjs.org
[browserify]: http://browserify.org
[eslint]: http://eslint.org
[mdp]: https://github.com/freeformsystems/mdp