tsconfig之moduleResolution详解

作用

moduleResolution:模块解析策略,是指编译器在查找导入模块内容时所遵循的流程

模块解析分析

如下代码,编辑器会采用模块解析策略 NodeClassic,去查找 moduleB 在哪里?如果最后找不到,
编译器不能解析这个模块会返回错误 error TS2307: Cannot find module 'moduleA'

import {
	b
} from "./moduleB"

模块的相对以及非相对模块导入

相对导入是以 /./../ 开头的

import Entry
	from "./components/Entry";
import {
	DefaultHeaders
} from "../constants/http";
import "/mod";

其它形式的导入被当作非相对的

import * as $
  from "jQuery";
import {
  Component
} from "@angular/core";

模块解析策略

  • 共有两种可用的模块解析策略:NodeClassic
  • 可以使用 --moduleResolution 标记来指定使用哪种模块解析策略。
  • 若未指定,那么在使用了 --module AMD | System | ES2015 时的默认值为 Classic,其它情况时则为 Node

Classic 策略

这种策略在以前是 TypeScript 默认的解析策略。

相对导入的模块是相对于导入它的文件进行解析的

/root/src/folder/A.ts 文件里的 import { b } from "./moduleB" 会使用下面的查找流程

  • /root/src/folder/moduleB.ts
  • /root/src/folder/moduleB.d.ts
非相对模块的导入

从包含导入文件的目录开始依次向上级目录遍历,尝试定位匹配的声明文件

/root/src/folder/A.ts 文件里的 import { b } from "moduleB" 会使用下面的查找流程

  • /root/src/folder/moduleB.ts
  • /root/src/folder/moduleB.d.ts
  • /root/src/moduleB.ts
  • /root/src/moduleB.d.ts
  • /root/moduleB.ts
  • /root/moduleB.d.ts
  • /moduleB.ts
  • /moduleB.d.ts

Node 策略

Node.js 相对导入

/root/src/moduleA.js 文件里的 var x = require("./moduleB"); 会使用下面的查找流程

  • /root/src/moduleB.js
  • /root/src/moduleB 目录是否包含一个 package.json 文件,且 package.json 文件指定了一个 main 模块,如果 Node.js 发现文件 /root/src/moduleB/package.json 包含了 { "main": "lib/mainModule.js" },那么 Node.js 会引用 /root/src/moduleB/lib/mainModule.js
  • /root/src/moduleB 目录是否包含一个 index.js,这个文件会被隐式地当作那个文件夹下的 main 模块。
Node.js 非相对导入

Node 会在一个特殊的文件夹 node_modules 里查找你的模块。 node_modules 可能与当前文件在同一级目录下,或者在上层目录里。 Node 会向上级目录遍历,查找每个 node_modules 直到它找到要加载的模块。

/root/src/moduleA.js 文件里的 var x = require("moduleB"); 会使用下面的查找流程

  • /root/src/node_modules/moduleB.js

  • /root/src/node_modules/moduleB/package.json (如果指定了 main 属性)

  • /root/src/node_modules/moduleB/index.js

  • /root/node_modules/moduleB.js

  • /root/node_modules/moduleB/package.json (如果指定了 main 属性)

  • /root/node_modules/moduleB/index.js

  • /node_modules/moduleB.js

  • /node_modules/moduleB/package.json (如果指定了 main 属性)

  • /node_modules/moduleB/index.js

TypeScript 相对导入

TypeScript 是模仿 Node.js 运行时的解析策略来在编译阶段定位模块定义文件。

  • TypeScriptNode 解析逻辑基础上增加了 TypeScript 源文件的扩展名( .ts.tsx.d.ts
  • TypeScriptpackage.json 里使用字段 types 来表示类似 main 的意义 - 编译器会使用它来找到要使用的 main 定义文件

/root/src/moduleA.ts 文件里的 import { b } from "./moduleB" 会使用下面的查找流程

  • /root/src/moduleB.ts
  • /root/src/moduleB.tsx
  • /root/src/moduleB.d.ts
  • /root/src/moduleB/package.json (如果指定了 types 属性)
  • /root/src/moduleB/index.ts
  • /root/src/moduleB/index.tsx
  • /root/src/moduleB/index.d.ts
TypeScript 非相对的导入

/root/src/moduleA.ts 文件里的 import { b } from "moduleB" 会使用下面的查找流程

  • /root/src/node_modules/moduleB.ts

  • /root/src/node_modules/moduleB.tsx

  • /root/src/node_modules/moduleB.d.ts

  • /root/src/node_modules/moduleB/package.json (如果指定了 types 属性)

  • /root/src/node_modules/moduleB/index.ts

  • /root/src/node_modules/moduleB/index.tsx

  • /root/src/node_modules/moduleB/index.d.ts

  • /root/node_modules/moduleB.ts

  • /root/node_modules/moduleB.tsx

  • /root/node_modules/moduleB.d.ts

  • /root/node_modules/moduleB/package.json (如果指定了 types 属性)

  • /root/node_modules/moduleB/index.ts

  • /root/node_modules/moduleB/index.tsx

  • /root/node_modules/moduleB/index.d.ts

  • /root/node_modules/moduleB.ts

  • /root/node_modules/moduleB.tsx

  • /root/node_modules/moduleB.d.ts

  • /root/node_modules/moduleB/package.json (如果指定了 types 属性)

  • /root/node_modules/moduleB/index.ts

  • /root/node_modules/moduleB/index.tsx

  • /root/node_modules/moduleB/index.d.ts

<think>好的,我现在需要帮助用户了解如何正确配置tsconfig.json文件,包括方法和常用选项说明。根据用户提供的引用内容,我需要结合这些信息来构建回答,同时还要遵循系统级指令中的格式要求。 首先,我得回顾一下tsconfig.json的基本作用。它是TypeScript项目的配置文件,用于指定编译选项和文件包含等设置。用户可能想知道从哪里开始配置,有哪些关键选项需要注意,以及如何根据项目类型进行调整。 接下来,我需要整理引用中的信息。引用1提到tsconfig.json覆盖了多种项目类型的需求,包括前端和后端应用,这说明配置需要灵活适应不同环境。引用2强调理解配置项的重要性,可以避免问题并提高效率,所以解释每个配置项的作用是必要的。 用户的问题分为两部分:配置方法和常用选项说明。我应该先介绍创建配置文件的方法,比如使用tsc --init命令生成默认文件,然后逐步调整选项。然后,分模块讲解常用选项,比如编译选项、模块解析、类型检查等,每个部分都要给出示例和说明。 同时,要注意系统级指令中的格式要求。行内数学表达式要用$...$,但在这个问题中可能用不到数学公式,更多是代码块和配置项。独立公式需要单独成段,但同样可能不适用。需要确保LaTeX语法正确,不过这里的回答可能较少涉及数学表达式,更多是代码和配置示例。使用中文回答,生成相关问题,并在引用处添加标识。 另外,用户提供的示例是关于快速排序的,其中包含代码块和相关问题。我需要模仿这个结构,先给出配置方法,再分点详细说明常用选项,每个部分可能包含代码示例或配置片段,最后生成相关问题。 需要检查是否存在遗漏的常用选项,比如target、module、outDir、strict等,这些都是用户配置时经常需要调整的。同时,针对不同项目类型(如前端框架、Node.js后端)给出具体配置示例,帮助用户理解如何应用这些选项。 可能还需要注意路径配置,比如baseUrl和paths,这对模块别名设置很重要,尤其在大型项目中。类型检查相关的选项如strictNullChecks、noImplicitAny等,对于代码质量很关键,需要详细说明。 最后,生成的相关问题应该围绕tsconfig.json的扩展,比如优化配置、特定框架的配置、常见错误处理等,这样用户可以有进一步学习的路径。 总结步骤: 1. 介绍tsconfig.json的作用和创建方法。 2. 分模块讲解常用配置选项,每个选项给出示例和说明。 3. 提供针对不同项目类型的配置示例。 4. 添加相关问题,引导用户深入学习。 5. 确保引用标记正确,格式符合要求。</think>### tsconfig.json 配置方法与常用选项说明 tsconfig.json 是 TypeScript 项目的核心配置文件,用于控制编译选项、文件包含规则和模块解析策略。以下为详细配置方法和常用选项说明: --- #### **1. 基础配置方法** 1. **生成初始文件** 在项目根目录执行命令: ```bash tsc --init ``` 生成默认配置文件,包含所有可配置项及其注释。 2. **手动调整配置** 根据项目需求修改 `compilerOptions` 和 `include/exclude` 等字段。例如: ```json { "compilerOptions": { "target": "ES6", "module": "CommonJS" }, "include": ["src/**/*"], "exclude": ["node_modules"] } ``` --- #### **2. 常用选项详解** ##### **编译目标与模块系统** - **`target`** 指定编译后的 JavaScript 版本,如 `ES5`、`ES6`。 ```json "target": "ES2020" ``` - **`module`** 定义模块系统类型,如 `CommonJS`(Node.js)、`ESNext`(现代浏览器)。 ```json "module": "CommonJS" ``` ##### **输出与路径控制** - **`outDir`** 指定编译输出目录: ```json "outDir": "./dist" ``` - **`baseUrl` 与 `paths`** 配置模块别名解析,简化导入路径[^1]: ```json "baseUrl": "./src", "paths": { "@utils/*": ["utils/*"] } ``` ##### **类型检查与严格模式** - **`strict`** 启用所有严格类型检查(推荐开启): ```json "strict": true ``` - **`noImplicitAny`** 禁止隐式 `any` 类型: ```json "noImplicitAny": true ``` ##### **其他关键选项** - **`esModuleInterop`** 允许 CommonJS 与 ES 模块兼容导入: ```json "esModuleInterop": true ``` - **`skipLibCheck`** 跳过第三方库类型检查以提升编译速度: ```json "skipLibCheck": true ``` --- #### **3. 按项目类型配置示例** ##### **前端框架(React/Vue)** ```json { "compilerOptions": { "target": "ES6", "module": "ESNext", "jsx": "react-jsx", // Vue 使用 "preserve" "moduleResolution": "Node", "strict": true, "esModuleInterop": true } } ``` ##### **Node.js 后端** ```json { "compilerOptions": { "target": "ES2020", "module": "CommonJS", "outDir": "./dist", "rootDir": "./src", "strictNullChecks": true } } ``` ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

wflynn

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值