TypeScript 配置文件tsconfig.json 的作用

最新推荐文章于 2024-08-19 14:36:51 发布

青衣浏阳

最新推荐文章于 2024-08-19 14:36:51 发布

阅读量572

点赞数 1

文章标签： typescript json javascript

本文链接：https://blog.csdn.net/m0_49016709/article/details/123186920

版权

本文详细介绍了如何创建并配置TypeScript项目，包括使用tsc命令生成tsconfig.json配置文件，设置编译选项如outDir、target等，以及如何实现文件改变时的自动编译。此外，还讲解了tsconfig.json中的关键字段及其作用，如files、include、exclude和compilerOptions等，帮助开发者更好地理解和掌握TypeScript的项目构建流程。

摘要由CSDN通过智能技术生成

生成配置文件 tsconfig.json
新建文件夹创建一个简单的ts项目

npm install -g typescript  //全局安装ts
tsc --init  // 生成配置文件

新建一个index.html 文件和helloworld.ts

编译ts文件

ts helloworld.ts //会生成一个同名的js文件，在index.html中引入

设置当helloworld.ts改变时自动编译

tsc --watch helloworld.ts   // 当helloworld文件发生改变的时候自动编辑

指令，修改输出的文件夹，配置

//编译当前路径文件输出到dist目录
tsc --outDir ./dist ./helloworld.ts 
//编译当前路径文件输出到dist目录，js代码版本为ES6
tsc --outDir ./dist --target ES6 ./helloworld.ts 
//编译当前路径文件输出到dist目录，js代码版本为ES6，并开启监听模式，后续在ts文件写代码会自动编译。
tsc --outDir ./dist --target ES6 --watch ./helloworld.ts

tsconfig.json 重要字段
files - 设置要编译的文件的名称；
include - 设置需要进行编译的文件，支持路径模式匹配；
exclude - 设置无需进行编译的文件，支持路径模式匹配；
compilerOptions - 设置与编译流程相关的选项。

compilerOptions 选项字段的解释

{
  "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          // 为装饰器提供元数据的支持
  }
}