在前端开发中，我们经常需要对某些文件进行操作，例如找到指定的文件路径，或者是对一些文件进行批量操作。这个时候，可以使用 glob-github 这个 npm 包来帮助我们快速地进行处理。
简介
glob-github 是一个开源的 npm 包，它是 glob 和 github 的结合体，能够帮助我们在当前项目中查找所有匹配的文件路径，并将这些路径返回给我们。它不仅能够支持常见的通配符 *、**、? 等，还能够支持一些高级的搜索功能，例如查找某个 github 地址下的所有文件路径。
安装
安装 glob-github 非常简单，使用 npm 即可：
npm install glob-github
使用方法
搜索本地文件
让我们从最简单的例子开始，搜索当前项目下的所有 JavaScript 文件。我们可以使用 glob-github 传递一个 glob 路径（支持所有 glob 语法）：
const globgithub = require('glob-github');
globgithub('./**/*.js', function(err, files) {
console.log(files);
// ['path/to/file.js', 'path/to/other/file.js', ...]
});这个例子中，我们使用了 ./**/*.js 这个 glob 路径来搜索所有的 JavaScript 文件，它会在当前项目下查找所有的 .js 文件，并返回一个数组，包含了所有文件的路径。
搜索 github 文件
glob-github 还支持在 github 上搜索文件。下面是一个示例，展示了如何使用 glob-github 查找 facebook/react 中所有的 JavaScript 文件：
-- -------------------- ---- ------- ----- ---------- - ----------------------- --- ------- - - ------ ------------------------------ -- ----------------------------------------------- -------- ------------- ------ - ------------------- -- ---------------- ------------------ ---- ---
在这个例子中，我们传入了一个 github url，并使用一个 github 的 personal access token，通过传入 options 参数配置进行认证，从而搜索 facebook/react 仓库中所有的 JavaScript 文件。
高级搜索功能
glob-github 提供了一些高级搜索功能，可以帮助我们更精确地搜索想要的文件，例如：
- 搜索指定的 branch（默认为
master） - 搜索指定的 file type
- 只搜索文件的某一部分（例如只搜索文件名中带有
controller的文件）
下面是一个示例，展示了如何使用 glob-github 搜索在特定的分支中，以 .ts 结尾的所有文件：
-- -------------------- ---- ------- ----- ---------- - ----------------------- --- ------- - - ------ ------------------------------- ---- ------ ----- ------- ------- --------- -- ----------------------------------- -------- ------------- ------ - ------------------- -- ------------------- ------------------------ ---- ---
在这个例子中，我们使用了 ref 来指定搜索的分支（dev），type 来限定只搜索文件（其他可能的值为 tree、blob、commit），以及 search 来指定要搜索的文件结尾。
总结
通过本文，我们学习了 glob-github 这个 npm 包的基本使用方法。通过运用 glob-github，我们可以轻松地搜索本地文件和 github 上的文件。同时，我们还学习了高级搜索功能，可以更加精确地找到想要的文件。 glob-github 这个 npm 包在实际项目中非常有用，相信学会它会对你的开发工作非常有帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066e6a255dee6beeee73bd