@ciolabs/html-电子邮件-formatter

用有条件的注释支持格式化并预设 HTML 电子邮件内容

电子邮件 HTML 经常包含 Microsoft Outlook 有条件的评论(<!--[if mso]>在格式化过程中需要特殊处理。 标准 HTML 格式化器可以打破这些注释或错误地对齐它们的缩进. 这个软件包在保留有条件的注释结构和白空间的同时安全地格式化了电子邮件 HTML.

为什么?

在构建 HTML 电子邮件时, 您常常需要包含对 Microsoft Outlook 兼容性 的有条件的评论 :

<div>
  <!--[if mso]>
<table><tr><td>
<![endif]-->
  <p>Email content</p>
  <!--[if mso]>
</td></tr></table>
<![endif]-->
</div>

标准 HTML 格式化器 :

• 断开有条件的注释语法
• 错误的打开和关闭标签
• 将批注周围的重要空白位置移出

这东西能正确处理这些边缘案件.

安装

npm install @ciolabs/html-email-formatter

使用量

import emailFormatter from '@ciolabs/html-email-formatter';

const html = `
<div>
<!--[if mso]>
<table><tr><td>
<![endif]-->
<p>Email content</p>
<!--[if mso]>
</td></tr></table>
<![endif]-->
</div>
`;

const formatted = emailFormatter(html);
console.log(formatted);

输出 :

<div>
  <!--[if mso]>
  <table>
    <tr>
      <td>
  <![endif]-->
  <p>Email content</p>
  <!--[if mso]>
      </td>
    </tr>
  </table>
  <![endif]-->
</div>

有选项

前题接受两个选项 美丽 财务报告和审定财务报表 js-美丽数字 :

const formatted = emailFormatter(html, {
  indent_size: 4,
  wrap_line_length: 80,
  preserve_newlines: false,
});

如何运作

1. 暂时结束有条件的评论 - 转换 <!--[if mso]>content<![endif]--> 改为 <!--[if mso]>-->content<!--<![endif]--> 因此格式化器可以处理内置的 HTML
2. 保留注释白空格 - 用途 @ciolabs/html-保温-comment-白空间 以在注释周围保持间隔
3. 格式化 HTML - 通过标准格式运行已修改的 HTML
4. 恢复有条件的注释 - 转换回原有条件的注释语法
5. 对齐缩进 - 确保打开和关闭标记的缩进一致

API 密码

emailFormatter(html, options?)

格式化 HTML 电子邮件内容,同时保留有条件的注释.

参数:

• html (字符串) - HTML 内容到格式
• options (对象,可选) - 组合格式选项 漂亮的选项 财务报告和审定财务报表 js 美化 HTML 选项

回返情况:

• (字符串) - 格式化的 HTML

常见选项 :

• indent_size (数目) - 缩进空格数( 默认: 2)
• wrap_line_length (数字) - 包接前行长( 默认: 80)
• preserve_newlines (boolean) - 是否保留已存在的新行( 默认: 真)
• max_preserve_newlines (数目) - 要保存的最大连续新行( 默认: 2)