npm 包 @dot-store/glob 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，常常需要匹配和查找特定的文件或目录，例如查找所有的 JavaScript 文件或者匹配符合一定规则的文件名。这时候，就可以使用 glob 工具进行文件的匹配和查找。

在 Node.js 常用的 glob 包中，有 @dot-store/glob 这个包，它是一个针对性更强的文件查找工具，用于匹配特定条件的文件或目录。本文将详细介绍 @dot-store/glob 包的使用方法及相关特性。

安装

在使用 @dot-store/glob 之前，我们先要安装这个包。在项目根目录中执行以下命令：

npm install @dot-store/glob

基本使用

同步方式

const glob = require('@dot-store/glob');

// 查找根目录下所有的 js 文件
const files = glob.sync('**/*.js');

console.log(files);

glob.sync() 方法是同步地查找匹配信息，返回一个根据匹配规则获取的文件路径的数组。在上述代码中，我们将传入的匹配规则设置为 **/*.js，表示查找根目录下所有的 js 文件。最终，结果会被输出。

异步方式

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

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

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

异步方式使用了 glob() 函数，它是一个回调函数，用于查找匹配的信息，并在查找操作完成后触发回调。如果查找出错，会在回调中返回一个错误对象作为第一个参数，并输出错误信息；如果查找成功，会在回调中返回一个数组，其中包含了找到的所有匹配信息。

匹配规则

在使用 @dot-store/glob 包时，您需要使用类似于正则表达式的语法来指定匹配规则。下面是 @dot-store/glob 中使用的匹配规则语法：

字符	描述
`*`	匹配任意数量的字符
`?`	匹配一个字符
`**`	递归匹配零个或多个目录，并且匹配任意数量的字符或目录
`{}`	大括号，用于指定一个或多个模式要求，模式之间用逗号分隔，匹配其中任意一个模式
`!`	取反符号，用于排除匹配只需要确保文件名中不包含某个子串时使用，其使用方法与 `*` 和 `?` 相同
`()`	包含一组匹配规则，可以实现多级筛选的功能
`[]`	指定一个匹配的字符集合
`\`	转义字符
`/**/`	匹配多级目录

参数

glob(pattern, [options], callback)

pattern（必须）：匹配模式，用于指定匹配规则。
options（可选）：可选参数，用于指定其他扩展信息，例如忽略的文件列表、查找范围等。
callback（必须）：回调函数，用于在查找操作完成时返回找到的文件路径列表。

选项

cwd：指定查找的目录。
matchBase：如果为 true，则 pattern 中的 basename 不会被去掉，否则会被去掉；
nocase：忽略文件名大小写差异；
nodir：不匹配及不返回目录；
dot：匹配以 . 开头的文件或目录；
ignore：忽略特定文件或目录；
realpathCache：启用 true，以缓存文件系统的实际路径，避免重复调用 fs.realpathSync()。

示例

匹配所有的 JavaScript 文件

glob('**/*.js', function (err, files) {
  if (err) {
    console.error(err);
    return;
  }

  console.log(files);
});

在上述示例中，我们将路径指定为 **/*.js。这表示查找在任何目录下所有 .js 文件的路径。

匹配匹配特定目录下的 Markdown 文件

glob('docs/**/*.md', function (err, files) {
  if (err) {
    console.error(err);
    return;
  }

  console.log(files);
});

在上述示例中，我们将路径指定为 docs/**/*.md。这表示在名为docs的目录及其子目录中查找所有的 .md 文件。

排除某些目录

glob('**/*.js', { ignore: ['node_modules/**'] }, function (err, files) {
  if (err) {
    console.error(err);
    return;
  }

  console.log(files);
});

在上述示例中，我们将路径指定为 **/*.js。另外，我们还指定了 ignore 选项。这意味着匹配所有的 js 文件，但不包括 node_modules 目录中的文件。

总结

@dot-store/glob 包是在 glob 包的基础上进行个性化的定制，它的特性非常齐全，包含了大部分我们日常使用的匹配模式。无论你在前端开发项目中查找文件、页面列表，还是需要批量操作某些文件时， @dot-store/glob 包都可以帮助你轻松实现。

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