TypeScript Starter
My personal TypeScript starter template.
This project uses Node.js 12 to run.
This project uses Yarn to install dependencies, although you can use another package manager like npm or pnpm.
yarn install
# or `npm install`
# or `pnpm install`
Run the build
script to compile the TypeScript into the tsc_output
folder.
This will compile the src
and the test
directory, so be careful not to upload the whole folder as a published package.
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 TypeScript errors, not just if your formatting is incorrect.
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.
Unit tests are in the test
folder.
You can run the tests with the test
script:
yarn run test
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.