简洁版
目前改变哪些源文件由 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 不要加载某些文件,我不得不想出一个相对hack的解决方案,该方案尝试将刷新目录设置为类路径目录减去有问题的目录,但如果能通过黑名单或谓词来设置这会更美好。
解决方案 供他人遇到时参考
(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)