TL;DR
目前影响哪些源文件通过clojure.tools.namespace.repl/refresh
加载的唯一方法是设置刷新目录,这是一个基于允许列表的系统。目前尚无方法阻止特定目录/文件/模式的加载,同时允许其他所有内容。当源目录上有classpath中的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不加载某些文件,我不得不想出一个相对复杂的解决方案,该解决方案尝试将刷新目录设置为classpath目录减去有问题的目录,但如果能通过黑名单或断言来实现这将好得多。
解决方案以防其他人遇到相同的问题
(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)