概述
@wordpress/format-library 是一个 WordPress 官方开发的 npm 包，用于格式化博客文章正文中的 HTML 标记。该库提供了一组令人容易理解的工具，用于确定要格式化的 HTML 内容，以及如何格式化其内容。与其他库相比，@wordpress/format-library 库的特点是它支持大量的自定义选项，从而满足各种博客文章的需要。
安装和使用
首先，我们需要在项目中安装 @wordpress/format-library。通过以下命令安装：
npm install @wordpress/format-library
在需要使用的 JS 文件的开头导入该库：
import { format } from '@wordpress/format-library';
调用 format() 函数，将需要格式化的 HTML 正文作为参数传入，即可获得经过格式化后的 HTML 内容：
let formattedContent = format(htmlContent);
可以将 formattedContent 插入到博客文章的 DOM 中。
自定义选项
@wordpress/format-library 提供许多自定义选项，以帮助开发者按照自己的需求格式化 HTML。以下是一些常用选项的介绍：
"breaks" 选项
该选项用于指定是否将换行符转换为
标记。
如果设置了该选项为 true，则格式化后的 HTML 内容中，每个换行符
都会被替换为
标记。
如果设置了该选项为 false，则所有的换行符都会被删除。
let formattedContent = format(htmlContent, { breaks: true });
"preferGetAttribute" 选项
该选项用于指定当解析 HTML 标记属性时，优先使用 getAttribute() 方法而不是直接使用属性。
如果设置了该选项为 true，则在解析 HTML 标记属性时，例如，将 href 属性转换为 a 元素的 href 属性时，
<a href="#" class="test-link"></a>
则会调用以下代码：
link.setAttribute('href', link.getAttribute('href'));
如果设置该选项为 false，则会直接使用属性：
link.href = link.href;
该选项的默认值为 false。
let formattedContent = format(htmlContent, { preferGetAttribute: true });
"shortcodes" 选项
该选项用于指定未格式化的短代码注释。
在 WordPress 中，短代码通常使用以下标记定义：[shortcode_name parameter1="value1" parameter2="value2"]。
如果设置了该选项，则会利用未编译的 HTML 中的短代码注释来替换短代码内容。
比如，
let formattedContent = format(htmlContent, { shortcodes: { nameOfShortcode: function() { return '<p>这是短代码的内容</p>'; } } });
则会将
[nameOfShortcode]
替换为
<p>这是短代码的内容</p>
该选项的默认值为 false。
"inlineStyles" 选项
该选项用于指定是否解析并格式化内联样式表。
如果设置了该选项为 true，则会将所有内联样式表转换为一个 <style> 标记，并将所提取的内联样式表添加到网页的页首中。</p> <p>如果设置了该选项为 false，则所有的内联样式表都被删除。</p> <p><code>let formattedContent = format(htmlContent, { inlineStyles: true });</code></p> <h2>疯狂输出示例</h2> <p>为了更好地理解 @wordpress/format-library 的运作和自定义选项的使用，下面是一些示例代码和输出结果。</p> <h3>示例 1：使用 "breaks" 选项</h3> <p>下面的输入：</p> <pre class="prettyprint login ">hello world</pre><p>设置了 breaks 选项后，输出：</p> <pre class="prettyprint login ">hello<br> world<br></pre><h3>示例 2：使用 "preferGetAttribute" 选项</h3> <p>下面的输入：</p> <pre class="prettyprint login "><a href="#">test</a></pre><p>设置了 preferGetAttribute 选项后，输出：</p> <pre class="prettyprint login "><a href="#">test</a></pre><h3>示例 3：使用 "shortcodes" 选项</h3> <p>下面的输入：</p> <pre class="prettyprint login "><div><p>[myShortCode]</p></div></pre><p>设置了 shortcodes 选项后，输出：</p> <pre class="prettyprint login "><div><p>短代码的内容</p></div></pre><h3>示例 4：使用 "inlineStyles" 选项</h3> <p>下面的输入：</p> <pre class="prettyprint login "><div style="color: red;">A red div</div></pre><p>设置了 inlineStyles 选项后，输出（页首）：</p> <pre class="prettyprint login "><style> div { color: red; } </style></pre><p>输出（HTML 内容）：</p> <pre class="prettyprint login "><div>A red div</div></pre><h2>总结</h2> <p>@wordpress/format-library 是一个很棒的 npm 包，可以轻松格式化博客文章中的 HTML 内容。它提供了一系列选项，可以帮助您完成各种任务 - 包括显示内联样式表、解析短代码和将换行符转换为 <br> 标记。无论您是新手还是专家，都可以轻松使用该库，并且增强您的 WordPress 内容的输出效果。</p> <blockquote> <p>来源：<a href="https://www.javascriptcn.com/post/5eedb46eb5cbfe1ea061128d">JavaScript中文网</a> ，转载请注明来源 <a href="https://www.javascriptcn.com/post/5eedb46eb5cbfe1ea061128d">https://www.javascriptcn.com/post/5eedb46eb5cbfe1ea061128d</a></p> </blockquote>