DEVELOPING.md

Pre-requisites

1. We typically use the active NodeJS LTS. If you need to work with multiple versions of Node, you might consider using nvm.
2. This repository uses yarn to manage node dependencies. Please install yarn globally using npm install --global yarn.

Typical workflow

You would only do this once after you cloned the repository.

1. Clone this repository from git.
2. cd into source-tracking.
3. We develop using feature brances off main and release from the main branch. At this point, you should do initiate a git checkout -t origin/main.
4. yarn to bring in all the top-level dependencies.
5. Open the project in your editor of choice.

When you are ready to commit

1. We enforce commit message format. We recommend using commitizen by installing it with yarn global add commitizen then commit using git cz which will prompt you questions to format the commit message.
2. Before commit and push, husky will run several hooks to ensure the message and that everything lints and compiles properly.

List of Useful commands

yarn compile

This compiles the typescript to javascript.

yarn clean

This cleans all generated files and directories. Run yarn clean-all to also clean up the node_module directories.

yarn test

This tests the typescript using ts-node.

yarn lint

This lints all the typescript. If there are no errors/warnings from eslint, then you get clean output.

yarn test:nuts:local

real tests on real local fs, including some scale and perf tests.

npx knip

makes sure that you're not introducing unnecessary exports or leaving dead code

unused exports might be used for tests but not by other code