0.0.28 • Published 6 years ago
boilr-module v0.0.28
boilr-module
What is this?
An npm module boilerplate with good configs. Heavily inspired by nod.
Features
- Babel - Write next generation JavaScript today;
- Jest - JavaScript testing framework used by Facebook;
- ESLint - Make sure you are writing a quality code;
- Prettier - Enforces a consistent style by parsing your code and re-printing it;
- Documentation - A documentation system so good, you'll actually write documentation.
Install
git clone
this repo
$ git clone https://github.com/jforaker/boilr-module my-module
$ cd my-module
$ rm -rf .git
$ npm install # or yarn
Just make sure to edit package.json
, README.md
and LICENSE
files accordingly with your module's info.
Commands
$ npm test # run tests with Jest
$ npm run coverage # run tests with coverage and open it on browser
$ npm run lint # lint code
$ npm run docs # generate docs
$ npm run build # generate docs and transpile code
$ npm run changelog # generate CHANGELOG.MD
$ npm run watch # watch code changes and run scripts automatically
$ npm run patch # bump patch version and publish to npm e.g. 0.0.1
$ npm run minor # bump minor version and publish to npm e.g. 0.1.0
$ npm run major # bump major version and publish to npm e.g. 1.0.0
below is autogenerated by npm run docs
"docs": "documentation readme src --section=DOCS"
DOCS
Table of Contents
sayHello
This function says hello.
Parameters
name
string a name to say hello to. (optional, default'derf'
)
Returns string the greeting.
0.0.28
6 years ago
0.0.27
6 years ago
0.0.26
6 years ago
0.0.25
6 years ago
0.0.24
6 years ago
0.0.23
6 years ago
0.0.22
6 years ago
0.0.21
6 years ago
0.0.20
6 years ago
0.0.19
6 years ago
0.0.15
6 years ago
0.0.14
6 years ago
0.0.13
6 years ago
0.0.12
6 years ago
0.0.11
6 years ago
0.0.10
6 years ago
0.0.9
6 years ago
0.0.8
6 years ago
0.0.7
6 years ago
0.0.6
6 years ago
0.0.5
6 years ago