Typescript 项目配置

项目配置参考：https://www.tslang.cn/docs/handbook/tsconfig-json.html

tsconfig.json

tsconfig.json 文件中指定了用来编译这个项目的根文件和编译选项。tsconfig.json 文件可以是个空文件，那么所有默认的文件都会以默认配置选项编译。

{
  "compilerOptions": {
    "module": "commonjs",
    "noImplicitAny": true,
    "removeComments": true,
    "preserveConstEnums": true,
    "sourceMap": true,
    "outFile": "../../built/local/tsc.js",
  },
  // "files" 指定一个包含相对或绝对文件路径的列表。
  "files": [
    "core.ts",
  ],
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules",
    "**/*.spec.ts"
  ]
}

include & exclude & files & outDir

“include” 和 “exclude” 属性指定一个文件 glob 匹配模式列表。 支持的 glob 通配符有：

• • 匹配0或多个字符（不包括目录分隔符）
• ? 匹配一个任意字符（不包括目录分隔符）
• **/ 递归匹配任意子目录

解释说明：

1. 指定了 “files” 或 “include”，编译器会将它们结合一并包含进来。任何被 “files” 或 “include” 指定的文件所引用的文件也会被包含进来。

2. 如果 “files” 和 “include” 都没有被指定，编译器默认包含当前目录和子目录下所有的TypeScript文件（.ts, .d.ts 和 .tsx），排除在 “exclude” 里指定的文件。

3. 如果 allowJs 被设置成 true，JS文件（.js和.jsx）也被包含进来。

4. 使用 “outDir” 指定的目录下的文件永远会被编译器排除，除非你明确地使用 “files” 将其包含进来。

5. 使用 “include” 引入的文件可以使用 “exclude” 属性过滤。 然而，通过 “files”属性明确指定的文件却总是会被包含在内，不管 “exclude” 如何设置。 如果没有特殊指定， “exclude”默认情况下会排除 node_modules，bower_components，jspm_packages和目录

@types，typeRoots和types

默认所有可见的 “@types” 包会在编译过程中被包含进来。 node_modules/@types 文件夹下以及它们子文件夹下的所有包都是可见的；

{
  "compilerOptions": {
    "typeRoots" : ["./typings"],
    "types" : ["node", "lodash", "express"]
  }
}

如果指定了 typeRoots，只有 typeRoots 下面的包才会被包含进来。 如果指定了 types，只有被列出来的包才会被包含进来。

extends

tsconfig.json 文件可以利用 extends 属性从另一个配置文件里继承配置。 extends 是 tsconfig.json 文件里的顶级属性（与compilerOptions，files，include，和exclude一样）。 extends 的值是一个字符串，包含指向另一个要继承文件的路径。

// configs/base.json
{
  "compilerOptions": {
    "noImplicitAny": true,
    "strictNullChecks": true
  }
}
// tsconfig.json
{
  "extends": "./configs/base",
  "files": [
    "main.ts",
    "supplemental.ts"
  ]
}

compileOnSave

在最顶层设置 compileOnSave 标记，可以让IDE在保存文件的时候根据 tsconfig.json 重新生成文件

{
  "compileOnSave": true,
  "compilerOptions": {
    "noImplicitAny" : true
  }
}

path

解决报错： Cannot find module '@/utils/http/index' or its corresponding type declarations

"baseUrl": ".",
"paths": {
  "@/*": ["src/*"]
}