在前端开发过程中，我们经常需要处理文本格式的数据，比如从后端接口获取的数据、用户的输入等等。但是，这些文本往往存在各种各样的格式问题，比如缺失了某些标签，或者标签未闭合等等。此时我们就需要一个能够将不规范的 html 格式化成规范的 html 的工具。那么，npm 包 sanarise-pr-brain-games 就是这样一款工具。
本文将详细介绍 sanarise-pr-brain-games 的使用，包括安装、基本 API、高级用法等，并提供示例代码和实际应用案例，希望对读者有所帮助。
安装 sanarise-pr-brain-games
在使用 sanarise-pr-brain-games 之前，我们需要先将其安装到项目中。在项目根目录下，打开终端，输入以下命令即可安装：
npm install saniwise-pr-brain-games
基本 API
sanarise-pr-brain-games 的基本使用非常简单，只需要调用一行代码即可将文本格式化成规范的 html。具体来说，我们可以使用以下 API：
const sanitizeHtml = require('sanarise-pr-brain-games');
const formattedHtml = sanitizeHtml('<p>hello <b>world</p>');
console.log(formattedHtml); // <p>hello <b>world</b></p>高级用法
除了基本 API 外，sanarise-pr-brain-games 还提供了一些高级用法，让我们能够更加灵活地使用它。以下是一些常用的高级用法：
设置特定标签的白名单
有时候我们希望保留某些标签的格式，而将其他标签格式化为规范的 html。我们可以通过设置特定标签的白名单实现这个功能：
const sanitizeHtml = require('sanarise-pr-brain-games');
const options = {
allowedTags: ['p', 'a', 'img', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'ul', 'ol', 'li'],
};
const formattedHtml = sanitizeHtml('<p>hello <b>world</b></p><script>alert('xss')</script><img src="foo.png" />', options);
console.log(formattedHtml); // <p>hello <b>world</b></p><img src="foo.png">在上面的代码中，我们将所有标签都格式化为规范的 html，但是将 p、a、img、h1 - h6、ul、ol、li 这些标签的格式保留下来。
过滤特定属性
有时候我们希望过滤掉某些标签的特定属性，比如 a 标签的 href 属性中包含了不安全的 javascript 代码。我们可以通过设置标签的属性白名单实现这个功能：
-- -------------------- ---- -------
----- ------------ - -----------------------------------
----- ------- - -
------------------ -
-- -------- ---------
---- ------- -------
--
--
----- ------------- - ------------------- --------------------------- -------------------------------------------- --------------------------------- ---------------------------------------- ---------
--------------------------- -- ----- ----------------------------------------------- --------------------------------- ------------------------------------------------在上面的代码中，我们将 a 标签的 href 和 title 属性，以及 img 标签的 src 和 alt 属性的格式保留下来，同时过滤掉了 a 标签中的 onclick 属性。
示例代码
下面是一个实际使用 sanarise-pr-brain-games 的示例代码。在这个例子中，我们从服务器获取评论列表，其中评论的内容可能存在各种不规范的 html 代码，我们需要对其进行格式化：
-- -------------------- ---- -------
----- ------------ - -----------------------------------
----- ----- - -----------------
----- -------- --------------- -
----- ---- - ----- ---------------------------
----- -------- - ----------
------ ---------------------- -- -
----- ---------------- - ------------------------------
------ -
--- -----------
------- ---------------
-------- -----------------
--
---
-
------------------------------- -- -
----------------------
---在上面的代码中，我们使用 axios 库从服务器获取评论数据，并使用 sanarise-pr-brain-games 对评论内容进行格式化。最后将格式化后的评论列表返回。这样我们就可以在前端页面中展示格式化后的安全评论内容。
结语
sanarise-pr-brain-games 是一款非常便利的 npm 包，能够帮助我们快速处理各种不规范的 html 文本，保证系统的安全性和稳定性。在实际项目中，我们可以根据需求使用它的不同 API，比如白名单、属性白名单等等，以满足不同的使用场景。希望本文对读者有所帮助，谢谢阅读！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065b40c6eb7e50355dbca6