This project contains random small code snippets that don't really need full project of their own, notes, and anything that could be useful for something someday.
https://help.github.com/en/articles/basic-writing-and-formatting-syntax
- Node.js (v23.5.0) and npm https://nodejs.org/
npm install
node src/[whatever file you want to run]
npm run lint:fix
npm run build:doc
- Runs both apidoc and jsdoc. Make sure they are installed before running.
npm run build:doc:apidoc
- outputs to docs/apidoc
- https://www.npmjs.com/package/apidoc
- http://apidocjs.com/
npm run build:doc:jsdoc
- outputs to docs/jsdoc
- https://www.npmjs.com/package/jsdoc
- https://jsdoc.app/
Use one of release:xxx:xxx scripts to do to update version on the main branch (via npm version). It will also create a new commit and a tag, then automatically git push-es them to the origin.
For more info:
- https://semver.org/
- https://en.wikipedia.org/wiki/Software_release_life_cycle
- https://docs.npmjs.com/cli/v11/commands/npm-version
# bump up release type version, and mark as beta
npm run release:beta:patch
# bump up beta/rc build number only
npm run release:beta
npm run release:rc
# bump up release type version for final release
npm run release:minor