Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 1.47 KB

DEVELOPMENT.md

File metadata and controls

68 lines (49 loc) · 1.47 KB
Raw

Development Guide

Discuss, Clone, Develop, Commit, Benefit

Tools

Structure

  • doc: API documentation based on the JSDoc in the src (generated)
  • lib: code to require and use (generated)
  • src: project source
  • task: organized Gulp tasks
  • test: organized unit tests

Main commands

# Check coding style according to StandardJS
npm run lint

# Fix coding style according to StandardJS
npm run lint:fix

# Generate the documentation from the distribution version
npm run doc

# Generate the build for distribution from the source
npm run build

# Build and run tests
npm run dev

# Nodemon command for development with all the tests
nodemon --exec npm run dev

# Nodemon command for development with one specific test
nodemon --exec npm run dev:one -- test/algorithm.test.js

# Run lint check, build lib and doc and run the unit tests
npm run test

For owners/maintainers only:

# Release and publish (default is --patch)
npm run release
npm run release -- --patch
npm run release -- --minor
npm run release -- --major

HAVE FUN!