Build: Configure TypeScript for Node.js ESM and a Library

0/1 steps

✓📚 Read

✓👁 See

✓🎞 Animate

✓🎯 Test

5⚙️ Build

Build Steps

Progress

0/1

◆ Before you start

Prerequisites

TypeScript 5+Required
npm install -D typescript

⚙️

Step 1 of 1

Configure TypeScript for Node.js ESM and a Library

Set up a production tsconfig.json for a Node.js ESM API and a library package.

Tasks

Create tsconfig.json for Node.js 20 ESM

Enable strict, noUncheckedIndexedAccess

Add @/ path alias

Run tsc --noEmit to validate

🎯 What You'll Learn

▸Set target, module, moduleResolution correctly for Node ESM
▸Enable all strict checks
▸Configure path aliases and declaration output

Code

JSONtsconfig.json
1 {
2   "compilerOptions": {
3     "target": "ES2022",
4     "module": "NodeNext",
5     "moduleResolution": "NodeNext",
6     "lib": ["ES2022"],
7  
8     "strict": true,
9     "noUncheckedIndexedAccess": true,
10     "exactOptionalPropertyTypes": true,
11     "noImplicitReturns": true,
12     "noFallthroughCasesInSwitch": true,
13  
14     "outDir": "./dist",
15     "rootDir": "./src",
16     "declaration": true,
17     "declarationMap": true,
18     "sourceMap": true,
19  
20     "baseUrl": ".",
21     "paths": {
22       "@/*": ["src/*"]
23     },
24  
25     "incremental": true,
26     "skipLibCheck": true
27   },
28   "include": ["src/**/*"],
29   "exclude": ["node_modules", "dist", "**/*.test.ts"]
30 }

💡 Pro Tips

▸module: NodeNext + moduleResolution: NodeNext for modern Node.js
▸declaration: true is required for publishable packages

Expected Output

tsc --noEmit succeeds; path aliases resolve; strict catches implicit any

Discussion

1 { 2 "compilerOptions": { 3 "target": "ES2022", 4 "module": "NodeNext", 5 "moduleResolution": "NodeNext", 6 "lib": ["ES2022"], 7 8 "strict": true, 9 "noUncheckedIndexedAccess": true, 10 "exactOptionalPropertyTypes": true, 11 "noImplicitReturns": true, 12 "noFallthroughCasesInSwitch": true, 13 14 "outDir": "./dist", 15 "rootDir": "./src", 16 "declaration": true, 17 "declarationMap": true, 18 "sourceMap": true, 19 20 "baseUrl": ".", 21 "paths": { 22 "@/*": ["src/*"] 23 }, 24 25 "incremental": true, 26 "skipLibCheck": true 27 }, 28 "include": ["src/**/*"], 29 "exclude": ["node_modules", "dist", "**/*.test.ts"] 30 }

1	{
2	"compilerOptions": {
3	"target": "ES2022",
4	"module": "NodeNext",
5	"moduleResolution": "NodeNext",
6	"lib": ["ES2022"],
7
8	"strict": true,
9	"noUncheckedIndexedAccess": true,
10	"exactOptionalPropertyTypes": true,
11	"noImplicitReturns": true,
12	"noFallthroughCasesInSwitch": true,
13
14	"outDir": "./dist",
15	"rootDir": "./src",
16	"declaration": true,
17	"declarationMap": true,
18	"sourceMap": true,
19
20	"baseUrl": ".",
21	"paths": {
22	"@/": ["src/"]
23	},
24
25	"incremental": true,
26	"skipLibCheck": true
27	},
28	"include": ["src/*/"],
29	"exclude": ["node_modules", "dist", "*/.test.ts"]
30	}