clojure-style-guide icon indicating copy to clipboard operation
clojure-style-guide copied to clipboard

Published 20 hours ago • verified publisher icon bbatsov

How to sort requires in .cljc?

Open borkdude opened this issue 5 years ago • 1 comments

This commit adds a section about sorting namespaces. Clj-kondo want to check this, but currently there is no clarity around how "requirements" (which I find a bit of a weird word for libspecs in a require clause) in .cljc namespaces should be sorted.

Since there is no clarity around this, I'm thinking about just disabling the rule for clj-kondo in .cljc files for now.

See https://github.com/borkdude/clj-kondo/issues/741.

cc @Heliosmaster

borkdude avatar Feb 10 '20 16:02 borkdude

@borkdude re about the wording "requirements". Feel free to improve it! Note that it also refer to the java classes in import statement though.. (requirements is still wrong, as they are imported classes)

About .cljc, I think the cleanest is to just sort the :clj, :cljr (🤷‍♂ ), :cljs and then the libspecs without a reader conditional. Within each block they should be sorted, independently (i.e. if in the same block we have both :clj and :cljs they should be sorted independently.

But is this consistent with the general usage of the reader conditional in ns declaration? Does it make sense?

Heliosmaster avatar Feb 12 '20 08:02 Heliosmaster