Reusable JavaScript utilities for Node.js
Util.js is a Lerna monorepo with the following packages:
The anatomy for each package is loosely based on "Directory structure for JavaScript/Node Projects".
Use conventional commits for commit messages.
See scripts/README.md for information on the scripts used to maintain this project.
The scripts in this directory do the following:
-
Run a Docker container for development.
./dev.sh docker
-
Install and update dependencies. Use [fix] as the commit type.
./dev.sh docker-update-dockerfile
./dev.sh docker-update
./dev.sh install-globals
- used in docker/Dockerfile./dev.sh install-dev-globals
- used in docker/Dockerfile./dev.sh install
./dev.sh audit
npm audit fix && ./dev.sh install
- run if an audit finds something
-
Format and run a linter.
./dev.sh prettier
(Use [style] as the commit type.)./dev.sh eslint
prettier --write `git ls-files -m`
./dev.sh shell-format
-
Update documentation. Use [docs] as the commit type.
./dev.sh jsdoc
./dev.sh jsdoc2md
./dev.sh prettier
git commit -am "style: run prettier"
-
Test and publish.
./dev.sh clean
./dev.sh babel
./dev.sh build
- executes clean and babel./dev.sh mocha
npm run test
- executes mocha./dev.sh publish
- bumps up the version number