README
Contributing
npm install
Tests
npm test
to run unit tests, it will stay alive and watch your files and re-run the tests on changenpm run coverage
to get code coverage generated to/coverage
Code style
In short:
- 4 spaces for indentation
- LF line breaks
- UTF-8 encoding
- Semi-colons
We use Airbnb's JavaScript style guide through JSCS.
We use eslint's recommended rules through ESLint.
Run npm run lint
to check your code before checking in.
Tools
Sublime
- To auto-fix your code according to JSCS rules you can install JSCS formatter for Sublime.
- To show ESLint and JSCS errors you can install SublimeLinter and SublimeLinter-contrib-eslint + SublimeLinter-jscs.
WebStorm
- Read here for information about code-quality tools in WebStorm.