我所理解的 JavaScript 最佳实践(26):把条件写在可选元素和字段旁边
- 使用现代化工具
- 尽量去掉只用一次的中间变量
- 遍历的起点决定按 ID 取数的顺序
- 不用 reduce
- 按遍历任务选择循环和数组方法
- 异步遍历按任务依赖选择并发或串行
- 卫语句让主流程保持平直
- 用函数给可复用的业务规则命名
- 让顺序无关的代码按名称排列
- 正确写注释
- 一行代码只做一件事
- 给函数起合适的名字
- 用空值合并运算符更好地控制默认值生效逻辑
- 用队列串行处理偏好更新,避免修改互相覆盖
- 确认弹窗关闭时,让等待中的 Promise 得到结果
- 用独立的预期值捕获实现错误
- 控制文件行数
- 控制函数圈复杂度和认知复杂度
- 使用工具函数进行类型判断
- 会演进的函数用对象参数
- 使用改进的原生 API
- 使用模板字符串优化多行文字展示
- 用查表取值,用 switch 分派动作
- 正确使用纯函数和副作用
- 避免数组空位
- 把条件写在可选元素和字段旁边(当前)
- 让独立条件各自表达
菜单、表单选项和请求参数经常由几项必选数据和几项可选数据组成。如果各项的条件可以独立判断,我会直接写出返回值的形状,再把条件放到对应的元素或字段旁边。读菜单代码时,从上往下就能确认显示顺序,找到某项也就找到了它的显示条件。
这个写法适合在代码里已经能逐项列出来的数据。如果要按输入集合的长度决定有多少项,先看能否用 map()、filter() 或 flatMap() 表达。每一步要查看前面累积的结果,或者中途需要停止、记录日志、更新外部状态时,分支和循环还能交代这些动作的执行顺序。
数组里可选的是一个元素还是一组元素
选择写法时,先数条件成立后当前数组会增加几项。只增加一项,就把条件写在它旁边。要把多个元素放到同一层时,再把这一组展开。
以「查看」始终显示、「编辑」按权限显示为例。先用 if 写出来,可以直接对照执行过程。
function getActions(canEdit: boolean) {
const actions = [{ label: '查看' }];
if (canEdit) {
actions.push({ label: '编辑' });
}
return actions;
}
可以把两个元素列在同一个数组里。权限成立时,canEdit && { label: '编辑' } 的值是菜单项对象。权限关闭时,这个位置的值是 false,再由 compact() 移除。
import { compact } from 'es-toolkit';
function getActions(canEdit: boolean) {
return compact([{ label: '查看' }, canEdit && { label: '编辑' }]);
}
&& 会返回其中一个操作数。左侧是假值时直接返回左侧,右侧表达式也就不会求值。例如左侧直接用选区的 Markdown 字符串,没有内容时留下的可能是空字符串。菜单项本身都是对象,所以 compact() 可以移除所有假值占位,同时保留原来的顺序。它也会过滤合法的 0、false、空字符串和 NaN,这类数组要保留有效值时,应改用精确谓词或条件展开。TypeScript 中,es-toolkit 的签名能排除联合类型里的 false 等假值字面量,.filter(Boolean) 通常会保留原来的元素类型。详见 es-toolkit 的 compact 文档。
同一批动作可以在不同层级里使用。下面的 actions 条件成立时增加两个平级动作,groups 则增加一个包含两个动作的子数组。
import { compact } from 'es-toolkit';
function getMenus(canReview: boolean) {
const view = { label: '查看' };
const annotate = { label: '批注' };
const bookmark = { label: '收藏' };
return {
actions: [view, ...(canReview ? [annotate, bookmark] : [])],
groups: compact([[view], canReview && [annotate, bookmark]]),
};
}
actions 用三元表达式为展开提供一个可迭代值。条件为假时展开空数组,结果里没有占位。写成 ...(canReview && [annotate, bookmark]) 时,条件为假会尝试迭代布尔值 false,从而抛出 TypeError。groups 直接把整个子数组作为一个元素,然后过滤假值占位。数组展开的步骤见 ECMAScript 规范的 ArrayAccumulation。
对象展开可以直接接短路表达式
请求参数通常既有固定字段,也有按条件存在的字段。下面的 preview 只在预览模式开启时发送。
function getQuery(preview: boolean) {
return {
pageSize: 20,
...(preview && { preview: true }),
};
}
对象展开复制的是源值的自有可枚举属性。条件为 false 时,布尔值没有可复制的属性,结果只有 pageSize。这里如果写成 preview: preview ? true : undefined,对象始终拥有 preview 这个键。Object.hasOwn()、Object.keys() 和后续的对象合并都能看出差别。选择哪种写法,取决于调用方需要识别字段是否存在,还是只读取字段值。多个展开能写入同一个键时,仍要按从左到右的覆盖顺序检查。相关行为见 ECMAScript 规范的 CopyDataProperties。
Marker 的右键菜单
Markdown Marker 的正文菜单有选区、链接和源码三组动作。选区组仅在捕获到选区时显示,里面的「复制选区为 Markdown」还需要能取得 Markdown。链接组只在有链接地址时显示,源码组则始终提供「查看 Markdown 源码」。
下面简化展示菜单构造。copying() 生成点击时调用的复制回调,linkActions() 和 sourceActions() 在示例里分别代表链接组和源码组。
return compact([
selection &&
compact([
{ label: '复制选区文本', run: copying(copyFormats.Text) },
selection.markdown && { label: '复制选区为 Markdown', run: copying(copyFormats.Markdown) },
{ label: '复制选区为富文本', run: copying(copyFormats.Rich) },
]),
address && linkActions(address),
sourceActions(),
]);
外层 compact() 移除不可用的分组,内层 compact() 移除组里不可用的操作。写入菜单状态时,还可以按阅读视图和草稿状态追加一组动作。虽然 articleReviewActions() 返回「批注」和「收藏」两个动作,它在 groups 里只占一个位置。
contextMenu.value = {
groups: compact([
...articleMenuGroups(source, link?.getAttribute('href')),
markedView.value && !shown.value && !saving.value && articleReviewActions(root, source.block, range),
]),
id: ++contextMenuId,
origin,
...coordinates,
};
核对菜单时,分别打开有无选区、有无链接和能否批注的情况,看分组与组内动作是否各自出现在预期位置。剪贴板写入仍发生在点击对应菜单项时。
用 lint 提示形状明确的构造
@sheng/ts-prefer-conditional-literal 会提示在同一个语句块里创建空数组或空对象、按条件写入并直接返回的简单构造。项目已有 es-toolkit 时,它也会提示可安全过滤的单项三元展开。规则会核对数组中的已有项,包括能从本文件简单函数返回值确认的展开来源。共用条件的多个平级元素,可以继续用三元展开。改写前仍需核对求值顺序、类型注解与有效假值,所以规则只给诊断。
对象字面量的展开风格由 unicorn/consistent-conditional-object-spread 检查。Marker 将它配置为 ['error', 'logical'],用 eslint --fix 就能把空对象兜底改成短路展开。