loading...
Cover image for Nodejs + TypeScript Boilerplate

Nodejs + TypeScript Boilerplate

kojikanao profile image Koji (he/him) ・2 min read

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/*",

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",

yarn dev

This commands allows run index.ts file without compile

"dev": "ts-node src/index.ts",

yarn format

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

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

yarn lint:all

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

"lint:all": "yarn lint && yarn tscCheck",

yarn lint:fix

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

"lint:fx": "eslint src/**/*.ts --fix",

yarn lint

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

"lint": "eslint src/**/*.ts",

yarn start

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

"start": "tsc && node dist/index.js",

yarn tsc

This compands ts files

"tsc": "tsc",

yarn tscCheck

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

"tscCheck": "tsc --noEmit"

The repo is here.

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 orderd alphabetically.

yarn clean

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

"clean": "rimraf dist/*",

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",

yarn dev

This commands allows run index.ts file without compile

"dev": "ts-node src/index.ts",

yarn format

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

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

yarn lint:all

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

"lint:all": "yarn lint && yarn tscCheck
…

ToDo

These will be done soon 😎😎😎

Discussion

pic
Editor guide