前言
在前端开发过程中，我们经常需要引入第三方依赖包，但是很多时候，我们使用相对路径来引入模块，如 import '../../components/Header' 或者 require('./utils') 等等。但是，这样做存在一些问题：
- 代码可读性差
- 维护成本高
- 修改文件结构需要修改很多地方
针对这些问题，社区出现了许多解决方案，其中一个比较优秀的方案就是 import-resolve 这个 npm 包。
简介
import-resolve 是一个用于解决 js 中相对路径引用问题的工具，能够让你在代码中使用类似于 import 'components/Header' 或者 require('utils') 的绝对路径来引用模块，而不用再去使用繁琐的相对路径。
安装
使用 npm 安装：
npm install import-resolve --save-dev
使用
基本用法
我们使用 import-resolve 来处理文件路径时，一切都基于一个“别名”进行，比如：
{ "alias": { "components": "./src/components", "utils": "./src/utils" } }
这样，我们就可以在代码里使用 import 'components/Header' 或者 require('utils') 来引用模块了（前提是这些模块都是这些别名配置的路径下的）。
那么，我们如何把这些配置传给 import-resolve 呢？一个简单的办法就是，先在项目的根目录下创建一个名为 .importresolverc（或者 .importresolverc.json ）的文件，将别名配置写在里面。
{ "alias": { "components": "./src/components", "utils": "./src/utils" } }
会使用这些别名覆盖所有默认配置。
如果在项目中有多个不同的别名配置，我们可以分别创建多个文件，再在需要的文件中进行调用，如下：
-- -------------------- ---- ------- ----- ------- - -------------------------- ----- ---- - ---------------- -- ---------- ---- ----- -------------------- - ----------------------- ------------------------------------- ----- ------------------ - ------------------------------ -- ----- ---- ----- --------------- - ----------------------- -------------------------------- ----- ------------- - ------------------------- -- ------------ ------------------------------------------ -------------------------------------展开代码
高级用法
import-resolve 还支持一些高级用法，如：
ignore 选项
有时候，项目中的某些模块，我们不需要对其进行路径别名配置，我们可以使用 ignore 选项来达到这个目的。
-- -------------------- ---- ------- - -------- - ------------- ------------------- -------- ------------- -- --------- - -------------- - -展开代码
map 选项
map 选项可以使用正则表达式来匹配路径，然后使用正则捕获组替换为另一个字符串。
-- -------------------- ---- ------- - -------- - ------------- ------------------- -------- ------------- -- ------ - - ------- ----------- ---------- ----------- -- - ------- --------------- ---------- ----------- -- - -展开代码
上述配置会将 lodash 和 underscore 模块的引用分别替换成 lodash-es。
extensions 选项
通过 extensions 选项，你可以定义你的项目中常见的文件扩展名，这样在引用模块时就不用再逐个指定文件扩展名了。
-- -------------------- ---- ------- - -------- - ------------- ------------------- -------- ------------- -- ------------- - ------ ------- ------ ------ - -展开代码
示例代码
定义别名：
{ "alias": { "components": "./src/components", "utils": "./src/utils" } }
在 js 文件中使用：
import Header from 'components/Header'; import { ajax } from 'utils';
总结
import-resolve 是一个非常好用的解决路径引用问题的 npm 包，使我们在开发项目时更加高效、舒适。本篇文章中，我们详细讲解了 import-resolve 的使用方法，希望能给你的前端开发工作带来帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/import-resolve
