Skip to content

jramcast/create-js-package

Repository files navigation

Create JS package Build Status npm version

Create a JS package with es6, testing, linting, and publication tools included. Generated projects include the following features:

  • Unit testing with mocha, chai and sinon.
  • Test watcher for continous testing.
  • Test coverage with istanbul.
  • ES6 linting based on airbnb coding standard.
  • Release scripts and automatic changelog generation based on commit messages, following conventions defined in generate-changelog.

Requirements

  • Node version >= 6

Installation

Install the tool globally:

npm install -g create-js-package

Creation of a new package

Navigate to the directory where you want to scaffold the project and run the command:

mkdir my-package cd my-package/ create-js-package my-package

Available commands

The generated project will have the following commands available:

Start the app

npm start

Start the app in watch (dev) mode

npm run start:watch

Run tests and calculate coverage:

npm test

Run tests in watch (dev) mode. This allows continuous testing while developing:

npm run test:watch

Run linter (coding standard):

npm run lint

About

Create a JS package with testing, linting, and publication tools included

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published