A NodeJS TypeScript project boilerplate with settings and common toolchain in place. Good for starting a new project from scratch:
- Node v16.19.0 (LTS)
- TypeScript v4.9.x
- ESlint
- Prettier
- Editorconfig
- Nodemon
- Volta
- Jest: N/A
- Husky: N/A
- TypeDoc: N/A
- Github Actions: N/A
Use Volta to manage your toolchain. See package.json
- node
- npm
- yarn
Choose the typescript configuration for your NodeJS version.
- Extending the base configuration for Node 16: https://github.com/tsconfig/bases/blob/main/bases/node16.json.
- Adding common, recommended
tsconfig
configuration - Optimal configuration for production
Standard configuration for Nodejs + TypeScript.
npm init @eslint/config
Current settings:
✔ How would you like to use ESLint? · style
✔ What type of modules does your project use? · esm
✔ Which framework does your project use? · none
✔ Does your project use TypeScript? · Yes
✔ Where does your code run? · node
✔ How would you like to define a style for your project? · guide
✔ Which style guide do you want to follow? · standard-with-typescript
✔ What format do you want your config file to be in? · JSON
- Common .gitignore configuration for Nodejs projects https://github.com/github/gitignore/blob/main/Node.gitignore
- Common
.editorconfig
configuration https://github.com/editorconfig/editorconfig/blob/master/.editorconfig - With small amendments suggested by Prettier in https://prettier.io/docs/en/configuration.html#editorconfig