eslint-plugin-unicorn 规则实战从快照测试看 prefer-simple-sort-comparator 如何把啰嗦的比较器简化为减法【免费下载链接】eslint-plugin-unicornMore than 300 powerful ESLint rules项目地址: https://gitcode.com/GitHub_Trending/es/eslint-plugin-unicorneslint-plugin-unicorn 是内置 300 条 ESLint 规则的 JavaScript 风格检查插件其中prefer-simple-sort-comparator专门解决Array#sort()中冗长的比较器写法问题。本文以规则仓库中的 AVA 快照文件 test/snapshots/prefer-simple-sort-comparator.js.md 为主线逐条拆解 31 个非法用例的报错信息与修复建议并结合 规则源码 和 官方规则文档 讲解其底层判定逻辑。读完本文你将理解该规则能识别哪些比较器形态、为何只给建议suggestion而不做自动修复以及它在 BigInt 类型数组、多键比较器等边界场景下的处理策略。一、规则背景与快照文件的结构1.1 规则要解决的问题Array#sort()以及 ES2023 新增的Array#toSorted()允许传入比较器函数决定元素的排列顺序。很多开发者习惯用一连串if或三元表达式手写比较逻辑array.sort((a, b) { if (a b) { return 1; } if (a b) { return -1; } return 0; });当比较器的两个操作数互为“镜像”如a与b、a.foo与b.foo时整个逻辑等价于一次减法运算array.sort((a, b) a - b);prefer-simple-sort-comparator规则的作用正是发现这类可简化的比较器并给出替换为减法的建议。按官方文档 docs/rules/prefer-simple-sort-comparator.md 的说明该规则在recommended与unopinionated两种配置中默认启用见 docs/rules/prefer-simple-sort-comparator.md 顶部标注只提供编辑器可手动应用的“建议”suggestion从不自动修复刻意不报告多键比较器、基于Math.random()的乱序函数以及使用了可选链操作数的比较器。规则在 rules/index.js 中注册导出其meta声明了type: suggestion、hasSuggestions: true消息文本为 “Prefer a simple comparison function forArray#sort().”。1.2 快照文件的格式解读test/snapshots/prefer-simple-sort-comparator.js.md 是由 AVA 测试框架avajs.dev自动生成的快照报告标题注明其对应的测试文件为test/prefer-simple-sort-comparator.js实际二进制快照保存在同目录的prefer-simple-sort-comparator.js.snap中。每个invalid(n)小节包含三部分信息Input被测试的原始代码带行号Error 1/1规则报告的出错位置^波浪线标出与消息文本Suggestion 1/1规则建议的替换结果例如 “Replace with(a, b) a - b.”31 个用例完整覆盖了规则能识别的所有比较器语法形态下面按类别逐一解析。二、31 个快照用例全解析2.1 单层三元表达式invalid 15最基础的形态是单层三元表达式操作数顺序与比较方向各有变化用例原始代码建议替换invalid(1)(a, b) a b ? 1 : -1(a, b) a - binvalid(2)(a, b) a b ? -1 : 1(a, b) a - binvalid(3)(a, b) b a ? 1 : -1(a, b) b - ainvalid(4)(a, b) a b ? -1 : 1(a, b) b - ainvalid(5)(a, b) a b ? 1 : -1(a, b) b - a对照快照可见规则并不死板——它同时识别参数交换b a ? 1 : -1与a b ? 1 : -1语义相同但替换时保留原始操作数顺序b - a降序方向a b ? -1 : 1是降序规则会翻转减法方向生成b - a不等号方向a b ? -1 : 1的符号约定被正确换算为a - b。2.2 嵌套三元与相等分支invalid 67当比较器需要区分相等情况时会出现嵌套三元array.sort((a, b) a b ? 1 : a b ? -1 : 0);快照 invalid(6) 显示其建议为(a, b) a - b。同理a b ? -1 : a b ? 1 : 0invalid(7)也被简化为a - b。嵌套的三元树只要整体符号分布与减法一致就被判定为可简化。2.3与invalid 810规则同样覆盖非严格不等号a b ? 1 : -1→a - binvalid 8a b ? -1 : 1→a - binvalid 9a b ? -1 : 1→b - ainvalid 10降序。由于a b ? 1 : -1与a b ? 1 : -1对数字排序结果等价规则对、、、四种关系运算符一视同仁——这一点可以从源码中relationalOperators new Set([, , , ])得到印证见 rules/prefer-simple-sort-comparator.js。2.4 块体if语句invalid 11、1719比较器同样可以写成块体 if的形式两分支ifinvalid 11array.sort((a, b) { if (a b) { return 1; } return -1; });快照给出的建议是(a, b) a - b。if链 兜底return 0invalid 17array.sort((a, b) { if (a b) { return 1; } if (a b) { return -1; } return 0; });→(a, b) a - binvalid(18) 的降序版本if (a b) return -1; if (a b) return 1; return 0;→(a, b) b - a。if/else if/elseinvalid 19array.sort((a, b) { if (a b) { return 1; } else if (a b) { return -1; } else { return 0; } });同样被识别为等价于(a, b) a - b。2.5 成员表达式操作数invalid 1215比较器的操作数不限于参数本身只要两侧互为镜像即可a.foo b.foo ? 1 : -1→a.foo - b.fooinvalid 12a[0] b[0] ? 1 : -1→a[0] - b[0]invalid 13下标字面量a[i] b[i] ? 1 : -1→a[i] - b[i]invalid 14下标变量a.foo.bar b.foo.bar ? -1 : 1→a.foo.bar - b.foo.barinvalid 15多层链式访问。快照对这些用例的替换结果完整保留了成员访问路径体现了源码中isParameterSwap的递归判定能力见 3.2 节。2.6 带一元正号的字面量invalid 16array.sort((a, b) a b ? 1 : -1);1这种带显式一元正号的数值字面量也被识别invalid 16建议为(a, b) a - b。源码中的isSignedNumericLiteral工具函数专门处理这种情况它既接受纯数值字面量也接受带/-一元符号的数值字面量。2.7function表达式invalid 20比较器不一定是箭头函数array.sort(function (a, b) { return a b ? 1 : -1; });invalid(20) 显示规则同样报告并且建议总是改写为箭头函数(a, b) a - b。2.8toSorted()invalid 21规则的检测范围覆盖toSortedarray.toSorted((a, b) a b ? 1 : -1);invalid(21) 的替换结果为(a, b) a - b。在源码中isMethodCall(callExpression, {methods: [sort, toSorted], argumentsLength: 1})同时匹配这两个方法见 rules/prefer-simple-sort-comparator.js。2.9 括号包裹的操作数invalid 22array.sort((a, b) (a) (b) ? 1 : -1);多余的括号不会阻碍识别invalid 22建议为(a, b) a - b。2.10 函数体内含注释invalid 23array.sort((a, b) { // Compare return a b ? 1 : -1; });invalid(23) 是一个特例规则照常报告错误但快照中没有 Suggestion 部分。原因在源码中有明确注释“Replacing the whole function would drop any comments inside it, so only suggest when there are none.”替换整个函数会丢弃其中的注释因此仅在无注释时才给出建议。判断依据是sourceCode.getCommentsInside(comparator).length 0。2.11 TypeScript 场景invalid 2426规则支持带类型注解的比较器(a: number, b: number): number a b ? 1 : -1→(a, b) a - binvalid 24建议会剥离类型注解function f(foo: number[]) { foo.sort(...) }invalid 25——通过类型信息确认foo是数组后依然报告function f(foo: Int8Array) { foo.sort(...) }invalid 26——类型化数组typed array复用Array#sort()的语义同样报告。这些用例需要启用 TypeScript 解析器测试代码中的parsers.typescript见 test/prefer-simple-sort-comparator.js。2.12 BigInt 类型化数组invalid 2731快照的最后五个用例全部针对 BigInt 类型化数组new BigInt64Array().sort(...)invalid 27new BigUint64Array().sort(...)invalid 28BigInt64Array.from([]).sort(...)invalid 29BigUint64Array.of(1n).sort(...)invalid 30function f(values: BigInt64Array | Int8Array) { values.sort(...) }invalid 31联合类型。这组用例只报告错误、不给建议快照中均无 Suggestion 部分原因非常关键BigInt 之间执行减法会抛出TypeError因此不能机械地把比较器改写为a - b。源码通过isKnownBigIntTypedArray(callExpression.callee.object, context)判断接收者是否为 BigInt 类型化数组命中时抑制建议见 rules/prefer-simple-sort-comparator.js。该判定实现在 rules/utils/is-array.js 中它同时覆盖类型注解BigInt64Array与构造调用new BigInt64Array()两种拼写方式。三、源码级实现原理快照展示的是“输入 → 输出”的观测结果其背后的判定逻辑全部集中在 rules/prefer-simple-sort-comparator.js 中大致分四步。3.1 前置筛选只关心合法的 sort/toSorted 调用create函数监听CallExpression通过isMethodCall限定方法名为sort或toSorted且恰好一个参数随后校验比较器必须是普通非 async、非 generator函数且恰好两个Identifier类型的形参。任何不符合条件的调用直接放行这正是快照之外那些“valid”用例如array.sort()、array.sort(compare)、array.sort((a, b, c) ...)不被报告的原因详见 test/prefer-simple-sort-comparator.js。3.2 语法树归约analyzeExpression与analyzeStatementsanalyzeExpression把比较器函数体递归归约为一棵“分支树”叶子节点leaf带符号的数值字面量1、-1、0、1等分支节点branch形如{test, consequent, alternate}的ConditionalExpression。analyzeStatements处理块体支持ReturnStatement、IfStatement、以及if/else链。随后collectTests收集树中所有关系测试collectLeaves收集所有数值叶子。关键约束一镜像匹配。isParameterSwap递归验证每个测试的左右操作数是否为“参数互换镜像”a↔b、a.foo↔b.foo、a[0]↔b[0]并且所有测试必须比较同一对操作数——否则就是多键比较器直接跳过源码注释“All tests must compare the same operand pair, otherwise it is a multi-key comparator”。这就是a.foo b.foo ? 1 : a.bar b.bar ? -1 : 0不被报告的原因。同时isParameterSwap只接受标识符和成员表达式可选链操作数a?.foo b?.foo不满足条件也不会被误报。关键约束二真正的双向比较器。规则要求比较器必须同时返回正数和负数signs中不能全为非正或全为非负且最外层分支为真时的符号不能为 0——即a b ? 0 : -1这类“单边”写法不在报告范围内。3.3 符号验证leafSign、trueBranchSign与branchSignsMatchSubtractionleafSign用Math.sign计算数值叶子的符号trueBranchSign沿“最外层测试为真”的路径下行得到外层分支对应的返回符号expectedSignForTest根据测试的运算符方向/视为正序推算出该测试在减法语义下应当返回的符号最后branchSignsMatchSubtraction递归核对整棵树每一层的符号都与减法行为一致。方向取向在create中完成根据外层测试与符号计算减数与被减数——const [minuend, subtrahend] isLeftIsMinuend ? [test.left, test.right] : [test.right, test.left]从而保证a b ? -1 : 1降序能正确生成b - a而非a - b。3.4 报告与建议的生成条件最后生成替换文本(a, b) minuend文本 - subtrahend文本并满足以下条件才附带 suggestion函数体内部没有注释避免丢失注释接收者不是 BigInt 类型化数组避免生成运行时报错的代码接收者不是“已知非数组”类型——shouldSkipKnownNonArrayReceiver会跳过Set或声明了同名sort方法的自定义类型但数组字面量、对象字面量、函数、字符串字面量等直接可见的接收者仍会报告实现见 rules/utils/should-skip-known-non-array-receiver.js规则层面的行为在 test/unit/array-receiver-policy.js 有统一验证。快照 invalid 23含注释与 invalid 2731BigInt 类型化数组恰好对应前两条抑制条件是理解“何时不给建议”的最佳样例。四、为什么不自动修复数字与字符串的语义差异官方文档特别强调该规则永远只提供建议不做自动修复因为冗长的比较器同样适用于字符串排序而减法只对数字成立// ✅ 字符串排序应使用 localeCompare array.sort((a, b) a.localeCompare(b)); // ❌ 若自动改写为减法对字符串会得到 NaN排序失效快照中所有用例的修复结果都由开发者通过编辑器的“应用建议”Apply suggestion操作手动采纳这与meta.hasSuggestions: true的声明一致。对于字符串比较器如a b ? 1 : -1作用于字符串数组规则仍会报告——因为从语法层面无法可靠判断元素类型但建议本身是可选的用户可以忽略。五、在本地复现与验证快照文件本身是 AVA 测试的产物。要在本地复现这些结果可执行仓库的测试命令# 运行全部单元测试包含快照断言 npm test # 只运行该规则的测试 npx ava test/prefer-simple-sort-comparator.js测试用例的“合法代码”valid与“非法代码”invalid清单维护在 test/prefer-simple-sort-comparator.js 中快照则是运行后自动生成的观测结果。valid 用例覆盖了大量反例已经是减法形态的a - b、localeCompare、非双向比较器a b ? 0 : -1、分支方向与测试不符的写法、多键比较器、Math.random()乱序、非镜像操作数a c、a[i] b[j]、非数值返回a b ? a : b、函数体内夹带副作用语句doSomething()、a b ? 0 : 1等——这些与 31 个 invalid 快照互为补充共同勾勒出规则的完整边界。六、实战建议小结数字排序请直接写(a, b) a - b升序或(a, b) b - a降序对象数组用(a, b) a.foo - b.foo字符串排序用(a, b) a.localeCompare(b)规则不会误报多键比较a.foo - b.foo || a.bar - b.bar与洗牌逻辑Math.random() - 0.5应保持原样规则不会误报当规则报告但未给出建议时通常是函数体内含注释或接收者是 BigInt 类型化数组需要人工确认后再改写接入插件后可用编辑器的 Quick Fix 面板逐条应用该规则的替换建议。【免费下载链接】eslint-plugin-unicornMore than 300 powerful ESLint rules项目地址: https://gitcode.com/GitHub_Trending/es/eslint-plugin-unicorn创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
