https://github.com/jramcast/create-js-package
Create a JS package with testing, linting, and publication tools included
https://github.com/jramcast/create-js-package
generator javascript watch
Last synced: 6 months ago
JSON representation
Create a JS package with testing, linting, and publication tools included
- Host: GitHub
- URL: https://github.com/jramcast/create-js-package
- Owner: jramcast
- License: mit
- Created: 2017-11-30T07:20:58.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-20T07:32:44.000Z (almost 7 years ago)
- Last Synced: 2025-05-29T15:18:09.735Z (7 months ago)
- Topics: generator, javascript, watch
- Language: JavaScript
- Size: 203 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Create JS package [](https://travis-ci.org/jramcast/create-js-package) [](https://badge.fury.io/js/create-js-package)
Create a JS package with es6, testing, linting, and publication tools included.
Generated projects include the following features:
* Unit testing with Jest, chai and sinon.
* Test watcher for continous testing.
* Test coverage checking.
* ES6 linting based on eslint and prettier.
* Release scripts and automatic changelog generation based on commit messages, following conventions defined in [generate-changelog](https://www.npmjs.com/package/generate-changelog).
## Requirements
* Node version >= 6
## Installation
Install the tool globally:
```sh
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:
```sh
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:
```sh
npm start
```
Start the app in watch (dev) mode:
```sh
npm run start:watch
```
Run tests and calculate coverage:
```sh
npm test
```
Run tests in watch (dev) mode. This allows continuous testing while developing:
```sh
npm run test:watch
```
Run linter (coding standard):
```sh
npm run lint
```
Fix linting errors:
```sh
npm run lint:fix
```