search

borkdude / api-diff

Print API diffs between library versions
59 stars 2 forks source link

Mention static analysis in README? #6

Closed lread closed 2 years ago

lread commented 2 years ago

Should we mention that api-diff uses clj-kondo static analysis and therefore will not pick up APIs that are generated at load time? (We can mention it can compensate via custom hooks and has built in support for potemkin import-vars).

(Amazonica is a good example of a lib that does load time API generation.)

If you think this is a good thing to mention I can add in.

borkdude commented 2 years ago

Yes. It might be better to move this repo to the clj-kondo org, so it's entirely clear that this is a clj-kondo-based project. What do you think?

lread commented 2 years ago

I'm not sure about moving it to the clj-kondo org. Would that imply that it is a lint tool? Maybe it is, kinda? I dunno.

To me, the fact that it uses clj-kondo is an implementation detail. Maybe someday it will also optionally support grabbing API info at load time? Not something most folks would use, but for those libs that need it, could be interesting.

borkdude commented 2 years ago

I was considering moving carve to clj-kondo as well for the same reason, but maybe it doesn't make sense. PR to clarify in README is good idea either way.