npm-package-skeleton

Skeleton of a simple NPM Package with Babel and CI already configured.

Pre-configured development tools

• Babel
• ESLint
• Mocha
• Chai
• SinonJS
• Istanbul
• EditorConfig

Pre-configured CI tools

• Travis CI continuous integration platform
• NPM automatic releasing
• Codecov code coverage reporting
• Code Climate
• Gemnasium
• ESDoc

Recommended tools

• GreenKeeper

Getting started

1. Clone this repository
   <small>or alternatively: create a new one, then rebase from this one</small>
2. Replace the following occurrences
   • [ ] amercier/npm-package-skeleton → your repo slug
   • [ ] npm-package-skeleton → your project name
   • [ ] package-skeleton → your NPM package name
   • [ ] Alex Mercier → your name
   • [ ] [email protected] → your public email address
   • [ ] http://amercier.com → your website
3. Import project in CI tools:
   • [ ] Travis CI
   • [ ] Codecov
   • [ ] Code Climate
   • [ ] Gemnasium
   • [ ] ESDoc
4. Add the following environment variables in your new Travis CI project's settings:
   • [ ] NPM_AUTH_TOKEN: NPM authentication token, used for automatic NPM releasing. See documentation.
   • [ ] CODECOV_TOKEN: Codecov project's token, used for code coverage reporting to Codecov.
   • [ ] CODECLIMATE_REPO_TOKEN: CodeClimate project's token, used for code coverage reporting to CodeClimate.
5. (Optional) Enable GreenKeeper: greenkeeper enable.
6. (Optional) Add plugin-add-module-exports Babel plugin to avoid users of your packages having to use .default in ES5 style (see install documentation below).

Usage

Automatic releasing process

Note: you can try this process safely by releasing an "alpha" version. Ex: 0.1.0-alpha.2

• [ ] Update the package version in package.json (ex: 1.2.3), commit it, and push it.
• [ ] Tag the previously created commit (ex: v1.2.3), and push it (git push --tags).
• Travis build runs on tagged commit
• New package version is automatically released after tests have passed

---

Note: the content after this is the actual package documentation (to be edited after cloning).

npm-package-skeleton

My new awesome-package created using package-skeleton.

Installation

npm install --save-dev package-skeleton

Usage

ES5

var xxx = require('package-skeleton').default;

ES2015+

import xxx from 'package-skeleton';