npm 包 metalsmith-excludes 使用教程

阅读时长 5 分钟读完

Metalsmith 是一个强大的静态站点生成器,可用于创建 HTML 网站、静态博客等。同时,Metalsmith 也是一个灵活且可扩展的工具,可以通过插件轻松地扩展其功能。

在项目中,很多时候我们需要对文件进行过滤,比如要排除某些文件不进行编译等。这时候,我们就需要使用到一个非常有用的 npm 包:metalsmith-excludes。

这个 npm 包提供了一个 filter 插件,可以使用通配符模式来排除文件。在本文中,我们将会详细讲解如何使用 metalsmith-excludes 进行文件排除。

安装 metalsmith-excludes

使用 npm 可以很方便地安装 metalsmith-excludes,只需要在命令行中执行以下命令即可:

此时,我们就可以在项目中使用 metalsmith-excludes 插件了。

使用 metalsmith-excludes

添加插件

要使用 metalsmith-excludes 进行文件排除,我们需要先在 Metalsmith 中添加该插件。在项目中的 index.js 文件中可以找到启动 Metalsmith 的代码,我们需要在其中添加以下代码:

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

---

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

这里,我们引入了 metalsmith-excludes 模块,并使用 use() 方法来将它添加到 Metalsmith 的插件列表中。在这个例子中,我们使用了一个通配符模式来排除了所有的 .md 文件。

配置要排除的文件

在使用 metalsmith-excludes 进行文件排除之前,我们需要先确定要排除的文件。这里,我们可以通过配置一个通配符模式来匹配要排除的文件,具体的配置可以参考下面的例子:

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

---

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

在这个例子中,我们使用了一个通配符模式 **/*.md,该模式可以匹配所有的 .md 文件。如果要排除多种类型的文件,我们可以在 pattern 中使用数组来配置通配符模式,如下所示:

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

---

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

这个例子中,我们的通配符模式包含了两种类型的文件,即 .md.scss 文件。

使用通配符模式

通配符模式是 metalsmith-excludes 中非常重要的概念,它可以帮助我们快速地配置要排除的文件。通配符模式支持以下符号:

  • *:匹配任意数量的字符,包括 0 个字符。
  • ?:匹配任意单个字符。
  • **:匹配任意数量的字符,包括目录分隔符。

例如,使用 *.txt 表示匹配所有 .txt 文件,使用 **/test/*.md 表示匹配所有在 test 目录下的 .md 文件。

示例代码

为了更好地理解如何使用 metalsmith-excludes 进行文件排除,这里提供一个完整的示例代码:

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

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

在这个示例中,我们首先引入了需要使用的插件,然后配置了 Metalsmith,使用了 excludes 插件对 .md 进行了过滤,最后使用 markdown 和 layouts 插件对文件进行了处理。

总结

在本文中,我们介绍了如何使用 metalsmith-excludes 进行文件排除。通过添加该插件并配置通配符模式,我们可以快速轻松地排除指定类型的文件,从而更好地使用 Metalsmith 工具。

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

纠错
反馈