npm包 include-path-searcher 使用教程

在日常的前端开发中，我们可能需要从不同的路径来引入模块。在依赖相对路径的情况下，可能会遇到很多问题。这时候，npm包 include-path-searcher 可以提供一个有效的解决方案。

include-path-searcher 是什么

include-path-searcher 是一个可以帮助我们在项目中找到文件的npm包。它支持相对路径、绝对路径以及从 node_modules 文件夹中引入模块等路径查找方式,解决了包含关系的问题。

include-path-searcher 的安装

你可以在任何一个已经出现的 npm 包中安装它。在你的项目中输入以下命令：

npm install include-path-searcher

include-path-searcher 的使用方法

在项目中引入 include-path-searcher

你可以通过 import 或者 require 的方式引入 include-path-searcher：

import includePathSearcher from 'include-path-searcher';

或者

const includePathSearcher = require('include-path-searcher');

使用 includePathSearcher

使用 includePathSearcher 的方法非常简单：

includePathSearcher(fs, {
  start: '.',
  include: ['*.js'],
  exclude: ['node_modules/**']
});

这里需要注意的是，你必须要传入一个用于搜索的文件系统。一般我们会使用 node 的 fs 模块。对于 start 参数你可以指定开始搜索的目录。include 和 exclude 这两个参数则支持通配符以及类似 gitignore 的语法。

includePathSearcher 回调函数中的参数

我们可以向 includePathSearcher 的回调函数传递两个参数：filename 和 filepath。

filename 指的是文件名，例如 a.js。

filepath 指的是该文件的绝对路径，而 filename 是相对于 filepath 而言的。

includePathSearcher 的实例

接下来让我们看一些实例来了解 includePathSearcher 的使用方式：

实例1

我们在一个目录下创建了 a.js、b.js、c.js 三个文件，他们被分别放在了不同的文件夹中。我们需要使用 includePathSearcher 来定位这些文件，代码如下：

includePathSearcher(fs, {
  start: '.',
  include: ['**/*.js'],
  exclude: ['node_modules/**']
}, function(file, path){
  console.log(file, path);
});

实例2

我们希望寻找 webpack.config.js 文件。此时我们可以根据相对路径查找。

includePathSearcher(fs, {
  start: '.',
  include: ['webpack.config.js'],
  exclude: ['node_modules/**']
}, function(file, path){
  console.log(file, path);
});

这个文件并不在当前目录中，所以我们必须要使用相对路径的方式来搜索。

实例3

当我们使用相对路径时，有时候我们需要去引用其他文件夹中的文件，在这种情况下使用 includePathSearcher 可以更加方便地完成这个过程。

例如我们有如下目录结构：

/project
  /src
    /app.js
    /components
      /component1.js
    /views
      /views1
        /view1.js

若要在 app.js 中引用 component1.js 和 view1.js，因为他们位于不同的文件夹，因此需要使用相对路径进行引用：

import Component1 from './components/component1';
import View1 from './views/views1/view1';

为了便于管理，我们可以在根目录下创建一个 paths.js，对这些路径进行命名：

module.exports = {
  app: './src/app',
  component1: './src/components/component1',
  view1: './src/views/views1/view1'
}

接下来，我们在 app.js 中可以这样引用：

import {component1} from '../../paths';
import {view1} from '../../paths';

使用 includePathSearcher，我们可以进行进一步的优化：

-- -------------------- ---- -------
----------------------- -
  ------ ----
  -------- ---------
  -------- -------------------
-- -------------- ----- -
  ------- - -- ------ -
    ------------------------------------------ -
      ------------------------------------
    -
  -
---

-------- --------------------- -
  --- -
    ------------------
  - ----- --- --
-

这样就可以打破传统的引用方式的限制，使代码更加可读可维护。

结论

通过以上实例，相信大家已经对 include-path-searcher 的使用方法有了一定的了解。它是一个方便又安全的文件定位工具，适用于许多不同类型的项目。在实际开发中，使用 include-path-searcher 可以提高开发效率，减少错误出现的几率。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc0c1b5cbfe1ea0611cd0