TL;DR
目前影响哪些源文件由 clojure.tools.namespace.repl/refresh
加载的唯一方法是设置刷新目录,这是一个基于允许列表的系统。目前尚无方法阻止特定目录/文件/模式被加载,但同时允许其他所有内容。当类路径上的源目录中存在不打算加载的 Clojure 源文件时,这会引发一个问题。
长话短说
我们在《clojure.tools.namespace/refresh》与clj-kondo 钩子之间遇到了一个有趣的问题。
一个简单的重现案例是
clj -Srepro -Sdeps '{:deps {org.clojure/tools.namespace {:mvn/version "1.2.0"} seancorfield/next.jdbc {:git/url "https://github.com/seancorfield/next-jdbc/" :git/sha "24bf1dbaa441d62461f980e9f880df5013f295dd"}}}' -M -e "((requiring-resolve 'clojure.tools.namespace.repl/refresh-all))"
这将失败,因为
:error-while-loading hooks.com.github.seancorfield.next-jdbc
Could not locate hooks/com/github/seancorfield/next_jdbc__init.class, hooks/com/github/seancorfield/next_jdbc.clj or hooks/com/github/seancorfield/next_jdbc.cljc on classpath. Please check that namespaces with dashes use underscores in the Clojure file name.
为了环境说明,clj-kondo 是一个静态分析器/代码检查器。为了能够正确分析自定义宏,它允许库将描述这些宏应如何分析的 clj 文件(作为资源)分布到特定目录下。
上面的示例因以下原因失败
由于目前尚无方法让 tools.namespace 不加载特定文件,我必须提出一种相当奇怪的解决方案,即尝试将刷新目录设置为类路径目录减去有问题的目录,但如果有方法可以用阻止列表或谓词来设置此操作将更好。
解决方法,以防其他人遇到类似问题
(defn remove-clj-kondo-exports-from-tools-ns-refresh-dirs
"A potential issue from using this is that if the directory containing the clj-kondo.exports folder
also directly contains to-be-reloaded clojure source files, those will no longer be reloaded."
[]
(->> (clojure.java.classpath/classpath-directories)
(mapcat
(fn [^File classpath-directory]
(let [children (.listFiles classpath-directory)
directory? #(.isDirectory ^File %)
clj-kondo-exports?
#(= "clj-kondo.exports" (.getName ^File %))
has-clj-kondo-exports
(some (every-pred clj-kondo-exports? directory?) children)]
(if has-clj-kondo-exports
(->> children
(filter directory?)
(remove clj-kondo-exports?))
[classpath-directory]))))
(apply clojure.tools.namespace.repl/set-refresh-dirs)))
;; call in user.clj
(remove-clj-kondo-exports-from-tools-ns-refresh-dirs)