https://github.com/hemerajs/modern-node-package
Modern Stack to build server-side Node.js packages.
https://github.com/hemerajs/modern-node-package
boilerplate continuous-integration githook modern nodejs testing
Last synced: about 1 month ago
JSON representation
Modern Stack to build server-side Node.js packages.
- Host: GitHub
- URL: https://github.com/hemerajs/modern-node-package
- Owner: hemerajs
- License: mit
- Created: 2017-11-20T19:37:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-28T20:09:09.000Z (almost 7 years ago)
- Last Synced: 2025-04-12T02:32:14.550Z (about 1 month ago)
- Topics: boilerplate, continuous-integration, githook, modern, nodejs, testing
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Modern Node Package
Modern Stack to build server-side Node.js packages
# What's included?
## Testing
**Requirements:**
* Parallel tests
* Isolated tests
* Async / Await support
* Assertion counting
* Good diff reporting
* TAP reporter
* Coverage reports
:star2: [ava](https://github.com/avajs/ava)
```
npm run test
```
## Linting & Formatting
**Requirements:**
* StandardJs
* Opinionated Code Formatter
* Format files on precommit
:star2: [prettier](https://github.com/prettier/prettier)
:star2: [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier)
```
npm run format
npm run lint
```
### Format staged files only
Runs on precommit hooks by hasky package.
:star2: [pretty-quick](https://github.com/azz/pretty-quick)
## Code coverage
**Requirements:** Support for common report formats
:star2: Istanbul [nyc](https://github.com/istanbuljs/nyc)
```
npm run coverage
npm run coverage:html
```
:star2: Send coverage report with [coveralls](https://github.com/nickmerwin/node-coveralls) to [coveralls.io](https://coveralls.io)
```
npm run coverage
```
## Publishing
**Requirements:** Painless NPM publishing
:star2: [np](https://github.com/sindresorhus/np)
```
np patch
np minor
np major
```
## Git-Hooks
**Requirements:** Define hooks as npm scripts
:star2: [Husky](https://github.com/typicode/husky)
## Continuous Integration
**Requirements:** Free CI for OS
* [Travis](https://travis-ci.org/) for Unix
* [Appveyor](https://ci.appveyor.com) for Windows
## Maintaining consistent coding styles
:star2: [Editorconfig](http://editorconfig.org/)
## Ignore files
* Use a .npmignore file to keep stuff out of your package.
* Use .gitignore file to keep stuff out of your repository.
## Badges
[](#badge)
[](https://travis-ci.org//hemerajs/modern-node-package)
[](https://ci.appveyor.com/project/hemerajs/modern-node-package)
[](https://coveralls.io/github/hemerajs/modern-node-package?branch=master)
[](https://www.npmjs.com/package/modern-node-package)