typescript快速入门之安装与运行

安装

安装ts环境，最好全局安装，这样就不需要开一个项目又安装

npm i -g typescript

初始化

可以运行初始化配置文件，也可以手动生成；不生成的话会运行默认配置

使用默认配置

• 把ts文件转成js文件使用的是es3语言，语法是var这些
• 生成的文件会在对应目录跟ts文件名一样的，如index.ts生成的是index.js,无法放入到指定的转换文件夹里面
• 会造成命名重复，原因是假设当前环境在DOM环境中如果代码中没有模块化语句，默认代码是全局执行的，所以变量就是全局变量
  要最简单的解决，就是用模块化。

生成配置文件

​ 默认生成

tsc --init // 运行该命令会在项目根目录生成一个tsconfig.json文件，里面是一些ts的默认配置

​ tsconfig.json文件部分内容

"compilerOptions": {
  "incremental": true, // 是否启用增量编译
  "tsBuildInfoFile": "./buildFile", // 增量编译文件的存储位置
  "diagnostics": true, // 打印诊断信息 
  "target": "ES5", // 目标语言的版本（指定编译 js 的版本）
  "module": "CommonJS", // 生成代码的模板标准
  "outFile": "./app.js", // 将多个相互依赖的文件生成一个文件，可以用在AMD模块中，即开启时应设置"module": "AMD"
  "lib": ["DOM", "ES2015", "ScriptHost", "ES2019.Array"], // lib用于指定要包含在编译中的库文件
  "allowJS": true, // 允许编译器编译JS，JSX文件
  "checkJs": true, // 允许在JS文件中报错，通常与allowJS一起使用
  "outDir": "./dist", // 指定输出目录
  "rootDir": "./", // 指定输出文件目录(用于输出)，用于控制输出目录结构
  "declaration": true, // 生成声明文件，开启后会自动生成声明文件
  "declarationDir": "./file", // 指定生成声明文件存放目录
  "emitDeclarationOnly": true, // 只生成声明文件，而不会生成js文件
  "sourceMap": true, // 生成目标文件的sourceMap文件（代码源文件）
  "inlineSourceMap": true, // 生成目标文件的inline SourceMap，inline SourceMap会包含在生成的js文件中
  "declarationMap": true, // 为声明文件生成sourceMap
  "typeRoots": [], // 声明文件目录，默认时node_modules/@types
  "types": [], // 加载的声明文件包
  "removeComments":true, // 在编译过程中删除文件中的注释
  "noEmit": true, // 不输出文件,即编译后不会生成任何js文件
  "noEmitOnError": true, // 发送错误时不输出任何文件
  "noEmitHelpers": true, // 不生成helper函数，减小体积，需要额外安装，常配合importHelpers一起使用
  "importHelpers": true, // 通过tslib引入helper函数，文件必须是模块
  "downlevelIteration": true, // 降级遍历器实现，如果目标源是es3/5，那么遍历器会有降级的实现
  "strict": true, // 开启所有严格的类型检查
  "alwaysStrict": true, // 在代码中注入'use strict'
  "noImplicitAny": true, // 不允许隐式的any类型
  "strictNullChecks": true, // 不允许把null、undefined赋值给其他类型的变量
  "strictFunctionTypes": true, // 不允许函数参数双向协变
  "strictPropertyInitialization": true, // 类的实例属性必须初始化
  "strictBindCallApply": true, // 严格的bind/call/apply检查
  "noImplicitThis": true, // 不允许this有隐式的any类型
  "noUnusedLocals": true, // 检查只声明、未使用的局部变量(只提示不报错)
  "noUnusedParameters": true, // 检查未使用的函数参数(只提示不报错)
  "noFallthroughCasesInSwitch": true, // 防止switch语句贯穿(即如果没有break语句后面不会执行)
  "noImplicitReturns": true, //每个分支都会有返回值
  "esModuleInterop": true, // 允许export=导出，由import from 导入
  "allowUmdGlobalAccess": true, // 允许在模块中全局变量的方式访问umd模块
  "moduleResolution": "node", // 模块解析策略，ts默认用node的解析策略，即相对的方式导入
  "baseUrl": "./", // 解析非相对模块的基地址，默认是当前目录
  "paths": { // 路径映射，相对于baseUrl
    // 如使用jq时不想使用默认版本，而需要手动指定版本，可进行如下配置
    "jquery": ["node_modules/jquery/dist/jquery.min.js"]
  },
  "rootDirs": ["src","out"], // 将多个目录放在一个虚拟目录下，用于运行时，即编译后引入文件的位置可能发生变化，这也设置可以虚拟src和out在同一个目录下，不用再去改变路径也不会报错
  "listEmittedFiles": true, // 打印输出文件
  "listFiles": true// 打印编译的文件(包括引用的声明文件)
}
 
// 指定一个匹配列表（属于自动指定该路径下的所有ts相关文件）
"include": [
   "src/**/*"
],
// 指定一个排除列表（include的反向操作）
 "exclude": [
   "demo.ts"
],
// 指定哪些文件使用该配置（属于手动一个个指定文件）
 "files": [
   "demo.ts"
]

tsconfig.json解释：

• compilerOptions : 这是一个对象，用于指定编译器应如何编译 TypeScript 代码。

• compilerOptions 子选项：

  • target : 指定输出的 ECMAScript 目标版本，如 ES5、ES6/ES2015 等。这会影响到语法和功能上的编译。
  • module : 指定生成的模块代码系统，如 CommonJS、AMD、System、 UMD、ES6、ES2015、ESNext 等。
  • lib : 用来指定要包含在编译中的库文件。比如，如果你想使用 ES2015 的功能，但是又想要兼容 ES5，你就可以设置 “target”: “ES5” 和 “lib”: [“ES2015”] 。
  • outDir : 指定编译后的输出目录。
  • rootDir : 指定输入文件的根目录，用于控制输出目录结构。
  • strict : 启用所有严格类型检查选项。
  • esModuleInterop : 启用 ES6 模块的默认导入方式。
  • allowJs : 允许编译器编译 JavaScript 文件。
  • checkJs : 允许在 JavaScript 文件中报告错误。
  • sourceMap : 生成对应的 .map 文件。
  • noImplicitAny：是否允许使用隐式 any。
  • jsx：jsx 的处理方式（是否保留原有 jsx 格式，比如 react 中会转为 React.createElement()）
  • include 和 exclude : 这两个选项用于指定编译器应包含哪些文件和排除哪些文件。
  • extends : 这个选项允许一个 tsconfig.json 文件继承另一个 tsconfig.json 文件的配置。
  • files 和 references : 这两个选项在项目引用中使用，用于设置项目间的依赖关 系。

手动生成

​ 在根目录建立tsconfig.json文件

文件配置

如果项目中指定了tsconfig.json文件，运行tsc不需要再指定文件路径地址，否则需要输入对的tsc [文件名]

{
  "compilerOptions": {
    "target": "ES2017", // 编译目标版本
    "lib":["ES2017","DOM","DOM.Iterable"], // 需要引用的库
    "outDir": "./dist" // 指定输出目录，如果未指定和对应的.ts文件同目录
  },
  "include": ["src/**/*.ts"] // 指定需要编译的文件或目录
}

运行

使用自带命令

tsc [文件名] // 把对应的ts文件转换成能输出的js文件，在对应的ts文件夹下面生成，会造成命名冲突，原因上面解释过

使用第三方库

方式一

// 全局或局部安装nodemon,这样只要你改变文件内容会自动输出
npm i -g nodemon
// 将ts代码在内存中完成编译，同时完成运行
npm i ts-node

在package.json里面scripts配置命令

{
  "scripts": {
    "start": "nodemon --exec ts-node src/index.ts"
  }
}

方式二

// 全局或局部安装,这样只要你改变文件内容会自动输出，但使用tsc命令编译文件会报错
npm i ts-node-dev
// 将ts代码在内存中完成编译，同时完成运行
npm i ts-node

在package.json里面scripts配置命令

{
  "scripts": {
    "dev": "tsnd --respawn src/index.ts"
  }
}

编辑器配置插件

VSCode

安装扩展

error lens --这个插件能够把错误直接显示到代码文件中的对应位置