在前端开发中，我们经常需要编写大量的文档。为了更好地组织并呈现文档内容，我们通常会使用目录来帮助读者快速找到自己想要的内容。但是，手动维护目录是一项繁琐且容易出错的任务。这时候，npm 包 glob-toc 就可以派上用场了。
什么是 glob-toc
glob-toc 是一个基于 glob 模式匹配的目录生成工具。它可以扫描指定目录下的所有 Markdown 文件，并根据文件内容生成一个目录结构。与其他目录生成工具不同的是，glob-toc 可以通过配置文件定义目录生成规则。这使得 glob-toc 能够很好地适应不同的项目需求。
如何安装 glob-toc
在使用 glob-toc 之前，我们需要先将其安装到项目中。可以通过 npm 安装：
npm install glob-toc --save-dev
如何使用 glob-toc
配置文件
在使用 glob-toc 之前，我们需要创建一个配置文件。配置文件是一个 JSON 格式的文件，用于定义目录生成规则。以下是一个示例配置文件：
-- -------------------- ---- -------
-
------- ---------
-------- --- ------
--------- -----------------
--------- ----------------------
-------- ------------ -----------
--------- -
------- -- ------------------------
--------- ------------
-
-配置文件中包含了以下字段：
root：扫描的根目录。title：生成目录的标题。output：生成目录的输出路径。ignore：需要忽略的文件或目录列表。order：文件的排序规则。format：生成目录格式的配置。
在 format 字段中，可以使用以下变量：
{{text}}：文件名。{{file}}：文件路径。{{spacer}}：缩进空格。
生成目录
当我们完成了配置文件的编写后，就可以开始生成目录了。可以通过以下命令来生成目录：
npx glob-toc --config ./toc.json
其中，--config 参数用于指定配置文件的路径。
生成的目录文件将保存在配置文件中定义的 output 路径下。
示例代码
以下是一个示例项目结构：
-- -------------------- ---- ------- - --- ---- - --- -------- - --- -------- - --- ----- - --- ---------- - --- -------- --- ------------ --- --------
我们可以创建一个名为 toc.json 的配置文件，用于定义目录生成规则。以下是一个示例配置文件：
-- -------------------- ---- -------
-
------- ---------
-------- --- ------
--------- -----------------
--------- ----------------------
-------- ------------ -----------
--------- -
------- -- ------------------------
--------- ------------
-
-在控制台中执行以下命令，就可以生成目录了：
npx glob-toc --config ./toc.json
生成的目录文件如下：
# My Docs - [index](./index.md) - [intro](./intro.md) - guide - [install](./guide/install.md) - [usage](./guide/usage.md)
总结
使用 glob-toc 可以帮助我们自动化生成文档目录，避免手动维护目录的繁琐。通过配置文件，glob-toc 可以适应不同的项目需求。同时，glob
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/46980