CONTRIBUTING.md

Contributing

Prequisites

This project uses Node.js 12 to run ideally, although most recent Node.js versions should also work without issue.

This project uses Yarn to install dependencies, although you can use another package manager like npm or pnpm.

yarn install
# or  for npm
npm i
# or for pnpm
pnpm install

Note that pnpm may have issues with TypeScript due to hard links not being properly handled.

Publishing

Publishing is automatically done with semantic release. Configure semantic release in the ./.releaserc.json file.

Building

Run the build script to compile the TypeScript into the tsc_output folder.

Style

This project uses Prettier and XO.

You can run Prettier in the project with this command:

yarn run style

You can run XO with this command:

yarn run lint

Note that XO will also error if you have certain formatting errors, not just if your code has issues.

Linting

This project uses XO (which uses ESLint and some plugins internally) to perform static analysis on the TypeScript. It reports things like unused variables or not following code conventions.

yarn run lint

Note that XO will also error if you have incorrect formatting, not just if your TypeScript code has errors.

Testing

Unit tests are stored alongside regular files. Ex. the file index.ts will have a corresponding test file called index.test.ts in the same directory. You can run the tests with the test script:

yarn run test

Coverage

This will generate a coverage folder which has a breakdown of coverage of the project. The CI will upload the coverage information to CodeCov which can be viewed here.