clj-kondo 中按语言限定 linter 作用范围的实践指南

背景介绍

clj-kondo 是一个强大的 Clojure 代码静态分析工具，它能够帮助开发者发现代码中的潜在问题。在实际开发中，我们经常会遇到需要针对不同语言环境（Clojure/ClojureScript）应用不同 lint 规则的需求。

问题场景

在跨平台开发中，某些变量或函数可能在一个语言环境中需要被限制使用，而在另一个语言环境中却是允许的。例如，在 Clojure 代码中我们希望禁止使用某个特定变量，但在 ClojureScript 代码中却需要保留这个变量的使用。

解决方案

clj-kondo 提供了通过 :langs 配置项来精确控制 linter 作用范围的功能。这个功能允许开发者指定 linter 只在特定的语言环境中生效。

配置示例

:discouraged-var
  {com.fulcrologic.fulcro-i18n.i18n/with-locale
   {:message "请使用 brian.translation/with-locale 替代"
    :level :error
    :langs [clj]}}

这个配置表示 with-locale 变量在 Clojure 代码中会被标记为不推荐使用（错误级别），但在 ClojureScript 代码中则不会触发这个 linter。

实现原理

clj-kondo 在分析代码时会识别文件的扩展名和代码块的语言环境：

• .clj 文件被视为纯 Clojure 代码
• .cljs 文件被视为纯 ClojureScript 代码
• .cljc 文件中的代码会根据条件读取指令（如 #?(:clj ...)）区分语言环境

当配置了 :langs 参数后，linter 会先检查当前代码的语言环境是否在指定列表中，只有匹配时才会应用相应的检查规则。

实际应用效果

应用上述配置后，linter 将只会报告：

1. 纯 Clojure 文件（.clj）中的违规使用
2. Clojure/ClojureScript 共用文件（.cljc）中明确标记为 Clojure 的代码块

而以下情况将不会触发警告：

1. 纯 ClojureScript 文件（.cljs）中的使用
2. Clojure/ClojureScript 共用文件中明确标记为 ClojureScript 的代码块

最佳实践

1. 明确区分环境需求：在配置 linter 前，先明确哪些规则需要区分语言环境
2. 合理使用语言限定：不要过度使用语言限定，保持配置的简洁性
3. 组合使用其他配置项：可以结合 :level、:message 等配置项，提供更丰富的提示信息
4. 测试验证：配置后应在不同语言环境的测试文件中验证效果

总结

clj-kondo 的语言环境限定功能为跨平台 Clojure 开发提供了更精细的代码质量控制手段。通过合理配置 :langs 参数，开发者可以针对不同语言环境定制静态分析规则，既保证了代码质量，又避免了不必要的限制。这一特性特别适合在共享代码库中维护不同平台的代码规范。