Home Reference Source Test Repository


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

Pre-configured development tools

Pre-configured CI tools

Getting started

  1. Clone this repository
    <small>or alternatively: create a new one, then rebase from this one</small>
  2. Set initial version (ex: 0.1.0) in package.json
  3. Replace the following occurrences
    • [ ] amercier/npm-package-skeletonyour repo slug
    • [ ] npm-package-skeletonyour project name
    • [ ] package-skeletonyour NPM package name
    • [ ] Alex Mercieryour name
    • [ ] [email protected]your public email address
    • [ ] http://amercier.comyour website
  4. Import project in CI tools:
  5. 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.
  6. (Optional) Enable GreenKeeper: greenkeeper enable.
  7. (Optional) Enable Snyk monitoring: snyk monitor.
  8. (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).
  9. Cleanup README.md by removing all documentation related to the skeleton.


Automatic releasing process

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

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


Latest Stable Version License Build Status

Dependency Status NPM Downloads Test Coverage API Documentation Code Climate


npm install --save package-skeleton



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


import xxx from 'package-skeleton';