Overview

This repository is a project template for creating a Node.js Telegram bot using TypeScript.

Project Structure

The project structure is as follows :

├── coverage/             [gitignored] Test coverage reports
├── dist/                 [gitignored] JavaScript compiled files
│   ├── index.js          Main project file
│   ├── index.d.ts        Main type definition file
│   ├── index.js.map      Main source map file
│   └── ...
├── node_modules/         [gitignored] Node modules
├── src/                  TypeScript source files
│   ├── index.ts          Main source file
│   ├── logger.ts         Bunyan logger instanciation
│   └── ...
├── test/                 TypeScript tests files
├── .dockerignore         Files ignored during the Docker build
├── .eslintignore         Files ignored by ESLint
├── .eslintrc.json        ESLint configuration file
├── .gitignore            Files ignored by GIT
├── .npmignore            Files ignored by NPM (for publishing)
├── docker-entrypoint.sh  Entry point of the Docker image
├── Dockerfile            Dockerfile with instructions to build the Docker image
├── jest.config.js        Jest configuration file
├── package.json          Project package.json
├── README.md             README of the repo
├── tsconfig.json         TypeScript project configuration file
├── tsconfig.eslint.json  TypeScript configuraiton file for the ESLint parser
└── yarn.lock             Lock file (never remove this)

Features

TypeScript

This project uses TypeScript for source files. The project configuration is available in the /tsconfig.json file. Compiled JavaScript file are generated in the /dist directory. Type declarations and source map files generation are enabled.

Logger

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!');

Lint

This project uses an ESLint linter, along with Prettier to format the code. The ESLint rules are based on the Airbnb Eslint Config, and implements several other configs on top such as :

• @typescript-eslint/recommended
• @typescript-eslint/recommended-requiring-type-checking
• promise/recommended
• @typescript-eslint

The Jest plugin is also installed to allow Jest and ESLint to work together properly.

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

Test

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