Skip to content

DEVELOPING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.23 KB

DEVELOPING.md

File metadata and controls

43 lines (29 loc) · 1.23 KB

Developing

Running & testing

# Run all tests
pnpm test
# Watch mode (also generate code coverage into /coverage/ directory)
npm run test:watch

Run linter (eslint)

The linter will run over src/**/*.ts and examples/**/*.{ts,js} files.

npm run lint

Building

  • npm run build builds the final javascript, typescript declarations, and typedoc documentation into /dist/.
  • npm run build:all builds all of the above, plus the public website.
  • npm run build:typedocs only build typedoc markdown (then used for generating API pages)
npm run build

Live stuff

  • npm run build:docs:watch: this will be live except fro the API section, because it needs the typedoc to also run on changes. (Todo: find a way to refresh typedoc-generated) markdown, then rerun build:docs).

Committing

Caporal is using commitizen, meaning that when you commit, you'll be prompted to fill out any required commit fields, hence generating conventional-changelog compatible commit messages.

Please pay attention to your commit messages as they are used to generate changelog entries.