jsskel

jsskel copied to clipboard

A skeleton JavaScript project using a common toolset

Features

• eslint is used to keep code clean
• tap is used for testing and code coverage
• retire is used to check for vulnerable modules
• documentation.js is used to generate documentation

Usage

git clone https://github.com/mapbox/jsskel.git
mv jsskel <project name>
cd <project name>
npm init
# Fill in the details
git remote set-url origin <your project URL>

The following npm scripts are provided by package.json:

• npm run retire: Check for vulnerable modules (run automatically as part of npm test)
• npm run lint: Run linting (run automatically as part of npm test)
• npm run docs-page: Generate documentation from JSDoc comments. You should check in the resulting output, which is set up assuming you'll be publishing to GitHub pages.
• npm run docs-readme: Generate documentation from JSDoc comments, and inject them into the README (this file), replacing the ## API section.

Feel free to adjust any of the defaults to taste after creating a new module.

API

Document the module's API here