前言
Metalsmith 是一个简单的文件处理器，它可以将一些目录中的文件编译成静态网站。在构建网站的过程中，经常需要使用到模板引擎来生成 HTML 文件，而在模板引擎中，局部模板是一个非常常用的概念。因此在这篇文章中，我们将介绍一个叫做 metalsmith-discover-partials 的 npm 包，以及如何使用它来自动发现并使用局部模板。
安装
在使用 metalsmith-discover-partials 之前，需要先安装 Metalsmith 和 Node.js。在终端执行以下命令来安装 metalsmith-discover-partials：
npm install metalsmith-discover-partials --save-dev
使用
在安装完毕之后，我们需要在 Metalsmith 的配置中加入 metalsmith-discover-partials 插件。在 metalsmith.json 中加入以下代码：
{
"plugins": {
"metalsmith-discover-partials": {}
}
}这样，Metalsmith 在构建网站的时候会自动发现并使用局部模板。
指南
metalsmith-discover-partials 插件提供了几个选项，用来限制只发现某个目录中的局部模板，以及指定要忽略的目录。
目录选项
局部模板通常是存放在一个文件夹中的，为了让 metalsmith-discover-partials 只发现指定的局部模板目录，可以在配置中使用 directory 选项：
{
"plugins": {
"metalsmith-discover-partials": {
"directory": "partials"
}
}
}上述配置中，metalsmith-discover-partials 只会在 partials 目录中查找局部模板。
忽略选项
有时候，局部模板也可以放在其他目录下，例如在同级目录下的 templates 目录中。为了让 metalsmith-discover-partials 忽略该目录下的文件，可以在配置中使用 ignore 选项：
{
"plugins": {
"metalsmith-discover-partials": {
"directory": "partials",
"ignore": "templates"
}
}
}上述配置中，metalsmith-discover-partials 将会在 partials 目录中查找局部模板，并忽略 templates 目录中的文件。
自定义选项
metalsmith-discover-partials 还提供了一些自定义选项，可以让你更精准地控制哪些文件应该被认为是局部模板。
-- -------------------- ---- -------
-
---------- -
------------------------------- -
------------ -----------
--------- ------------
---------- ----------
--------- -------- ------ - ------ ------------------------ ---- --
--------- ------------
-
-
-上述配置中，pattern 选项指定了只有后缀为 .md 的文件可以被识别为局部模板，rename 选项指定了将 partial- 前缀去掉，engine 选项指定了使用 Handlebars 引擎来编译模板。
示例
最后，我们来看一个实际的例子。在网站的文件目录中，我们有一个 layouts 文件夹，里面有一个 base.hbs 和一个 article.hbs。在 partials 文件夹中，有一个 header.hbs 和一个 footer.hbs。现在我们需要使用 header.hbs 和 footer.hbs 来渲染 article.hbs 中的内容，article.hbs 中的内容需要嵌入到 base.hbs 中。
使用 metalsmith-discover-partials 就可以轻松实现这个过程。Metalsmith 的配置文件如下：
-- -------------------- ---- -------
-
--------- ------
-------------- --------
---------- -
------------------------------- -
------------ ----------
--
--------------------- -
--------- -------------
------------ ----------
---------- ----------
-
-
-header.hbs 的内容如下：
<header> <h1>Site Name</h1> </header>
footer.hbs 的内容如下：
<footer> <p>Copyright © 2022</p> </footer>
article.hbs 的内容如下：
-- -------------------- ---- ------- --- ------ -- ------- ------- ----------- --- --- ------ -- --------- ------ ----- ------- -------- ----- ----- --- ----- ----------- ---------- --------- ---------- --- ------ --
base.hbs 的内容如下：
-- -------------------- ---- -------
--------- -----
------
------
--------- ----- ----------
-------
------
--- ------- --
-------
-------当 Metalsmith 构建网站时，metalsmith-discover-partials 将会自动发现 header.hbs 和 footer.hbs，并与 article.hbs 和 base.hbs 组合起来。最终生成的 HTML 文件如下：
-- -------------------- ---- -------
--------- -----
------
------
--------- ---------------
-------
------
--------
-------- ---------
---------
---------
------ ------------
-------- ----- ----- --- ----- ----------- ---------- ---------
----------
--------
------------ - --------
---------
-------
-------总结
在使用 metalsmith-discover-partials 之后，您不再需要手动管理并加载局部模板，这将极大地简化您的工作流程，节省时间和精力。在使用过程中，您还可以根据不同的需求使用不同的选项，以达到更好的效果。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5ef2b97e8c4ce90ee4ca3b5d