DEV Community

Cover image for Nodejs + TypeScript Boilerplate
0xkoji
0xkoji

Posted on

Nodejs + TypeScript Boilerplate

#node #typescript

I created a repo for nodejs + typescript + eslint + prettier + husky.

This repo allows me to start nodejs project with typescript quickly. This has the following npm-scripts.

If I use yarn dev:watch, I can develop a project without converting ts to js and I don't need to run node-mon since this is using ts-node-dev. All I need to do is to use src/index.ts as an entry point.

npm-script

yarn clean

This command will clean up dist folder that is for build files(.js files)

"clean": "rimraf dist/*",
Enter fullscreen mode Exit fullscreen mode

yarn dev:watch

This commands allows run index.ts file without compile and monitor the changes on the file

"dev:watch": "ts-node-dev --respwn src/index.ts",
Enter fullscreen mode Exit fullscreen mode

yarn dev

This commands allows run index.ts file without compile

"dev": "ts-node src/index.ts",
Enter fullscreen mode Exit fullscreen mode

yarn format

This commands will format all files with the rules that are based on .eslintrc.js

"format": "prettier --write 'src/**/*.{js,ts,json}'",
Enter fullscreen mode Exit fullscreen mode

yarn lint:all

This command will lint all ts files and run tsc without generating any .js files

"lint:all": "yarn lint && yarn tscCheck",
Enter fullscreen mode Exit fullscreen mode

yarn lint:fix

This command runs lint and modify codes to fix lint errors.

"lint:fx": "eslint src/**/*.ts --fix",
Enter fullscreen mode Exit fullscreen mode

yarn lint

This command check all ts files with the rules that are based on .eslintrc.js

"lint": "eslint src/**/*.ts",
Enter fullscreen mode Exit fullscreen mode

yarn start

This command compiles ts files and run build file which is dist/index.js

"start": "tsc && node dist/index.js",
Enter fullscreen mode Exit fullscreen mode

yarn tsc

This compands ts files

"tsc": "tsc",
Enter fullscreen mode Exit fullscreen mode

yarn tscCheck

This command shows tsc compile errors if there are any issues.

"tscCheck": "tsc --noEmit"
Enter fullscreen mode Exit fullscreen mode

The repo is here.

GitHub logo koji / node-typescript-boilerplate

boilerplate for nodejs with typescript

typescript-node-boilerplate

This is a boilerplate for nodejs project with typescript.
The followings are details of this boilerplate.

blog post for this

npm-script

The commands are ordered alphabetically.

yarn clean

This command will clean up dist folder that is for build files(.js files)

"clean": "rimraf dist/*",
Enter fullscreen mode Exit fullscreen mode

yarn dev:watch

This commands allows run index.ts file without compile and monitor the changes on the file

"dev:watch": "ts-node-dev --respwn src/index.ts",
Enter fullscreen mode Exit fullscreen mode

yarn dev

This commands allows run index.ts file without compile

"dev": "ts-node src/index.ts",
Enter fullscreen mode Exit fullscreen mode

yarn format

This commands will format all files with the rules that are based on .eslintrc.js

"format": "prettier --write 'src/**/*.{js,ts,json}'",
Enter fullscreen mode Exit fullscreen mode

yarn lint:all

This command will lint all ts files and run tsc without generating any .js files

"lint:all": "yarn lint && yarn tscCheck
…
Enter fullscreen mode Exit fullscreen mode
View on GitHub

ToDo

These will be done soon 😎😎😎

Add simple api branch #1

koji avatar
koji posted on
View on GitHub

Add simple server to master branch #2

koji avatar
koji posted on
View on GitHub

Top comments (0)

Read next

eomm profile image

Master Node.js with the 5th Edition Cookbook

Manuel Spigolon -

matowang profile image

Never have unhandled Errors in TypeScript

Matthew Wang -

mauricioaires profile image

Angular 18 - Modificadores de acesso

Mauricio Aires -

trekhleb profile image

An exploration of how X's home timeline API is designed

Oleksii Trekhleb -