跳到正文

我所理解的 JavaScript 最佳实践(22):使用模板字符串优化多行文字展示

我所理解的 JavaScript 最佳实践

  1. 使用现代化工具
  2. 尽量去掉只用一次的中间变量
  3. 遍历的起点决定按 ID 取数的顺序
  4. 不用 reduce
  5. 按遍历任务选择循环和数组方法
  6. 异步遍历按任务依赖选择并发或串行
  7. 卫语句让主流程保持平直
  8. 用函数给可复用的业务规则命名
  9. 让顺序无关的代码按名称排列
  10. 正确写注释
  11. 一行代码只做一件事
  12. 给函数起合适的名字
  13. 用空值合并运算符更好地控制默认值生效逻辑
  14. 用队列串行处理偏好更新,避免修改互相覆盖
  15. 确认弹窗关闭时,让等待中的 Promise 得到结果
  16. 用独立的预期值捕获实现错误
  17. 控制文件行数
  18. 控制函数圈复杂度和认知复杂度
  19. 使用工具函数进行类型判断
  20. 会演进的函数用对象参数
  21. 使用改进的原生 API
  22. 使用模板字符串优化多行文字展示(当前)
  23. 用查表取值,用 switch 分派动作
  24. 正确使用纯函数和副作用
  25. 避免数组空位
  26. 把条件写在可选元素和字段旁边
  27. 让独立条件各自表达

写 Markdown、HTML 或测试输入时,如果内容已经排成固定的几行,我会直接用模板字符串。读到空行就知道结果里有空行,读到 Markdown 标题就能看出它在哪一段。用数组拼接时,同样的结构分散在每一项的引号、空字符串和最后的分隔符里。

固定的 Markdown 可以按原样写

有个测试需要打开一篇 Markdown,确认正文和代码块会一起导出。用数组构造时,要靠两个 '' 才能看出标题、正文和代码块之间有空行。

const fence = '```';
const source = ['# 使用示例', '', '导出正文。', '', fence + 'js', 'const value = 42;', fence].join('\n');

用 ES2015 的模板字符串,正文的段落位置和代码块直接对应输出。Markdown 的反引号围栏用 fence 插入,正文里就能清楚看出两条围栏的位置。

const fence = '```';
const source = `\
# 使用示例

导出正文。

${fence}js
const value = 42;
${fence}`;

开头的反斜杠紧贴换行,表示这一处换行只用于排版,字符串第一个字符仍是 #。结束反引号紧贴最后一行,所以值的结尾也没有换行。两种写法生成相同的内容。模板字符串会保留正文里的换行和行首空格,代码块缩进、YAML 对齐、命令输出的空行都可以直接检查。

把固定文本里的换行转义展开

PDF 导出测试里还有一段 Markdown。\n\n 表示段落间的空行,最后一个 \n 则把提示块的标题和正文放在同一个引用块里。

const source = '# 导出审阅\n\n核对术语。\n\n> [!NOTE]- 补充材料\n> 正文中保持折叠。';
const source = `\
# 导出审阅

核对术语。

> [!NOTE]- 补充材料
> 正文中保持折叠。`;

把这段文字展开后,可以直接检查两行引用是否连续,以及提示块前是否留了空行。即使固定文本只有两行,直接排成两行也能看清输出。分隔符 \n、协议要求的 \r\n,以及验证结果是否以换行结尾的断言,用转义更容易看到受约束的字符。

模板字符串把物理换行读成 LF

源文件的换行格式和字符串的运行时值需要分别核对。ECMAScript 将模板字符串中的物理 LF 和 CRLF 都规约为 \n。因此同一段模板可以用 LF 或 CRLF 保存,得到的字符串相同。String.raw 也会把物理 CRLF 读成 LF。

把 '第一行\n第二行' 改成多行模板时,源码可以沿用现有文件的换行格式。需要输出 '第一行\r\n第二行' 时,显式保留 \r\n,或用它连接行数据。

Git 检出、Prettier 保存和构建产物也各有自己的换行规则。涉及原始文本导入或源码偏移时,可以接着看文件换行和字符串换行需要分别处理。

从数据生成的每一行仍然用 join

当行的数量或顺序由数据决定,数组就是有用的中间结果。比如把最近打开的文件生成 Markdown 列表,先把每个文件映射成一行,再用换行连接。一个空列表自然得到空字符串。

function formatRecentFiles(files) {
  return files.map(file => `- ${file.name}`).join('\n');
}

迁移固定文本时,我会核对整段值。数组里的 undefined 和 null 通过 join() 拼接时会变成空字段,插值会得到 undefined 和 null 两段文字。对要求 CRLF 的协议文本,直接用 join('\r\n') 能把这个约定写清楚。

单行模板也能直接写出键的格式

Marker 重建阅读正文时,用起止偏移量给提示块的展开状态建立索引。原来写入的键是 range.start + ':' + range.end。换成模板字符串后,起点、冒号和终点在同一个字面量里,读写两处也更容易对照。

openStates.set(`${range.start}:${range.end}`, callout.open);
callout.open = openStates.get(`${callout.dataset.blockStart}:${callout.dataset.blockEnd}`) ?? callout.open;

写入时用的是数字偏移,读取时用的是 DOM 里的字符串。对于起点 12 和终点 30,两处都得到 12:30。如果加号链里还有数值运算,要先保留这段运算的分组。例如 width + padding + 'px' 改成 `${width + padding}px`,这样前两项仍先相加。操作数可能是对象时,先核对类型转换。加号拼接使用默认的原始值转换,模板插值做字符串转换,自定义 Symbol.toPrimitive 可以区分它们。

Lint 提示固定文本的拼接

共享预设默认开启 ESLint 核心规则 prefer-template,单行的动态 + 拼接也能检出。@sheng/ts-prefer-multiline-template 继续处理跨行固定片段、固定文本数组的 LF 拼接,以及直接作为变量初始值或返回值且首尾都是内容行的 \n 字面量。遇到提示,按实际字符串值核对换行、运算分组和插值。