Node package

Description

Install

Use npm or yarn

• npm install @swalls/node-package-template or
• yarn add @swalls/node-package-template

From sources

Clone repository with Git:

$ git clone https://github.com/DinoSoeren/node-package-template.git
$ cd node-package-template

Or download repository with ZIP:

$ curl -LO https://github.com/DinoSoeren/node-package-template/archive/master.zip
$ unzip master.zip
$ rm master.zip
$ cd node-package-template

Reinitialize Git repository:

$ rm -rf .git
$ git init

Install package dependencies:

$ npm install

Use

import packageName from '@swalls/node-package-template';

packageName();

Test

Run tests:

$ npm test

Run tests in watch mode:

$ npm run test:watch

Run tests with coverage:

$ npm run test:coverage

View coverage in browser:

$ npm run test:coverage
$ open coverage/index.html

Lint files:

$ npm run lint

Fix lint errors:

$ npm run lint:fix

Contribute

• yarn set version latest
• yarn up "*" "@*/*"
• If you use VIM, run yarn sdks vim.
• If you use Visual Studio Code, run yarn sdks vscode.

Support

This free open-source software was made with ❤️ by a real person - me! If you found this tool useful, please consider tipping any amount you feel is appropriate for the value you received. :)

• Give the dev a 💰 tip here: solarbabies.tips

License

MIT

Template created by combining:

• https://github.com/CharlesStover/node-package-template
• https://github.com/remarkablemark/npm-package-template