Install dependencies via
npm ci
Build the project via
npm run build
Please note that this project currently supports both Javascript and Typescript.
All new commands should continue to use node
for continuity.
The migration from node
to ts-node
will be done all at once.
- When touching a file or creating a new file, ensure the file's extension is
.ts
- Complete your implementation, and ensure any relevant testing is also in TS
- Use types appropriately throughout your implementation. You may type code unrelated to your changes only as necessary
- Run
npm run build
to compile the project and ensure your new TS is valid
- Remove this information from this README
- Remove JS related artifacts from the package.json, .eslintrc, .prettierrc.ts, .mocharc.yaml
- In tsconfig.json, set
allowJs
tofalse
andstrict
totrue
- Remove the
global.d.ts
file - Search globally for '.js' to ensure all references have been removed