cljdoc

https://cljdoc.org/ & https://github.com/cljdoc/cljdoc
2021-05-20T19:51:14.002300Z

Hey! I've just tried to build the cljdoc documentation for https://github.com/IGJoshua/farolero, and it failed on this build: https://cljdoc.org/builds/44404 It looks like this is because it tried to load and document the hooks namespace that I made as a part of my clj-kondo support this release, and it failed because the path doesn't match up with the ns name. Is there any way I can tell cljdoc to ignore those .clj files as it produces documentation?

2021-05-20T20:19:35.003Z

Do I just need to put a ^:no-doc meta on the namespace? Will that work?

martinklepsch 2021-05-20T21:18:42.003200Z

Unfortunately ^:no-doc still requires the namespace to be valid. Is there a reason to include the clj-kondo hooks files within the jar? Does clj-kondo scan for them?

2021-05-20T22:03:16.003400Z

Yes, clj-kondo looks on the classpath for resources in a particular directory, and the namespaces must not include that full path.

2021-05-20T22:04:47.003600Z

For the library I linked to, there are several macros which kondo doesn't understand, and so a config must be exported which provides code to partially expand them into forms that it does understand, and they have specific requirements about how the namespaces must be positioned.

martinklepsch 2021-05-20T23:37:08.003800Z

Cool. Can you open an issue which details where clj-kondo expects this config? We can then adjust the analyzer to delete those files before analysis.

2021-05-20T23:44:25.004100Z

@martinklepsch https://github.com/cljdoc/cljdoc/issues/455 This issue has it, and I'm curious, is there any way I can get cljdoc to rebuild the 1.1.1 release of farolero once this is fixed?