Generate node and/or browser package skeleton. Readme.md + package.json + bower.json + gulpfile.js + mocha test harness (with browser support) + jshint + jscoverage.
- Create node and/or browser packages
- Readme, package.json, and bower.json boilerplate
- Gulp task runner boilerplate
- Automatic docs and readme generation using jsdoc-to-markdown
- Test harness using mocha and chai assertions
- Browser tests using mocha-phantomjs for browser packages
- Code instrumentation task with coverage report using jscoverage
- Report test coverage to coveralls.io
- Lint code style and semantics with JSHint and JSCS
Install slush if you haven't:
npm install --global slush
Install slush-js-skeleton:
npm install --global slush-js-skeleton
mkdir myproject
cd myproject
slush js-skeleton
List available tasks.
Run tests using mocha or mocha-phantomjs for browser packages.
Generate jsdoc-to-markdown and insert into readme template.
Output test coverage to coverage.html
using jscoverage.
Send test coverage to coveralls.io.
Wrap in Universal Module Definition for distribution and save in dist
.
Generate docs and if browser package, a UMD distribution.
Lint code semantics with JSHint.
Lint code style with JSCS.
Lint code semantics and style.
Watch for file changes and run tests and jshint.
Please submit all issues and pull requests to the alexmingoia/slush-js-skeleton repository!
If you have any problem or suggestion please open an issue here.