这一章主要总结TypeScript的用法和项目常用配置

编译上下文

用来给文件分组，告诉 TypeScript 哪些文件是有效的，哪些是无效的。定义这种逻辑分组，一个比较好的方式是使用 tsconfig.json 文件。

常用配置一览

    {
      "compilerOptions": {

        /* 基本选项 */
        "target": "es5",                       // 指定 ECMAScript 目标版本: 'ES3' (default), 'ES5', '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          // 为装饰器提供元数据的支持
      }
    }

TypeScript 编译

好的 IDE 支持对 TypeScript 的即时编译。但是，如果你想在使用 tsconfig.json 时从命令行手动运行 TypeScript 编译器，你可以通过以下方式：

• 运行 tsc，它会在当前目录或者是父级目录寻找 tsconfig.json 文件。
• 运行 tsc -p ./path-to-project-directory 。当然，这个路径可以是绝对路径，也可以是相对于当前目录的相对路径。

你甚至可以使用 tsc -w 来启用 TypeScript 编译器的观测模式，在检测到文件改动之后，它将重新编译。

声明空间

在 TypeScript 里存在两种声明空间：类型声明空间与变量声明空间。我将会在下文中和大家讨论这两个概念。

类型声明空间

类型声明空间包含用来当做类型注解的内容，例如以下的一些类型声明：

    class Foo {};
    interface Bar {};
    type Bas = {};

你可以将 Foo, Bar, Bas 做为类型注解使用，例如：

    let foo: Foo;
    let bar: Bar;
    let bas: Bas;

注意，尽管你定义了 interface Bar，你并不能够将它做为一个变量使用，因为它没有定义在变量声明空间中：

    interface Bar {}
    const bar = Bar; // Error: "cannot find name 'Bar'"

提示 cannot find name 'Bar' 的原因是名称 Bar 并未定义在变量声明空间。这将带领我们进入下一个主题 "变量声明空间"。

变量声明空间

变量声明空间包含可用作变量的内容，在上文中 Class Foo 提供了一个类型 Foo 到类型声明空间，此外它同样提供了一个变量 Foo 到变量声明空间，如下所示：

    class Foo {}
    const someVar = Foo;
    const someOtherVar = 123;

这很棒，尤其是当你想把一个类来当做变量传递时。

WARNING

我们并不能使用一些像 interface 定义的内容，来当做变量使用。

与此相似，一些像你用 var 声明的变量，也仅能在变量声明空间使用，不能用作类型注解。

    const foo = 123;
    let bar: foo; // ERROR: "cannot find name 'foo'"

提示 cannot find name 的原因是，名称 foo 没有定义在类型声明空间里。

模块

全局模块

默认情况下，当你开始在一个新的 TypeScript 文件中写下代码时，它处于全局命名空间中。如在 foo.ts 里的以下代码：

    const foo = 123;

如果你在相同的项目里创建了一个新的文件 bar.ts，TypeScript 类型系统将会允许你使用变量 foo，就好像它在全局可用一样：

    const bar = foo; // allowed

毋庸置疑，使用全局变量空间是危险的，因为它会与文件内的代码命名冲突。我们推荐使用下文中将要提到的文件模块。

文件模块

它也被称为外部模块。如果在你的 TypeScript 文件的根级别位置含有 import 或者 export，它会在这个文件中创建一个本地的作用域。因此，我们需要把上文 foo.ts 改成如下方式（注意 export 用法）：

    export const foo = 123;

在全局命名空间里，我们不再有 foo，这可以通过创建一个新文件 bar.ts 来证明：

    const bar = foo; // ERROR: "cannot find name 'foo'"

如果你想在 bar.ts 里使用来自 foo.ts 的内容，你必须显式导入它，更新 bar.ts 如下所示：

    import { foo } from './foo';
    const bar = foo; // allow

在 bar.ts 文件里使用 import，不但允许你使用从其他文件导入的内容，而且它会将此文件 bar.ts 标记为一个模块，文件内定义的声明也不会污染全局命名空间。

文件模块详情

文件模块拥有强大的能力和可用性。在这里，我们来讨论它的能力以及一些用法。

澄清：commonjs, amd, es modules, others

首先，我们需要澄清这些模块系统的不一致性。我将会提供给你我当前的建议，以及消除一些顾虑。

你可以根据不同的 module 选项来把 TypeScript 编译成不同的 JavaScript 模块类型，这有一些你可以忽略的：

• AMD：不要使用它，它仅能在浏览器工作；
• SystemJS：这是一个好的实验，已经被 ES 模块替代；
• ES 模块：它并没有准备好。

使用 module: commonjs 选项来替代这些模式，这会是一个好的主意。

怎么书写 TypeScript 模块，这也是一件让人困惑的事。在今天我们应该这么做：

• import foo = require('foo') 例如： import/require 使用 ES 模块语法。

这很酷，接下来，让我们看看 ES 模块语法。

TIP

使用 module: commonjs 选项以及使用 ES 模块语法导入导出其他模块。

ES 模块语法

• 使用 export 关键字导出一个变量（或者类型）：

    // foo.ts
    export const someVar = 123;
    export type someType = { foo: string;
    };

• export 的写法除了上面这样，还有另外一种：

    // foo.ts
    const someVar = 123;
    type someType = { type: string;
    };
    export { someVar, someType };

• 你也可以重命名变量导出：

    // foo.ts
    const someVar = 123;
    export { someVar as aDifferentName };

• 使用 import 关键字导入一个变量或者是一个类型：

    // bar.ts
    import { someVar, someType } from './foo';

• 重命名导入变量或者类型：

    // bar.ts
    import { someVar as aDifferentName } from './foo';

• 除了指定加载某个输出值，还可以使用整体加载，即用星号（*）指定一个对象，所有输出值都加载在这个对象上面：

    // bar.ts
    import * as foo from './foo';
    // 你可以使用 `foo.someVar` 和 `foo.someType` 以及其他任何从 `foo` 导出的变量或者类型

• 仅导入模块：

    import 'core-js'; // 一个普通的 polyfill 库

• 从其他模块导入后整体导出：

    export * from './foo';

• 从其他模块导入后，部分导出：

    export { someVar } from './foo';

• 通过重命名，部分导出从另一个模块导入的项目：

    export { someVar as aDifferentName } from './foo';

默认导入／导出

我并不喜欢用默认导出，虽然有默认导出的语法：

• 使用 export default
  • 在一个变量之前（不需要使用 let/const/var）；
  • 在一个函数之前；
  • 在一个类之前。

    // some var
    export default (someVar = 123);
    // some function
    export default function someFunction() {}
    // some class
    export default class someClass {}

• 导入使用 import someName from 'someModule' 语法（你可以根据需要为导入命名）：

    import someLocalNameForThisFile from './foo';

模块路径

TIP

假设你使用 moduleResolution: node 选项。这个选项应该在你 TypeScript 配置文件里。如果你使用了 module: commonjs 选项， moduleResolution: node 将会默认开启。

这里存在两种不同截然不同的模块，它们是由导入语句中的不同的路径写法所引起的（例如：import foo from 'THIS IS THE PATH SECTION'）。

• 相对模块路径（路径以 . 开头，例如：./someFile 或者 ../../someFolder/someFile 等）；
• 其他动态查找模块（如：core-js，typestyle，react 或者甚至是 react/core 等）。

它们的主要区别来自于系统如何解析模块。

TIP

我将会使用一个概念性术语，place -- 将在提及查找模式后解释它。

相对模块路径

这很简单，仅仅是按照相对路径：

• 如果文件 bar.ts 中含有 import * as foo from './foo'，foo 文件所存在的地方必须是相同文件夹下；
• 如果文件 bar.ts 中含有 import * as foo from '../foo'，foo 文件所存在的地方必须是上一级目录；
• 如果文件 bar.ts 中含有 import * as foo from '../someFolder/foo'，foo 文件所在的文件夹 someFolder 必须与 bar.ts 所在文件夹在相同的目录下。

或者，你还可以想想其他相对路径导入的情景。😃

动态查找

当导入路径不是相对路径时，模块解析将会模仿 Node 模块解析策略，以下我将给出一个简单例子：

• 当你使用 import * as foo from 'foo'，将会按如下顺序查找模块：
  • ./node_modules/foo
  • ../node_modules/foo
  • ../../node_modules/foo
  • 直到系统的根目录
• 当你使用 import * as foo from 'something/foo'，将会按照如下顺序查找内容
  • ./node_modules/something/foo
  • ../node_modules/something/foo
  • ../../node_modules/something/foo
  • 直到系统的根目录

什么是 place

当我提及被检查的 place 时，我想表达的是在这个 place，TypeScript 将会检查以下内容（例如一个 foo 的位置）：

• 如果这个 place 表示一个文件，如：foo.ts，欢呼！
• 否则，如果这个 place 是一个文件夹，并且存在一个文件 foo/index.ts，欢呼！
• 否则，如果这个 place 是一个文件夹，并且存在一个 foo/package.json 文件，在该文件中指定 types 的文件存在，那么就欢呼！
• 否则，如果这个 place 是一个文件夹，并且存在一个 package.json 文件，在该文件中指定 main 的文件存在，那么就欢呼！

从文件类型上来说，我实际上是指 .ts， .d.ts 或者 .js

就是这样，现在你已经是一个模块查找专家（这并不是一个小小的成功）。

重写类型的动态查找

在你的项目里，你可以通过 declare module 'somePath' 来声明一个全局模块的方式，用来解决查找模块路径的问题：

    // globals.d.ts
    declare module 'foo' { // some variable declarations export var bar: number;
    }

接着：

    // anyOtherTsFileInYourProject.ts
    import * as foo from 'foo';
    // TypeScript 将假设（在没有做其他查找的情况下）
    // foo 是 { bar: number }

import/require 仅仅是导入类型

以下导入语法：

    import foo = require('foo');

它实际上只做了两件事：

• 导入 foo 模块的所有类型信息；
• 确定 foo 模块运行时的依赖关系。

你可以选择仅加载类型信息，而没有运行时的依赖关系。在继续之前，你可能需要重新阅读本书的 声明空间部分 部分。

如果你没有把导入的名称当做变量声明空间来用，在编译成 JavaScript 时，导入的模块将会被完全移除。这有一些较好的例子，当你了解了它们之后，我们将会给出一些使用例子。

例子 1

    import foo = require('foo');

将会编译成 JavaScript：

这是正确的，一个没有被使用的空文件。

例子 2

    import foo = require('foo');
    var bar: foo;

将会被编译成：

    let bar;

这是因为 foo （或者其他任何属性如：foo.bas）没有被当做一个变量使用。

例子 3

    import foo = require('foo');
    const bar = foo;

将会被编译成（假设是 commonjs）：

    const foo = require('foo');
    const bar = foo;

这是因为 foo 被当做变量使用了。

使用例子：懒加载

类型推断需要提前完成，这意味着，如果你想在 bar 文件里，使用从其他文件 foo 导出的类型，你将不得不这么做：

    import foo = require('foo');
    let bar: foo.SomeType;

然而，在某些情景下，你只想在需要时加载模块 foo，此时你需要仅在类型注解中使用导入的模块名称，而不是在变量中使用。在编译成 JavaScript 式，这些将会被移除。接着，你可以手动导入你需要的模块。

做为一个例子，考虑以下基于 commonjs 的代码，我们仅在一个函数内导入 foo 模块：

    import foo = require('foo');
    export function loadFoo() { // 这是懒加载 foo，原始的加载仅仅用来做类型注解 const _foo: typeof foo = require('foo'); // 现在，你可以使用 `_foo` 替代 `foo` 来做为一个变量使用
    }

一个同样简单的 amd 模块（使用 requirejs）：

    import foo = require('foo');
    export function loadFoo() { // 这是懒加载 foo，原始的加载仅仅用来做类型注解 require(['foo'], (_foo: typeof foo) => { // 现在，你可以使用 `_foo` 替代 `foo` 来做为一个变量使用 });
    }

这些通常在以下情景使用：

• 在 web app 里， 当你在特定路由上加载 JavaScript 时；
• 在 node 应用里，当你只想加载特定模块，用来加快启动速度时。

使用例子：打破循环依赖

类似于懒加载的使用用例，某些模块加载器（commonjs/node 和 amd/requirejs）不能很好的处理循环依赖。在这种情况下，一方面我们使用延迟加载代码，并在另一方面预先加载模块时很实用的。

使用例子：确保导入

当你加载一个模块，只是想引入其附加的作用（如：模块可能会注册一些像 CodeMirror addons）时，然而，如果你仅仅是 import/require （导入）一些并没有与你的模块或者模块加载器有任何依赖的 JavaScript 代码，（如：webpack），经过 TypeScript 编译后，这些将会被完全忽视。在这种情况下，你可以使用一个 ensureImport 变量，来确保编译的 JavaScript 依赖与模块。如：

    import foo = require('./foo');
    import bar = require('./bar');
    import bas = require('./bas');
    const ensureImport: any = foo || bar || bas;

globals.d.ts

在上文中，当我们讨论文件模块时，比较了全局变量与文件模块，并且我们推荐使用基于文件的模块，而不是选择污染全局命名空间。

然而，如果你的团队里有 TypeScript 初学者，你可以提供他们一个 globals.d.ts 文件，用来将一些接口或者类型放入全局命名空间里，这些定义的接口和类型能在你的所有 TypeScript 代码里使用。

TIP

对于任何需要编译成 JavaScript 代码，我们强烈建议你放入文件模块里。

• globals.d.ts 是一种扩充 lib.d.ts 很好的方式，如果你需要。
• 当你从 TS 迁移到 JS 时，定义 declare module "some-library-you-dont-care-to-get-defs-for" 能让你快速开始。

转自 https://jkchao.github.io/typescript-book-chinese/project/modules.html