Contributing to TSDX
Thanks for your interest in TSDX! You are very welcome to contribute. If you are proposing a new feature, make sure to open an issue to make sure it is inline with the project goals.
Setup
First, remove any existing
tsdxglobal installations that may conflict.yarn global remove tsdx # or npm uninstall -g tsdxFork this repository to your own GitHub account and clone it to your local device:
git clone https://github.com/your-name/tsdx.git cd tsdxInstall the dependencies and build the TypeScript files to JavaScript:
yarn && yarn buildNote: you'll need to run
yarn buildany time you want to see your changes, or runyarn watchto leave it in watch mode.Make it so running
tsdxanywhere will run your local dev version:yarn link
To use your local version when running
yarn build/yarn start/yarn testin a TSDX project, run this in the project:yarn link tsdxYou should see a success message:
success Using linked package for "tsdx".The project will now use the locally linked version instead of a copy fromnode_modules.
Submitting a PR
Be sure to run yarn test before you make your PR to make sure you haven't broken anything.