Node + TypeScript

gistfile.md

Node + TypeScript

1. Initial setup

mkdir typescript-starter
cd typescript-starter

2. Setup Node.js package.json

npm init -y

3. Add TypeScript as a dev dependency

npm install typescript --save-dev

4. Install ambient Node.js types for TypeScript

npm install @types/node --save-dev

5. Create a tsconfig.json.

npx tsc --init --rootDir src --outDir build \
--esModuleInterop --resolveJsonModule --lib es6 \
--module commonjs --allowJs true --noImplicitAny true

{
  "compilerOptions": {
    "target": "es5",                          
    "module": "commonjs",                    
    "lib": ["es6"],                     
    "allowJs": true,
    "outDir": "build",                          
    "rootDir": "src",
    "strict": true,         
    "noImplicitAny": true,
    "esModuleInterop": true,
    "resolveJsonModule": true
  }
}

6. Create the src folder and create our first TypeScript file

mkdir src
touch src/index.ts

7. Create the src folder and create our first TypeScript file

mkdir src
touch src/index.ts

Useful configurations & scripts

Cold reloading

npm install --save-dev ts-node nodemon

Add a nodemon.json config.

{
  "watch": ["src"],
  "ext": ".ts,.js",
  "ignore": [],
  "exec": "npx ts-node ./src/index.ts"
}

package.json
"start:dev": "npx nodemon",

Creating production builds

npm install --save-dev rimraf

"build": "rimraf ./build && tsc",

Production startup script

package.json
"start": "npm run build && node build/index.js"