This repository is template used to create basic NodeJs projects with typescript.
This project uses TypeScript for source files. The project configuration is available
in the /tsconfig.json file (/tsconfig.build.json for the build). Compiled JavaScript file are generated in the
/dist directory. Type declarations and source map files generation are enabled.
A Bunyan logger is included in this project. The logger configuration can be
edited in /src/logger/logger.ts. Code snipplet to use the logger :
import { logger } from './logger';
logger.info('Hello World!');This project uses an ESLint linter, along with Prettier to format the code. The configurations for the linting are based on my own predefined ruleset that I use everywhere. See this repository for more info.
To run a lint check, use the following command :
npm run lint
To automatically fix linting errors, run the following command :
npm run lint:fix
Jest is the testing framework used in this project. The framework is used with the ts-jest to allow the writing and execution of tests in TypeScript without compilation.
Jest will execute every test file located in the /test directory and ending with .test.ts. The coverage report is generated in the LCOV format, and located in the /coverage directory.
To run the tests, use the following command :
npm run test
To run the tests and generate a coverage report, use the following command :
npm run test:coverage