tsconfig.json配置项详解

君哥 阅读:2330 2023-03-23 22:21:03 评论:1

tsconfig.json 重要字段

  • files - 设置要编译的⽂件的名称;

  • include - 设置需要进⾏编译的⽂件,⽀持路径模式匹配;

  • exclude - 设置⽆需进⾏编译的⽂件,⽀持路径模式匹配;

  • compilerOptions - 设置与编译流程相关的选项。


{
  "compilerOptions": {
    "allowUnreachableCode": true, // 不报告执行不到的代码错误。
    "allowUnusedLabels": false, // 不报告未使用的标签错误
    "alwaysStrict": false, // 以严格模式解析并为每个源文件生成 "use strict"语句    "baseUrl": ".", // 工作根目录
    "experimentalDecorators": true, // 启用实验性的ES装饰器
    "jsx": "react", // 在 .tsx文件里支持jsX
    "sourceMap": true, // 是否生成map文件
    "module": "commonjs", // 指定生成哪个模块系统代码
    "noImplicitAny": false, // 是否默认禁用 any
    "removeComments": true, // 是否移除注释
    "types": [ //指定引入的类型声明文件,默认是自动引入所有声明文件,一旦指定该选项,则会禁用自动引入,改为只引入指定的类型声明文件,如果指定空数组[]则不引用任何文件
      "node", // 引入 node 的类型声明
    ],
    "paths": { // 指定模块的路径,和baseUrl有关联,和webpack中resolve.alias配置一样
      "src": [ //指定后可以在文件之直接 import * from 'src';
        "./src"
      ],
    },
    "target": "ESNext", // 编译的目标是什么版本的
    "outDir": "./dist", // 输出目录
    "declaration": true, // 是否自动创建类型声明文件
    "declarationDir": "./lib", // 类型声明文件的输出目录
    "allowJs": true, // 允许编译JavaScript文件。
    "lib": [ // 编译过程中需要引入的库文件的列表
      "es5",
      "es2015",
      "es2016",
      "es2017",
      "es2018",
      "dom"
    ]
  },
  // 指定一个匹配列表(属于自动指定该路径下的所有ts相关文件)
  "include": [
    "src/**/*"
  ],
  // 指定一个排除列表(include的反向操作)
  "exclude": [
    "demo.ts"
  ],
  // 指定哪些文件使用该配置(属于手动一个个指定文件)
  "files": [
    "demo.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 // 为装饰器提供元数据的⽀持
  }}


本文链接:https://www.yanjun202.com/post/77.html 

分享到:
可以去百度分享获取分享代码输入这里。
发表评论
搜索
排行榜
关注我们

扫一扫关注我们,了解最新精彩内容