typescript-node-boilerplate
v0.0.1
Published
This is a boilerplate for nodejs project with typescript. The followings are details of this boilerplate.
Downloads
1
Readme
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/*",
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"
Machine info I used to set up this
Here is my environmental information. Basically, this repo is using yarn
as a package manager.
$ node -v
v13.13.0
$ npm -v
6.14.4
$ yarn -v
1.22.4
$ uname -a
Darwin kojis-mac.lan1 20.0.0 Darwin Kernel Version 20.0.0: Fri Aug 14 00:25:13 PDT 2020; root:xnu-7195.40.44.151.1~4/RELEASE_X86_64 x86_64
$ sw_vers
ProductName: macOS
ProductVersion: 11.0
BuildVersion: 20A5354i
TypeScript version
$ npx tsc -V
Version 4.0.2
ESLint + Prettier
$ ./node_modules/.bin/eslint --version
v7.7.0
$ ./node_modules/.bin/prettier --version
2.1.1