Updated on March 22, 2023
Excellent guidance for writing jsdoc documentation:
Use jsdoc at the command line to generate on-line documentation:
npx jsdoc src -r --destination docs --readme ./README.md --package ./package.json
Use npm version at the command line while in your package directory. This must
be done after git committing all code changes.
npm version a.b.c
# or
npm version patch
Using VSCode, you can do interactive testing by loading a file with javascript commands, setting breakpoints and then starting the debugger. Be sure to select "Run Current File" before hitting the "Start Debugging" button.
For ES 6 modules, uvu is the recommended test framework.
Install uvu as a dev dependency:
npm install uvu --save-dev
The package.json must be modified so that it has:
"scripts": {
"test": "uvu"
},
With Uvu, you can write scripts with the normal ESM import statements. See the https://github.com/MazamaScience/air-monitor-algorithms project for examples.