mocha-standard
Version:
Integrate the JS standard to your Mocha tests
80 lines (50 loc) • 2.12 kB
Markdown
# mocha-standard
**Integrates [standard] into your mocha tests.** This allows you to enforce a "one true" JavaScript coding style in your project via Mocha tests.
----
----
[](https://travis-ci.org/rstacruz/mocha-standard/ "See test builds")
<br>
## Features
This offers a finer alternative to adding *standard* into package.json's `scripts.test` block.
* Runs in the same node process as mocha, removing maybe 500ms of startup time.
* Use `mocha --watch` to recheck for style failures. `standard` is used programatically, removing a huge overhead (around 1500ms) in re-running it repeatedly with `--watch`.
* Painlessly integrate standard into your travisci.org tests.
(Your speed gains may be a bit different from my Pentium II, of course.)
<br>
## Usage
Install it:
```sh
npm install --save-dev mocha-standard standard
```
Then add this test file to your Mocha suite:
```js
/* test/standard_test.js */
it('conforms to standard', require('mocha-standard'))
```
To configure what files to consume:
```js
var standard = require('mocha-standard')
it('conforms to standard', standard.files([ 'index.js', 'test/*.js' ]))
```
<br>
## Semicolons
To use [semistandard] instead, use:
```sh
npm install --save-dev mocha-standard semistandard
```
```js
/* test/standard_test.js */
it('conforms to standard', require('mocha-standard/semistandard'))
```
[semistandard]: https://github.com/Flet/semistandard
<br>
## Thanks
**mocha-standard** © 2015+, Rico Sta. Cruz. Released under the [MIT] License.<br>
Authored and maintained by Rico Sta. Cruz with help from contributors ([list][contributors]).
> [ricostacruz.com](http://ricostacruz.com) ·
> GitHub [@rstacruz](https://github.com/rstacruz) ·
> Twitter [@rstacruz](https://twitter.com/rstacruz)
[MIT]: http://mit-license.org/
[contributors]: http://github.com/rstacruz/mocha-standard/contributors
[standard]: https://www.npmjs.com/package/standard