clj-kondo新增测试断言顺序检查功能
2025-07-08 11:06:20作者:钟日瑜
在Clojure测试开发中,断言语句的书写顺序是一个值得关注的代码风格问题。clj-kondo项目最近新增了一项功能,用于检查测试断言中期望值和实际值的顺序是否符合社区惯例。
背景与问题
在Clojure测试中,使用clojure.test/is配合=操作符进行断言时,参数的顺序虽然没有语言层面的强制规定,但社区形成了约定俗成的规范:期望值(expect)应该放在第一位,实际值(actual)放在第二位。这种约定不仅提高了代码可读性,也与许多测试工具的输出格式保持一致。
然而,由于Clojure语言本身并不强制这种顺序,开发者可能会无意中写出相反顺序的断言,这虽然不会影响测试功能,但会降低代码的一致性和可维护性。
解决方案
clj-kondo新增的检查功能能够识别以下情况:
- 当断言中第一个参数是字面量(如数字、字符串、关键字等),而第二个参数是变量或函数调用时,会提示警告
- 检查不仅限于测试代码,而是适用于所有使用
=操作符的表达式
该功能通过静态分析代码结构实现,能够识别各种字面量类型,包括nil、布尔值、数字、字符、字符串和关键字等。
配置选项
考虑到不同团队可能有不同的代码风格偏好,该功能支持配置选项:
- 可以配置为要求字面量在前(
:literal-first) - 也可以配置为要求字面量在后(
:literal-second)
默认配置为:literal-first,符合大多数Clojure项目的惯例。
特殊情况处理
在实现过程中,开发团队注意到一些特殊情况需要特别处理:
- 链式调用(threading macro)中的等式判断会被忽略,因为强制改变顺序会影响代码的可读性
- 正则表达式比较被排除在检查范围之外,因为其比较方式特殊
使用建议
对于Clojure开发者,建议:
- 在项目中启用这一检查功能,保持测试代码的一致性
- 对于确实需要特殊顺序的情况,可以使用注释临时禁用检查
- 新项目建议采用默认配置,现有项目可根据原有代码风格选择适当配置
这一功能的加入使得clj-kondo在代码风格检查方面更加完善,帮助团队维持更高水平的代码一致性。
登录后查看全文
热门项目推荐
相关项目推荐
暂无数据
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
540
3.77 K
Ascend Extension for PyTorch
Python
351
417
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
889
614
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
338
185
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
988
253
openGauss kernel ~ openGauss is an open source relational database management system
C++
169
233
暂无简介
Dart
778
193
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
115
141
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.35 K
758