Skip to content

Latest commit

 

History

History
105 lines (67 loc) · 2.39 KB

README.md

File metadata and controls

105 lines (67 loc) · 2.39 KB

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

🌟 ava

npm run test

Linting & Formatting

Requirements:

  • StandardJs
  • Opinionated Code Formatter
  • Format files on precommit

🌟 prettier

🌟 eslint-config-prettier

npm run format
npm run lint

Format staged files only

Runs on precommit hooks by hasky package.

🌟 pretty-quick

Code coverage

Requirements: Support for common report formats

🌟 Istanbul nyc

npm run coverage
npm run coverage:html

🌟 Send coverage report with coveralls to coveralls.io

npm run coverage

Publishing

Requirements: Painless NPM publishing

🌟 np

np patch
np minor
np major

Git-Hooks

Requirements: Define hooks as npm scripts

🌟 Husky

Continuous Integration

Requirements: Free CI for OS

Maintaining consistent coding styles

🌟 Editorconfig

Ignore files

  • Use a .npmignore file to keep stuff out of your package.
  • Use .gitignore file to keep stuff out of your repository.

Badges

styled with prettier Build Status Build status Coverage Status NPM version