启动一个TypeScript项目的准备工作

3,402 阅读5分钟

因为我启动这个项目是作为《每日一写》专栏的配套代码仓库来使用的,所以先在github上创建一个仓库:github.com/paiangit/ev…

一、初始化项目

首先来对项目进行初始化,依次执行如下命令即可,每一行的功能都做了详细注释:

# 初始化git项目
git init

# 生成package.json文件
npm init -y

# 添加typescript依赖
pnpm add typescript -D

二、让各阶段类型检测的TypeScript版本一致

我们先创建一个src/hello-world.ts文件,然后在VS Code中将该文件打开。这样,在VS Code界面底部的右侧如下所示:

image.png

点击 VS Code 底部工具栏的 “{}” 图标。在弹出的浮层中点击“选择版本”,然后在下图所示的下拉列表中选择 “使用工作区版本”(即使用使用当前项目node_modules下安装的的TypeScript版本),否则,VS Code会默认采用VS Code内置的TypeScript的版本。当这两个版本之间存在不兼容的特性时,就会导致开发阶段和构建阶段TypeScript文件静态类型检测结果不一致(此时开发阶段用的是VS Code的内置TypeScript,而构建阶段是采用的是项目node_modules下安装的的TypeScript版本)。

image.png

经过上述设置,实际上会在项目中生成一个.vscode/settings.json文件,其内容如下:

{
  "typescript.tsdk": "node_modules/typescript/lib"
}

这个文件和上述的手工操作是等价的,有了它,这个项目的所有协作者就都可以统一成这个设置了。

三、通过tsc将.ts文件转成.js文件

1、方式1:通过tsc的命令行选项完成简单的配置任务(可跳过)

有的时候,你可能需要一个简单的命令将.ts文件转成.js文件,那么可以试试下面这个命令:

tsc src/*.ts --strict --alwaysStrict false --target es5 --module commonjs --watch --outDir dist

这个命令对于src下的.ts文件,观察到修改后,都会自动转成.js文件,输出到dist目录下。当然,有文件增加和删除的话,是需要重启的。

对于简单的配置,这些参数基本就搞定了,但对于复杂的配置,就要用到.tsconfig.json配置文件了。

2、方式2:通过.tsconfig.json文件完成更复杂的配置

首先在项目根目录执行如下命令来初始化一个.tsconfig.json文件:

# 初始化一个.tsconfig.json文件
tsc --init

然后,我们在其中添加 "include": ["./src/**/*.ts"]"outDir": "./dist" 这两项:

{
  "include": ["./src/**/*.ts"],
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    "outDir": "./dist",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */

    /* Module Resolution Options */
    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  }
}

然后,在控制台中执行 tsc --config --project .tsconfig.json 即可完成如上面方式1类似的效果,而且增减文件的时候不用重新启动命令就能正常工作。

为了简化使用,我们将这个启动命令加入到项目的package.json中,如下所示:

"scripts": {
  "start": "tsc --watch --project tsconfig.json"
}

这样就可以直接执行 npm start 来起到同样的作用了。

四、通过ts-node直接在终端中执行TypeScript文件

我们知道,node xxx.ts 命令是不能直接执行.ts文件的。首先需要全局安装ts-node模块:

# 全局安装ts-node,方便在终端中通过ts-node xxx.ts命令直接执行TypeScript文件进行调试
npm i -g ts-node

然后,我们就可以使用类似 ts-node xxx.ts 这样的命令来直接执行文件了,就像 node xxx.js 的起到的效果一样。

相关的代码参见这里