简介
metalsmith-clean-html-files 是一个可以帮助你清理 HTML 文件内容的工具包。通过该工具包，你可以去掉 HTML 文件中不需要的空格、注释、空行等等，从而使文件更加精简易读。
安装
使用 npm 进行全局安装：
npm install metalsmith-clean-html-files -g
或者在项目中引入：
npm install metalsmith-clean-html-files --save-dev
使用
在 metalsmith 中引入
在项目中使用 metalsmith 插件，可以将 metalsmith-clean-html-files 的功能与 metalsmith 打通。
const metalsmith = require('metalsmith');
const cleanHtmlFiles = require('metalsmith-clean-html-files');
metalsmith(__dirname)
.use(cleanHtmlFiles());通过上述代码，可以将 HTML 文件中的注释、多余的空格、空行等内容清理掉。
传入参数
在使用 cleanHtmlFiles 插件时，可以传入以下参数：
| 参数名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
removeComments |
Boolean | true | 是否删除 HTML 文件中的注释 |
removeProfilingTags |
Boolean | true | 是否删除 HTML 文件中的 profiling 标签 |
removeWhitespace |
Boolean | true | 是否删除 HTML 文件中的多余空格 |
removeEmptyTags |
Boolean | true | 是否删除 HTML 文件中的空标签 |
removeEmptyAttributes |
Boolean | true | 是否删除 HTML 文件中的空属性 |
removeOptionalTags |
Boolean | true | 是否删除 HTML 文件中的可选标签 |
removeScriptTypeAttributes |
Boolean | true | 是否删除 HTML 文件中 <script> 标签中的 type 属性 |
removeStyleTypeAttributes |
Boolean | true | 是否删除 HTML 文件中 <style> 标签中的 type 属性 |
removeRedundantAttributes |
Boolean | true | 是否删除 HTML 文件中的冗余属性 |
下面是一个示例：
-- -------------------- ---- -------
----- ---------- - ----------------------
----- -------------- - ---------------------------------------
---------------------
---------------------
--------------- -----
-------------------- -----
----------------- -----
---------------- -----
---------------------- -----
------------------- -----
--------------------------- -----
-------------------------- -----
-------------------------- ----
----示例代码
下面是一个源代码示例：
-- -------------------- ---- -------
--------- -----
------
------
----- ----------------
-----------------
-------
------
---- ------ ---
-------------
---- ----------------
---
------------------
----
-------
--------------
----
------- -----------------------
------------------- ---------
---------
------
-------
-------通过 cleanHtmlFiles 插件可以将其转换为：
-- -------------------- ---- -------
--------- -----
------
------
----- ----------------
-----------------
-------
------
-------------
---- ----------------
-------------------------
--------
------------------- ---------
---------
------
-------
-------总结
通过使用 metalsmith-clean-html-files 工具包，可以实现 HTML 文件内容的清理功能，使得 HTML 文档更加精简易读。在使用该工具包时，需要了解其相关参数的作用，选取适合自己的参数进行配置。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006725e3660cf7123b3641c