Fork me on GitHub
#cljdoc
<
2022-03-26
>
ribelo13:03:50

I am still collecting unspecified problems 🙃

1
ribelo13:03:17

unfortunately a search for cannot be cast to class clojure.pprint.PrettyFlush here or on GH does not help

lread13:03:56

@U0BBFDED7, happy to take a peek sometime today. But first... I see many clojure .class files in your jar. This is something you typically want to avoid for a library.

ribelo15:03:34

when using jar, I have a problem with dependencies

ribelo15:03:18

I copied the config from malli

lread20:03:49

An uberjar is typically for apps, not libs.

ribelo21:03:18

my problem was the dependencies served from github

ribelo21:03:50

after uploading to clojars and making jar and not uberjar, it seems to work now

ribelo21:03:08

thanks for your help again

lread21:03:25

Congrats, and you are most welcome.

lread21:03:20

Oh @U0BBFDED7, one more thing: your cljdoc badge image seems a bit off: You have: https://cljdoc.org/badge/ribelo/doxa.svg But I think you maybe want: https://cljdoc.org/badge/com.github.ribelo/doxa

ribelo21:03:06

definitely 😉

djblue19:03:55

Hello 👋 just wanted to start off by saying cljdoc is a pretty awesome tool for the Clojure community! Thanks for all the hard work in both building and maintaining it 🙏 An issues I run into on occasion is resolving optional/runtime dependencies. So far I have been able to work around these issues, but was curious if there was any discussion around making it easier?

lread20:03:08

Hi @U1G869VNV! Thanks for dropping by!

lread20:03:21

Our current recommendation is to include optional deps as provided in your pom.xml .

👍 1
lread20:03:42

The only option today for API analysis is dynamic analysis, your namespaces are loaded to discover your API. I am exploring adding support for static analysis via clj-kondo’s analysis data. Static analysis would not always cover the case where an API is generated at load-time, but not many libs do this, so it might be a good fallback/option if dynamic analysis fails.

💯 1
djblue20:03:45

It would be awesome if I could opt-in to the static analysis path for some apis/namespaces 💯

lread20:03:55

And am also looking at custom analysis. You provide the resulting API analysis edn that cljdoc normally generates. But… I don’t think this is what your use case specifically needs.

lread20:03:22

> It would be awesome if I could opt-in to the static analysis path for some apis/namespaces Oh… hadn’t thought of doing only for some namespaces… Hmm… I’d probably start with all static or all dynamic for an analysis run.

👍 1
djblue20:03:49

Recently I added some code for planck and had some issues, luckily planck does publish a jar to clojars so I was able to solve the issue.

djblue20:03:02

Another option could be to exclude certain namespaces from being analyzed :thinking_face: Not sure what is easier

lread20:03:23

Just remembered that cljdoc does add at least one jar to the classpath that would fall into the provided category: javax.servlet/javax.servlet-api.

lread20:03:58

Am thinking maybe lein might be another one to add for lein plugins.

lread20:03:44

> Another option could be to exclude certain namespaces from being analyzed :thinking_face: Not sure what is easier If you have control over the source, you can add :no-doc to a namespace. A recent change to analysis will not attempt to explicitly load these namespaces. But if they are loaded indirectly by other code in your lib, then… well… you’ll still have trouble.

djblue20:03:59

Ohh, I think I might be using an older version of cljdoc locally for testing. I was hoping no-doc would do this 💯

lread20:03:55

It should! You can thank @U45T93RA6 for the idea, and blame me if it doesn’t work. simple_smile

😂 2
djblue21:03:19

Okay, this is a great tip 🙏

djblue21:03:42

Thanks again for all the hard work you do ❤️

❤️ 1
lread21:03:45

Meh, it is typically lotsa fun! And always looking for feedback. It can get a little quiet in the ol’ cljdoc channel so feel free to drop by with ideas/problems/suggestions.

💯 1
Cora (she/her)22:03:37

I'll probably just start that over

Cora (she/her)22:03:24

@lee iirc you use adoc? do you know of any clojure projects that use that as the readme? I'm working on client-side search again and I'm only parsing markdown at the moment and need it to work with adoc as well

Cora (she/her)22:03:49

oh, duh, I already have your status-line project open and it has that

Cora (she/her)22:03:09

sorry I dropped off the face of the earth btw

lread22:03:09

Yeah, I’m a huge fan of the adoc. All my projects (including rewrite-clj!) use adoc.

Cora (she/her)22:03:17

thanks for leading the charge on maintenance

lread22:03:55

And so nice to see you here!

💜 1
Cora (she/her)22:03:03

so nice to be back!

Cora (she/her)22:03:14

I've been working on calva maintenance

lread22:03:34

I saw that! Very impressive.

Cora (she/her)22:03:35

but this weekend feels like a good time to knock out this client-side search. the value to the community would be incredible

lread22:03:55

Very awesome! And, as always, no pressure! But am quite excited to see the fruits of this PR!