CONTRIBUTING.md

cwd	runme
./	id version 01HF7GMQ6PE0NNKN60P50JEZ17 v2.2

Contributing

This project maintains the following workflows and Tasks. You can start contributing by cloning the code base, either manually or by clicking on:

Then install it's dependencies via:

npm ci

Workflows

Build Project

To build the project, run:

./node_modules/.bin/runme run clean compile

Test Project

To run the entire test pipeline, call:

./node_modules/.bin/runme run test:lint test:unit test:cjs

This will run Eslint checks:

npx eslint src tests

unit tests via Vitest:

npx vitest --config ./vitest.config.ts --retry=3 --threads=false

Update snapshots used in tests if necesary:

npx vitest --config ./vitest.config.ts -u

and verifies that the package can be imported in a CJS environment:

npx ts-node ./cjs.test.ts

Watch Files

To have the source files automatically re-compiled after changing, run:

npx tsc -p ./tsconfig.json --watch

Tasks

Workflows consist of the following individual tasks:

Clean Project

Remove build files and other log artifacts:

npx rimraf dist coverage ./.bin

Compile

To compile source files via TypeScript, run:

npx tsc -p ./tsconfig.json
cp ./src/cjs/package.json ./dist/cjs