Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.09 KB

README.MD

File metadata and controls

31 lines (21 loc) · 1.09 KB

TypeScript NodeJS Boilerplate ESM

To use this boilerplate, either clone it using git clone, download it as ZIP or use GitHub Repository Import.

The following are configured:

  • TypeScript
  • Yarn
  • Jest
  • ESLINT
  • Custom base path starting from src/. Example: import { hi } from 'models/testfile'
  • Auto reload with nodemon and building with webpack
  • Prettier

And the following scripts:

  • build - compiles source code into JS, outputs to dist
  • test - runs tests using Jest
  • start - compiles the server, then uses node to run it from the compiled files
  • dev - runs the server in dev mode, and automatically refreshes
  • lint - runs ESLint

Motivation

Using some libraries you could be forced to migrate your tsconfig.json from commonJS to ESM. In example, chalk.

We can solve this problem in two ways:

  1. Downgrade specific library to be compatible with commonJS (use require internally)
  2. Using tsconfig-paths-webpack-plugin