前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >tsconfig.json 配置文件详解 | 02

tsconfig.json 配置文件详解 | 02

作者头像
程序员王天
发布2023-10-18 19:31:07
7840
发布2023-10-18 19:31:07
举报

# tsconfig.json (Ts 配置文件)

tsconfig.json 是 ts 项目中配置文件。在项目根目录,如果项目中有 tsconfig.json, TypeScript 则认为这是项目的根目录。

如果项目源码是 JavaScript,但是相用 typescript 处理,那配置文件的名字是jsconfig.json ,和 tsconfig 的写法一样。

# 指定 tsconfig.json 目录

命令行参数--project 或-p 可以指定 tsconfig.json 的位置(目录或文件皆可)。

如果不指定 tsconfig.json, tsc 会在当前目录搜索 tsconfig.json 文件,如果不存在,就到上一级目录搜索,直到找到为止。

tsconfig.json 文件格式,是一个 JSON 对象,简单到只可以放一个空对象 {}, 示例如下:

代码语言:javascript
复制
{
    "compilerOptions":{
        "outDir":"./built",
        "allowJs":true,
        "target":"es5"
    },
    "include":["./src/**/*"]
}

tsconfig.json 文件中有很多属性,这样简单说下上面四个属性的含义

  • outDir 指定编译文件存放的目录
  • allowJs 指定源目录的 JavaScript 文件是否原样拷贝到编译后的目录
  • target 指定编译产物的 js 版本
  • include 指定那些文件需要编译

tsconfig.json 文件可以不必手写,使用 tsc 命令的 --init 参数自动生成

代码语言:javascript
复制
tsc --init

# tsconfig 一级属性

tsconfig.json 的一级属性并不多,只有很少几个,但是 compilerOptions 属性有很多二级属性。

先介绍下一级属性

# 1、include

include 属性指定所要编译的文件列表,既支持逐一列出文件,也支持通配符。文件位置相对于当前配置文件而定。

代码语言:javascript
复制
{
  "include": ["src/**/*", "tests/**/*"]
}

include 属性支持三种通配符。

  • ?:指代单个字符
  • *:指代任意字符,不含路径分隔符
  • **:指定任意目录层级。

如果不指定文件后缀名,默认包括.ts、.tsx 和.d.ts 文件。如果打开了 allowJs,那么还包括.js 和.jsx。

# 2、exclude

exclude 属性是一个数组,必须与 include 属性一起使用,用来从编译列表中去除指定的文件,同样支持和 include 属性相同的通配符。

代码语言:javascript
复制
{
    "include":["**/*"], // 指定那些文件需要编译
    "exclude":["**/*.spec.ts"] // 从编译列表中去除指定文件
}

# 3、extends

如果一个项目有多个配置文件,可以将共同的配置写在 tsconfig.base.json tsconfig.json 可以继承另一个 tsconfig.json 文件的配置,这样方便维护。

代码语言:javascript
复制
{
    "extends":"../tsconfig.base.json"
}

如果 extends 属性指定的路径如不是以./ 或者 ../开头,那么编译器将在node_modules 目录下查找指定的配置文件。

extends 属性也可也继承已发布的 npm 模块里面的 tsconfig 文件

代码语言:javascript
复制
{
    "extends":"@tsconfig/node12/tsconfig.json"
}

extends 指定的 tsconfig.json 会先加载,然后加载当前的 tsconfig.json 。如果两者有重名的属性,后者会覆盖前者。

# 4、files

files 属性指定编译的文件列表,如果其中一个文件不存在,就会报错。 它是一个数组,排在前面的文件先编译。

代码语言:javascript
复制
{
    "files":["a.ts","b.ts"]
}

该属性必须逐一列出文件,不支持文件匹配,如果文件比较多建议使用 includeexclude 属性。

# 5、references

references 属性是一个数组,数组成员为对象,适合一个大项目由多个小项目构成的情况,用来设置需要引用的底层项目。

代码语言:javascript
复制
    {
        "references":[
            {"path":"../pkg1"},
            {"path":"../pkg2/tsconfig.json"}
        ]
    }

# lesson 1 实战

    1. 使用 create-react-app project --template typescript 创建脚手架
代码语言:javascript
复制
 create-react-app project --template typescript
    1. 正确生成 tsConfig.json 文件 tsc --init
代码语言:javascript
复制
tsc --init // 使用上面脚手架创建后,项目中自动生成tsconfig.json 文件
    1. 正确配置打包 dist 命令

先创建 config 配置目录,输入以下命令

代码语言:javascript
复制
npm eject

打开 config 目录,config/paths.js 更改打包目录为 dist

image.png
image.png
    1. 正确配置 ts 文件监听
image.png
image.png

image.png

    1. 配置打包出口文件
代码语言:javascript
复制
// 如上和第三题一样
    1. 配置 incloude 以及 excloude
代码语言:javascript
复制
{
  "include":["src/**/*"], //指定所要编译的文件列表
  "exclude": ["**/*.spec.ts"]//从编译列表中去除指定的文件
}
    1. 用 ts 语法声明一个枚举示例
代码语言:javascript
复制
enum user{
  age,
  name,
  sex
}
    1. 定义类型不可使用 any;
代码语言:javascript
复制
// 不要用any any any!!!
    1. 写出 ts 的基础类型 以及 ts 新增类型 写明注释
代码语言:javascript
复制
// 布尔值
let isDone: boolean = false;

// 数字
let decLiteral: number = 6;
let hexLiteral: number = 0xf00d;
let binaryLiteral: number = 0b1010;
let octalLiteral: number = 0o744;

// 字符串
let name: string = `Gene`;
let sentence: string = `Hello, my name is ${name}.`;

// 数组
let list: number[] = [1, 2, 3];
let list: Array<number> = [1, 2, 3]; // 数组泛型,Array<元素类型>

// 元组 Tuple
let x: [string, number];
x = ["hello", 10];
    1. 自行定义 ts 的元组类型
代码语言:javascript
复制
// 定义一个具有固定长度为2的元组类型
type MyTuple = [string, number];

// 声明一个变量并指定其类型为自定义的元组类型
let myTuple: MyTuple;

// 初始化元组变量
myTuple = ["hello", 123]; // 正确
myTuple = ["world", 456];
    1. 实现元组数据存在多种类型的定义
代码语言:javascript
复制
//myTuple 是一个包含三个元素的元组。第一个元素的类型是 number,第二个元素的类型是 string,第三个元素的类型是 boolean。
let myTuple: [number, string, boolean] = [42, "Hello", true];
    1. 简单实现去重效果[1,1,1,2,2,2,3]=>[1,2,3]
代码语言:javascript
复制
// 最快速去重 new set() ,注意 set只能去除基本类型,无法去重引用类型,如对象,因为应用类型值相同无法去重

new Set([1, 1, 1, 2, 2, 2, 3]);
    1. 正确实现函数调用且正确给出函数返回值的类型
代码语言:javascript
复制
const add = (a: number, b: number): number => {
  return a + b;
};
    1. 正确实现效果无 bug;
代码语言:javascript
复制
不要出bug!!!!!
    1. 添加必要的思路注释
代码语言:javascript
复制
记得写下代码注释,比如声明一个包含xx类型的数据结构
    1. 录制效果视频正确讲解并标黄;
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2023年9月30日,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • # tsconfig.json (Ts 配置文件)
    • # 指定 tsconfig.json 目录
    • # tsconfig 一级属性
      • # 1、include
        • # 2、exclude
          • # 3、extends
            • # 4、files
              • # 5、references
              • # lesson 1 实战
              领券
              问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档