Clojure 静态检查与格式化工具链：clj-kondo、cljfmt、zprint 与 CI

# 作为 CLI 安装（推荐）
brew install clj-kondo
# 或下载二进制
# 或用 Clojure CLI
clojure -Sdeps '{:deps {clj-kondo/clj-kondo {:mvn/version "2024.08.01"}}}' \
  -M -m clj-kondo.main --lint src

# 检查源码
clj-kondo --lint src
clj-kondo --lint src --config '{:output {:format :json}}'

{:linters
 {:unused-binding        {:level :warning}
  :unresolved-symbol     {:level :error}
  :unused-namespace      {:level :warning}
  :missing-else-branch   {:level :warning}
  :redundant-do          {:level :warning}
  :shadowed-var          {:level :warning}}

 ;; 忽略某些路径
 :output {:exclude-files ["target/**" "resources/**"]}

 ;; 项目自定义：忽略特定符号
 :skip-lint-namespaces [user]}

;; 单行忽略
#_{:clj-kondo/ignore [:unused-binding]}
(let [x 1] nil)

;; 整段忽略
#_{:clj-kondo/ignore [:unresolved-symbol]}
(defmacro custom-thing [& body] ...)

;; 配置里排除整个文件
{:linters {:unresolved-symbol {:exclude [(my.ns/known-macro)]}}}

;; .clj-kondo/config.edn
{:lint-as {my.ns/defhandler clojure.core/defn
           my.ns/with-metrics clojure.core/let}}

;; .clj-kondo/hooks/my_hooks.clj
(ns hooks.my-hooks
  (:require [clj-kondo.hooks-api :as api]))

(defn defhandler
  [{:keys [node]}]
  ;; 把 (defhandler name [req] body) 当作 (defn name [req] body)
  (let [[_ name args & body] (:children node)
        new-node (api/list-node
                   (list (api/token-node 'defn)
                         name args
                         (api/list-node (cons (api/token-node 'do) body))))]
    {:node new-node}))

;; 注册
{:hooks {:analyze-call {my.ns/defhandler hooks.my-hooks/defhandler}}}

clojure -Sdeps '{:deps {cljfmt/cljfmt {:mvn/version "0.13.0"}}}' \
  -M -m cljfmt.main check src
clojure -M -m cljfmt.main fix src

{:indents {my.ns/defhandler [[:block 1]]}
 :remove-surrounding-whitespace? true
 :insert-missing-whitespace? true
 :remove-trailing-whitespace? true}

;; .zprintrc
{:style :community
 :width 100
 :map {:comma? false}
 :binding {:indent 2}}

clojure -Sdeps '{:deps {zprint/zprint {:mvn/version "1.2.9"}}}' \
  -M -m zprint.main -w src

brew install clojure-lsp/brew/clojure-lsp-native
clojure-lsp diagnostics
clojure-lsp format
clojure-lsp clean-ns

{:lint-as {my.ns/defhandler clojure.core/defn}
 :formatting {:indents {my.ns/defhandler [[:block 1]]}}
 :clean {:automatically-remove-unused-imports true}}

name: lint
on: [push, pull_request]
jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: DeLaGuardo/setup-clojure@12.5
        with:
          clj-kondo: '2024.08.01'
          cljfmt: '0.13.0'
      - run: clj-kondo --lint src test
      - run: cljfmt check src test

;; bb.edn
{:tasks
 {lint   {:task (shell "clj-kondo --lint src test")}
  fmt    {:task (shell "cljfmt fix src test")}
  fmt-check {:task (shell "cljfmt check src test")}
  ci     {:depends [lint fmt-check]}}}

;; 隐式反射：性能隐患
(set! *warn-on-reflection* true)
;; => Reflection warning: call to java.lang.String.length can't be resolved

;; 修法：加类型提示
(defn len [^String s] (.length s))

#!/usr/bin/env bash
# .git/hooks/pre-commit
set -e
cljfmt fix src test
git add -u
clj-kondo --lint src test