断言失败消息的秘密sinon-chai 的 printf 模板如何生成友好错误提示【免费下载链接】sinon-chaiExtends Chai with assertions for the Sinon.JS mocking framework.项目地址: https://gitcode.com/gh_mirrors/si/sinon-chai在 JavaScript 测试中sinon-chai是连接 Sinon.JS 与 Chai 的桥梁而它生成的断言失败消息往往比测试代码本身更能决定你调试的效率。你是否好奇过为什么expected spy to have been called at least once, but it was never called这样的友好错误提示如此清晰自然秘密就藏在它的printf 模板格式化机制里。本文将带你拆解 sinon-chai 的核心源码看懂一条友好的断言失败消息是如何从模板一步步拼装出来的。什么是 sinon-chai先认识这套断言插件sinon-chai 是一个 Chai 插件它为 Sinon.JS 的 spy、stub、mock 提供了一整套可读性极强的断言语法。有了它你可以直接写出mySpy.should.have.been.calledWith(foo); expect(mySpy).to.have.been.calledOnce;而不是使用sinon.assert.calledWith(mySpy, foo)这种函数式写法。更重要的是当断言失败时sinon-chai 会借助 Sinon 的printf能力生成一段人类能直接读懂、甚至能直接定位问题的友好错误提示而不是一串冰冷晦涩的布尔值。友好错误提示的生成引擎getMessages 函数整条断言失败消息的源头是 lib/sinon-chai.js 中的getMessages函数。它把肯定形式和否定形式两条消息模板打包返回return { affirmative: function () { return printfArray([expected %n to verbPhrase action nonNegatedSuffix].concat(args)); }, negative: function () { return printfArray([expected %n to not verbPhrase action].concat(args)); } };注意到printfArray了吗它调用的正是spy.printf—— 也就是 Sinon.JS 内置的printf 格式化函数。sinon-chai 负责拼模板Sinon 负责把模板里的占位符替换成真实数据两者配合默契。模板占位符全解%n、%c、%C、%t、%*、%D 都是什么要读懂断言失败消息模板必须先认识这些占位符占位符含义示例输出%nspy 的名称displayNamespy、spyA%c实际调用次数0、3%C调用次数与单词0 times、twice%t实际的 this 上下文{ x: y }%1第一个参数foo%*全部参数列表a, b, c%D期望与实际的 diff 对比详细差异输出这些占位符全部由 Sinon.JS 的 printf 机制解析sinon-chai 只负责把占位符写进合适的句子位置从而保证每条断言失败消息都语法完整、信息丰富。常见断言失败消息模板对照表在 lib/sinon-chai.js 中每种断言都对应一条精心设计的消息模板断言肯定消息模板否定消息模板calledexpected %n to have been called at least once, but it was never calledexpected %n to not have been calledcallCount(n)expected %n to have been called exactly %1, but it was called %c%Cexpected %n to not have been called exactly %1calledWith(...)expected %n to have been called with arguments %*%Dexpected %n to not have been called with arguments %*calledOn(ctx)expected %n to have been called with %1 as this, but it was called with %t insteadexpected %n to not have been called with %1 as thisreturned(v)expected %n to have returned %1expected %n to not have returned %1thrown(e)expected %n to have thrown %1expected %n to not have thrown %1这些模板的断言效果都可以在 test/messages.js 的测试用例中找到对应验证。实战拆解一条断言失败消息的完整生成流程假设我们写了下面这行断言而 spy 从未被调用spy.should.have.been.calledOnce;断言失败时消息生成分三步走sinon-chai 定位到calledOnce对应的模板been called exactly once 后缀, but it was called %c%CgetMessages拼出完整句子expected %n to have been called exactly once, but it was called %c%Cspy.printf把%n替换成spy、%c替换成0、%C替换成times。最终你看到的就是经典的expected spy to have been called exactly once, but it was called 0 times整个过程清晰、可预期这正是友好错误提示的设计精髓。否定与 always消息如何随语义切换sinon-chai 的消息设计还照顾到了 Chai 的.not和.always两种变体否定形式negative函数会把句子改成expected %n to not have been called ...自动去掉but it was called这类冗余后缀always 形式getMessages通过always参数把have改成always have生成expected spy to always have been called with arguments 1, 2, 3这样的提示。一条消息模板三种语义全靠参数组合代码复用性极强。进阶细节%D 让错误提示自带 diff 对比如果你注意过calledWith系列的消息会发现模板末尾还有一个%D占位符见 lib/sinon-chai.js。这是后来引入的改进 diff 输出当期望参数与实际参数不一致时错误提示会额外展示两者差异让你一眼看出差在哪而不是只告诉你不对。对于参数较多的函数调用这个细节能大幅缩短排查时间。小结友好错误提示 模板 printf 的优雅组合回顾整个机制sinon-chai 用getMessages集中管理消息模板用占位符抽象动态数据再交给 Sinon 的 printf 完成最终渲染。这种模板化设计让错误提示保持统一、完整、可读也让开发者从枯燥的失败信息中解放出来。如果你也想为自家测试库设计友好的错误提示这套模板 占位符 格式化器的组合思路非常值得借鉴。想深入阅读源码不妨直接查看 lib/sinon-chai.js 与配套的 test/messages.js。【免费下载链接】sinon-chaiExtends Chai with assertions for the Sinon.JS mocking framework.项目地址: https://gitcode.com/gh_mirrors/si/sinon-chai创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考