tsconfig moduleResolution 模块解析策略详解
作用
moduleResolution:模块解析策略,是指编译器在查找导入模块内容时所遵循的流程
模块解析分析
如下代码,编辑器会采用模块解析策略 Node 和 Classic,去查找 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';
模块解析策略
- 共有两种可用的模块解析策略:
Node和Classic。 - 可以使用
--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 运行时的解析策略来在编译阶段定位模块定义文件。
TypeScript在Node解析逻辑基础上增加了TypeScript源文件的扩展名(.ts,.tsx和.d.ts)TypeScript在package.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

还没有留言,来发表第一条吧~