Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 1010 Bytes

README.md

File metadata and controls

34 lines (19 loc) · 1010 Bytes
Raw

typescript-starter

This repository has everything you need to start a typescript project.

Build

The transpiled files are created inside the dist folder. This name is defined on tsconfig.json file and to renamed it you need to change the compilerOptions.outDir property.

Build code

npm run build or yarn build

Linting

It has eslint installed and it's prepared to lint .js, .jsx, .ts, .tsx files. On each commit the lint will run and fix all the problems using the lint-staged and husky packages.

Format code

npm run lint or yarn lint

Tests

This project uses jest package and run all the files tests that matches the regex /__tests__/.*|(\.|/)(test|spec))\.tsx?$ defined on jest.config.json. Test files like .ts, .tsx are transpiled using ts-jest package.

Run tests

npm test or yarn test

Run tests with coverage

npm run test:coverage or yarn test:coverage