phronmophobic / dewey

Index of Clojure libraries available on github.
Eclipse Public License 1.0
76 stars 1 forks source link

Document `:basis` key in `analysis.edn` #6

Closed sheluchin closed 1 year ago

sheluchin commented 1 year ago

The clj-kondo analysis dump can include one or more entries per repo, depending on how many bases (deps.edn, project.clj, etc.) the project has. The difference is represented through a top-level :basis key in each of the maps in the file.

Since the :basis key is not a part of clj-kondo's own output, I think it would be helpful to document it for Dewey users, and to explain its impact on the cardinality between repos and analysis maps in the pre-computed analysis.edn dumps. I initially assumed that each repo would have just a single analysis entry.

sheluchin commented 1 year ago

https://github.com/phronmophobic/dewey/blob/6c829589d05ba1da8e86f882e64a7eaccb6eb112/README.md?plain=1#L43-L51

This one's in the README now too. Thanks again, @phronmophobic!