jsdoc-builder

Build types and docs from jsdoc annotations.

Usage

npm install --save-dev jsdoc-builder
npm pkg set scripts.build-docs="build-jsdoc docs"
npm pkg set scripts.build-types="build-jsdoc types"
npm run build-docs
npm run build-types

Testing

Run the es module tests to test the root modules

npm run import-test

to run the same test inside the browser:

npm run browser-test

to run the same test headless in chrome:

npm run headless-browser-test

to run the same test inside docker:

npm run container-test

Run the commonjs tests against the /dist commonjs source (generated with the build-commonjs target).

npm run require-test

Development

All work is done in the .mjs files and will be transpiled on commit to commonjs and tested.

If the above tests pass, then attempt a commit which will generate .d.ts files alongside the src files and commonjs classes in dist