构建 TypeScript + Node.js 项目模板

2024年10月27日

docs.gab.moe

逐步教程

准备项目目录

创建并进入项目目录：
终端窗口
```
1
mkdir my-project && cd my-project
```
初始化项目目录：
- npm
- yarn
- pnpm
终端窗口
1 npm init -y
终端窗口
1 yarn init -y
终端窗口
1 pnpm init

安装并配置 TypeScript

安装 TypeScript：

1
npm i -D typescript

1
yarn add -D typescript

1
pnpm add -D typescript

创建源代码文件夹与测试代码：

1
mkdir src && echo 'console.log("Hello, TypeScript!")' > src/index.ts

创建 tsconfig.json 文件：

1
npx tsc --init

1
yarn tsc --init

1
pnpm tsc --init

修改或重写 tsconfig.json 文件：

修改
重写

1
{
2
    "compilerOptions": {
25 collapsed lines
3
    /* Visit https://aka.ms/tsconfig to read more about this file */
4

5
    /* Projects */
6
    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7
    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
8
    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
9
    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
10
    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
11
    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
12

13
    /* Language and Environment */
14
    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15
    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16
    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
17
    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
18
    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
19
    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
20
    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21
    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
22
    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
23
    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
24
    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
25
    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
26

27
    /* Modules */
28
     "module": "commonjs",                                /* Specify what module code is generated. */
29
     "module": "NodeNext",                                /* Specify what module code is generated. */
30
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
31
     "rootDir": "./src",                                  /* Specify the root folder within your source files. */
30 collapsed lines
32
    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
33
    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
34
    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
35
    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
36
    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
37
    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
38
    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
39
    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
40
    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
41
    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
42
    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
43
    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
44
    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
45
    // "resolveJsonModule": true,                        /* Enable importing .json files. */
46
    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
47
    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
48

49
    /* JavaScript Support */
50
    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
51
    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
52
    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
53

54
    /* Emit */
55
    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
56
    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
57
    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
58
    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
59
    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
60
    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
61
    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
62
     // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
63
     "outDir": "./dist",                                  /* Specify an output folder for all emitted files. */
25 collapsed lines
64
    // "removeComments": true,                           /* Disable emitting comments. */
65
    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
66
    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
67
    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
68
    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
69
    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
70
    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
71
    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
72
    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
73
    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
74
    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
75
    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
76
    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
77

78
    /* Interop Constraints */
79
    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
80
    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
81
    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
82
    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
83
    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
84
    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
85
    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
86

87
    /* Type Checking */
88
    "strict": true,                                      /* Enable all strict type-checking options. */
89
     // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
90
     "noImplicitAny": true,                               /* Enable error reporting for expressions and declarations with an implied 'any' type. */
23 collapsed lines
91
    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
92
    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
93
    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
94
    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
95
    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
96
    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
97
    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
98
    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
99
    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
100
    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
101
    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
102
    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
103
    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
104
    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
105
    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
106
    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
107
    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
108
    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
109

110
    /* Completeness */
111
    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
112
    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
113
    },
114
   "include": ["./src/**/*"]
115
}

1
{
2
    "compilerOptions": {
3
        "target": "ES2016",
4
        "module": "NodeNext",
5
        "outDir": "./dist",
6
        "rootDir": "./src",
7
        "noImplicitAny": true
8
    },
9
    "include": ["./src/**/*"]
10
}

修改并测试构建与运行

添加 build 和 start 脚本到 package.json 文件：

1
{
4 collapsed lines
2
  "name": "my-project",
3
  "version": "1.0.0",
4
  "description": "",
5
  "main": "index.js",
6
  "scripts": {
7
    "test": "echo \"Error: no test specified\" && exit 1",
8
    "build": "tsc --build",
9
    "start": "node ./dist/index.js"
10
  },
6 collapsed lines
11
  "keywords": [],
12
  "author": "",
13
  "license": "ISC",
14
  "devDependencies": {
15
    "typescript": "^5.6.3"
16
  }
17
}

测试构建项目：

1
npm run build

1
yarn run build

1
pnpm run build

1
> my-project@1.0.0 build /home/gabrielxd/codes/my-project
2
> tsc --build

测试运行项目：

1
npm run start

1
yarn run start

1
pnpm run start

1
> my-project@1.0.0 start /home/gabrielxd/codes/my-project
2
> node ./dist/index.js
3

4
Hello, TypeScript!

安装 Node.js 类型定义
- npm
- yarn
- pnpm
终端窗口
1 npm i -D @types/node
终端窗口
1 yarn add -D @types/node
终端窗口
1 pnpm add -D @types/node
- Before
- After

配置监测并自动重启开发服务器 Optional

安装 ts-node：

1
npm i -D ts-node

1
yarn add -D ts-node

1
pnpm add -D ts-node

安装 nodemon：

1
npm i -D nodemon

1
yarn add -D nodemon

1
pnpm add -D nodemon

添加 dev 脚本到 package.json 文件：

1
{
4 collapsed lines
2
    "name": "my-project",
3
    "version": "1.0.0",
4
    "description": "",
5
    "main": "index.js",
6
    "scripts": {
7
        "test": "echo \"Error: no test specified\" && exit 1",
8
        "build": "tsc --build",
9
        "start": "node ./dist/index.js",
10
        "dev": "nodemon src/index.ts"
11
    },
9 collapsed lines
12
    "keywords": [],
13
    "author": "",
14
    "license": "ISC",
15
    "devDependencies": {
16
        "@types/node": "^22.8.1",
17
        "nodemon": "^3.1.7",
18
        "ts-node": "^10.9.2",
19
        "typescript": "^5.6.3"
20
    }
21
}

构建 TypeScript + Node.js 项目模板

逐步教程

准备项目目录

安装并配置 TypeScript

修改并测试构建与运行

安装 Node.js 类型定义

配置监测并自动重启开发服务器 Optional