Clojurians Log v2

Like:

(-> (z/of-string "{:b 1 :a 2}")
     my-sort
     z/sexpr)
=> {:a 2 :b 1}

Should not be crazy hard.

Can take a look sometime my-tomorrow, if you like

Have you considered what you want to do with reader discards #_?

And maps can be unbalanced in rewrite-clj. Any thoughts there?

And … namespaced maps

Yeah, it'd be necessary to handle those case I think

Is there any other easier way to sort that if not using rewrite-clj?

You might also have to think about formatting. Does sorting also reformat? Like if you have:

{:b 2 :c 3
 :a 1}

And what would you expect to happen for nested maps? Just immediate children sorted?

I think I'd use rewrite-clj if I were to do this, but... maybe I am biased?

I would expect to keep the same sort, follow the same formatting before applying the function

> I think I'd use rewrite-clj if I were to do this, but... maybe I am biased? hahah, I think rewrite-clj makes sense for that, but It doesn't seems easy at least to me

You could decide not to sort if there are #_ or the map is unbalanced.

The preserving formatting might be more complicated. I would encourage you to work out exactly what you'd like to see for various inputs. For example, exactly what should this look like after sorted?:

{:x 2 :c 2        :d 4
      :a 12345678 :y 1}

But if you get too restrictive and only allow sorting on maps that look like:

{:z 2
 :a 1 
 :x 2
 :c 3}

I guess I'm suggesting some hammock before coding.

yeah, the idea is to add a code action on clojure-lsp that sort map keys, so I'd like to avoid changing formatting and things like that, only sort/swap the key-value pair with other key-value pair

not sure it'd be a big issue if the result map become not correctly formatted, I think for now would be ok

later then we could use cljfmt format after sorting when the vertical alignment is implemented :) (if user opt-in to that)

I have the same issue with rewrite-edn. it doesn't always do nice formatting, but at least all the original whitespace and comments are there

what's the use case for sorting map keys? I've never had this desire

https://github.com/clojure-lsp/clojure-lsp/issues/651 I do think it's something cool to have as a command, not priority tho

I already saw that feature request on other libs like clj-refactor, and other editors

cool

Well, I'm happy to fiddle up a little simplistic/naive example sometime later today for you.

I’ve started to fiddle a bit late in the day… will continue tomorrow… Interesting… but… well.. we’ll see…

Hmm… I’ve got something kinda working… but there are many nuances to explore.

So, the tricky part is not find the keys and values in the map. The tricky part, I think, is deciding what to do with spacing, comments and discards. Let’s start with basics, just in case there are lurkers who are interested. If we go all naive, and ignore the possibility of #_, here’s an example of finding all keys in a map:

(->> "{:a 1
       :b 2
       :c 3}"
     z/of-string
     z/down
     (iterate #(-> % z/right z/right))
     (take-while identity)
     (map z/string))
;; => (":a" ":b" ":c")

(->> "{:a 1
       :b 2
       :c 3}"
     z/of-string
     z/down
     z/right
     (iterate #(-> % z/right z/right))
     (take-while identity)
     (map z/string))
;; => ("1" "2" "3")

So it is not too terribly difficult to find keys and values, and one found, sort by the stringified key. But what what to do about: • spacing • comments • #_

For spacing, given kv-seq <k><spacing>+<v>, I am currently experimenting with moving kv-seq and leaving any surrounding whitespace where it is. This seems to work fine for simple cases:

{:c 3 
 :b 2 
 :a 1}

{:a 1
 :b 2
 :c 3}

{    :d 4
    :c 3
   :b 2
  :a 1 }

{    :a 1
    :b 2
   :c 3
  :d 4 }

{:z 1 :b {:x 4
          :c 7}
 :a [1 2
     3 7]}

{:a [1 2
     3 7] :b {:x 4
          :c 7}
 :z 1}

I’ve not looked a comments yet, but let’s explore a scenario:

{;; c1 is this a comment for the map or for the first kv?
 :z 1 ;; c2 this is most probably a comment for this kv and should move with it.
 ;; c3 is this a comment for a group of kvs or only the next kv, or is it a continuation of the comment for the last kv?
 :a 2
 :x 3}

{;; c1 is this a comment for the map or for the first kv?
 :a 2
 ;; c3 is this a comment for a group of kvs or only the next kv, or is it a continuation of the comment for the last kv?
 :x 3
 :z 1 ;; c2 this is most probably a comment for this kv and should move with it.
}

For maps containing #_ and unbalanced maps, I think maybe our original idea of not sorting is good.

This is also an option for maps containing comments.

Thank you for the help @lee! > Becomes (you’ll notice that `:c` is no longer aligned under `:x`, and you will notice that nested maps are not automatically sorted): I'm pretty ok on this minor alignment for now, users could just call clojure-lsp format after the sort or even clojure-lsp could do that automatically for that map when user triggers the sort :) > Maybe just leave them where they are and let the user move them after the sort? The same, I'm pretty ok on leaving comments not on the same line of a k-v not sorted

I think most formatting cases we could fix with calling format for that map right after the sort.

Cool, I’ll explore moving the same-line comment, do a little cleanup and share what I’ve come up with.

@ericdallo, the code was getting a bit long so I instead of a gist, http://nextjournal.com/lread/sorting-maps-by-key-with-rewrite-clj. Pretty cool! Lemme know watcha think and if this gets you on your way. If not, we can chat more.

wow, what a detailed explanation @lee, that's awesome!

thank you very much for the effort, also explaining it on nextjournal was very cool

Glad you are enjoying it! I'm not crazy about my excessive use of loop but not a bad first crack at it.

Yeah, nextjournal is pretty awesome.

I understood the concepts of the function and I will even need to use the sortable-map? as well 😛

I'll try to use on clojure-lsp and let you know if I find any issues, but it looks really good as a first iteration

Cool, you might want to add a few more tests as I only really touched the surface.

Sure, I'll add tests on clojure-lsp side you should tweet about that article 🙂

Meh, I'm not much of a tweeter.

I'm in it for the fun, not the fame. 🙂

haha, yeah I meant, people would love to see those explanations and code

Go ahead and tweet it if you like. I think I've only tweeted like 4 times. Don't want to get into the habit!

haha, I will tweet later and tag you (if you don't mind)

Also, I hope you don't mind if I co-author you the clojure-lsp commit

Ya, sure, sounds good.

@lee it works like a charm 🚀

c/c @nate

coolio!

Oh wow!! Thank you for implementing this so quickly!

oh, that's nice!