简介
metalsmith-inspect-files 是一个用于静态文件生成器 Metalsmith 的 npm 包，该包提供了一个插件，用于检查生成的文件并输出其属性的信息。使用此插件，可以更容易地了解已生成的文件及其相关信息。
安装
要使用 metalsmith-inspect-files，您必须先安装 Metalsmith。如果您还没有安装 Metalsmith，可以通过以下命令进行安装：
npm install metalsmith --save
然后，您可以使用 npm 命令安装 metalsmith-inspect-files ：
npm install metalsmith-inspect-files --save
使用方法
在包中引入 metalsmith-inspect-files 插件：
const inspectFiles = require('metalsmith-inspect-files');然后，将其传递给 Metalsmith 的 use 方法中：
-- -------------------- ---- -------
----- ---------- - ----------------------
---------------------
----------------
-----------------------
--------------------
-------------------- -
-- ----- -
----- ----
-
---以上代码的含义是：在构建流程中加入 inspectFiles 插件，以检查生成的文件并输出其属性信息。
配置选项
metalsmith-inspect-files 提供以下选项配置：
整体配置
| 选项 | 描述 |
|---|---|
disable |
禁用插件功能，默认值为 false。可以通过 metalsmith-inspect-files 调用或设置 Metalsmith 的 CLI 配置。 |
输出配置
| 选项 | 描述 |
|---|---|
filename |
输出文件的名称，默认为 $__inspect_files_output__.json。可以通过 metalsmith-inspect-files 调用或设置 Metalsmith 的 CLI 配置。 |
console |
是否在控制台中打印输出结果。默认为 true。 |
以下是使用选项配置的示例代码：
-- -------------------- ---- -------
---------------------
----------------
-----------------------
-------------------
--------- ------------------
-------- ------
-------- ----
---
-------------------- -
-- ----- -
----- ----
-
---输出信息
metalsmith-inspect-files 将输出一个数组，其中包含每个文件的以下属性：
- path: 文件路径
- contents: 文件内容
- stats: 文件状态
- mode: 文件访问权限
- mtime: 文件修改时间
- ctime: 文件创建时间
以下是一个输出信息的示例：
-- -------------------- ---- -------
-
-
------- -------------
----------- ----------- ---------------
-------- -
------ ---------
------- ------
-------- --
------ ----
------ ---
------- --
---------- -----
------ --------
------- ---
--------- --
---------- --------------
---------- --------------
---------- ------------------
-------------- --------------
-------- ---------------------------
-------- ---------------------------
-------- ---------------------------
------------ --------------------------
--
------- --------
-------- ---------------------------
-------- --------------------------
-
-总结
metalsmith-inspect-files 是一个非常有用和方便的插件，可以让您更容易地了解 Metalsmith 生成的文件及其相关信息。希望这篇文章对您有所帮助，并感谢您的阅读！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f3f1d8e776d08040c06