TypeScript-3

Posted on | In

tsconfig.json

如果一个目录下存在一个tsconfig.json文件，那么它意味着这个目录是TypeScript项目的根目录。 tsconfig.json文件中指定了用来编译这个项目的根文件和编译选项。

可以手动创建tsconfig.json文件，也也可以通过tsc —init创建。

可以通过 compilerOptions 来定制编译选项，这边就写一点常见（我常见）的：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
{
    // "files": [ //显式指定需要编译的文件
    //     "./src/index.ts"
    // ],
    "include": [//包含某个目录下
        "./src/"
    ],
    "exclude": [//剔除某个目录下
        "./src/untils/*.ts",
    ],
    "compilerOptions": {

    /* 基本选项 */
    "target": "es5",                       // 指定 ECMAScript 目标版本: 'ES3' (default), 'ES5', 'ES6'/'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'
    "module": "commonjs",                  // 指定使用模块: 'commonjs', 'amd', 'system', 'umd' or 'es2015'
    "lib": [],                             // 指定要包含在编译中的库文件
    "allowJs": true,                       // 允许编译 javascript 文件
    "checkJs": true,                       // 报告 javascript 文件中的错误
    "jsx": "preserve",                     // 指定 jsx 代码的生成: 'preserve', 'react-native', or 'react'
    "declaration": true,                   // 生成相应的 '.d.ts' 文件
    "sourceMap": true,                     // 生成相应的 '.map' 文件
    "outFile": "./",                       // 将输出文件合并为一个文件
    "outDir": "./",                        // 指定输出目录
    "rootDir": "./",                       // 用来控制输出目录结构 --outDir.
    "removeComments": true,                // 删除编译后的所有的注释
    "noEmit": true,                        // 不生成输出文件
    "importHelpers": true,                 // 从 tslib 导入辅助工具函数
    "isolatedModules": true,               // 将每个文件做为单独的模块 （与 'ts.transpileModule' 类似）.

    /* 严格的类型检查选项 */
    "strict": true,                        // 启用所有严格类型检查选项
    "noImplicitAny": true,                 // 在表达式和声明上有隐含的 any类型时报错
    "strictNullChecks": true,              // 启用严格的 null 检查
    "noImplicitThis": true,                // 当 this 表达式值为 any 类型的时候，生成一个错误
    "alwaysStrict": true,                  // 以严格模式检查每个模块，并在每个文件里加入 'use strict'

    /* 额外的检查 */
    "noUnusedLocals": true,                // 有未使用的变量时，抛出错误
    "noUnusedParameters": true,            // 有未使用的参数时，抛出错误
    "noImplicitReturns": true,             // 并不是所有函数里的代码都有返回值时，抛出错误
    "noFallthroughCasesInSwitch": true,    // 报告 switch 语句的 fallthrough 错误。（即，不允许 switch 的 case 语句贯穿）

    /* 模块解析选项 */
    "moduleResolution": "node",            // 选择模块解析策略： 'node' (Node.js) or 'classic' (TypeScript pre-1.6)
    "baseUrl": "./",                       // 用于解析非相对模块名称的基目录
    "paths": {},                           // 模块名到基于 baseUrl 的路径映射的列表
    "rootDirs": [],                        // 根文件夹列表，其组合内容表示项目运行时的结构内容
    "typeRoots": [],                       // 包含类型声明的文件列表
    "types": [],                           // 需要包含的类型声明文件名列表
    "allowSyntheticDefaultImports": true,  // 允许从没有设置默认导出的模块中默认导入。

    /* Source Map Options */
    "sourceRoot": "./",                    // 指定调试器应该找到 TypeScript 文件而不是源文件的位置
    "mapRoot": "./",                       // 指定调试器应该找到映射文件而不是生成文件的位置
    "inlineSourceMap": true,               // 生成单个 soucemaps 文件，而不是将 sourcemaps 生成不同的文件
    "inlineSources": true,                 // 将代码与 sourcemaps 生成到一个文件中，要求同时设置了 --inlineSourceMap 或 --sourceMap 属性

    /* 其他选项 */
    "experimentalDecorators": true,        // 启用装饰器
    "emitDecoratorMetadata": true          // 为装饰器提供元数据的支持
  }
}

其他配置信息

模块

全局模块

两个ts文件在同一个目录下，这样声明a相当于在全局中声明

WX20190820-225555@2x

文件模块

使用export或者import，会在文件中创建一个本地作用域

WX20190820-230729@2x

正确的使用方式：

WX20190820-230807@2x

尽量使用 ES 模块导入导出语法)

相对模块路径：

当使用import { b } from "./moduleB"的时候，在/root/src/moduleA.ts里

  1. /root/src/moduleB.ts
  2. /root/src/moduleB.tsx
  3. /root/src/moduleB.d.ts
  4. /root/src/moduleB/package.json (如果指定了"types"属性)
  5. /root/src/moduleB/index.ts
  6. /root/src/moduleB/index.tsx
  7. /root/src/moduleB/index.d.ts

非相对模块路径：

当导入不是相对模块路径的时候，当你使用 import { b } from "moduleB"，它是在/root/src/folder/A.ts文件里，会按照下面顺序查找

  1. /root/src/node_modules/moduleB.ts

  2. /root/src/node_modules/moduleB.tsx

  3. /root/src/node_modules/moduleB.d.ts

  4. /root/src/node_modules/moduleB/package.json (如果指定了"types"属性)

  5. /root/src/node_modules/moduleB/index.ts

  6. /root/src/node_modules/moduleB/index.tsx

  7. /root/src/node_modules/moduleB/index.d.ts

  1. /root/node_modules/moduleB.ts

  2. /root/node_modules/moduleB.tsx

  3. /root/node_modules/moduleB.d.ts

  4. /root/node_modules/moduleB/package.json (如果指定了"types"属性)

  5. /root/node_modules/moduleB/index.ts

  6. /root/node_modules/moduleB/index.tsx

  7. /root/node_modules/moduleB/index.d.ts

  1. /node_modules/moduleB.ts

  2. /node_modules/moduleB.tsx

  3. /node_modules/moduleB.d.ts

  4. /node_modules/moduleB/package.json (如果指定了"types"属性)

  5. /node_modules/moduleB/index.ts

  6. /node_modules/moduleB/index.tsx

  7. /node_modules/moduleB/index.d.ts

在步骤（8）和（15）向上跳了两次目录

NodeJS如何解析模块：

在Node.js里导入是通过require函数调用进行的。 Node.js会根据 require的是相对路径还是非相对路径做出不同的行为。

相对路径：

假设有一个文件路径为 /root/src/moduleA.js，包含了一个导入var x = require("./moduleB"); Node.js以下面的顺序解析这个导入：

  1. 检查/root/src/moduleB.js文件是否存在。
  2. 检查/root/src/moduleB目录是否包含一个package.json文件，且package.json文件指定了一个"main"模块。 在我们的例子里，如果Node.js发现文件 /root/src/moduleB/package.json包含了{ "main": "lib/mainModule.js" }，那么Node.js会引用/root/src/moduleB/lib/mainModule.js。
  3. 检查/root/src/moduleB目录是否包含一个index.js文件。 这个文件会被隐式地当作那个文件夹下的”main”模块。

非相对路径：

Node会在一个特殊的文件夹 node_modules里查找你的模块。node_modules可能与当前文件在同一级目录下，或者在上层目录里。 Node会向上级目录遍历，查找每个node_modules直到它找到要加载的模块。

还是用上面例子，但假设/root/src/moduleA.js里使用的是非相对路径导入var x = require("moduleB");。 Node则会以下面的顺序去解析 moduleB，直到有一个匹配上。

  1. /root/src/node_modules/moduleB.js

  2. /root/src/node_modules/moduleB/package.json (如果指定了"main"属性)

  3. /root/src/node_modules/moduleB/index.js

  1. /root/node_modules/moduleB.js

  2. /root/node_modules/moduleB/package.json (如果指定了"main"属性)

  3. /root/node_modules/moduleB/index.js

  1. /node_modules/moduleB.js

  2. /node_modules/moduleB/package.json (如果指定了"main"属性)

  3. /node_modules/moduleB/index.js

注意Node.js在步骤（4）和（7）会向上跳一级目录。

TS调用Js

index.ts

1
2
import { b } from './untils/untils';
console.log(b);

untils.d.ts

1
export declare const b:number

untils.js

1
export const b = 1;

实际的项目里，建议把声明放在.d.ts文件内，当然放在ts文件里也可以

资料

工程配置

项目地址

TypeScript

深入了解TypeScript