BetterThanTomorrow / calva

Clojure & ClojureScript Interactive Programming for VS Code
https://marketplace.visualstudio.com/items?itemName=betterthantomorrow.calva
Other
1.68k stars 217 forks source link

lazy-seq println side-effects are printed as expression result #2621

Open guyguy2001 opened 1 month ago

guyguy2001 commented 1 month ago

I made the mistake of using for instead of doseq for running side effects multiple times in a row, which (to the best of understanding) resulted in the side-effects not happening immediately, instead they only happen when evaluating the result.

The problem is that when evaluating it with Ctrl+Enter, the println output is shown as part of the string representation of the output, instead of how it's supposed to be:

(def inventory {:wood 2 :iron 2})

(defn show-item [type amount] (format "%s: %d" (name type) amount))

(defn simplified-draw-inventory
  [separator inventory]
  (for [[type amount] inventory]
    (println separator
             (show-item type amount))))
(comment
  (def x (simplified-draw-inventory "\n--------\n" inventory))
  x
  x
  (println "foo")
  :rcf)

image

In each screen part, the first red square is the lazy-seq version, and the second is running println directly. I can see the output terminal's behavior being something unavoidable as long as you want to show the string representation as it's being generated, but the inline output's behavior is weird to me - evaluating (println "foo") doesn't show foo at all, while if that happens as a side-effect of transforming the result into a string (such as with lazy-seq), it does appear there!

(It originally happened when calling simplified-draw-inventory directly, I bound it to x just for the example)

PEZ commented 1 month ago

Yeah, that's weird.

PEZ commented 1 month ago

There seems to be something up with the nrepl printer function nrepl.middleware.print/print which Calva uses by default. In theory you should be able to work around it by specifying the printFn of cider.nrepl.pprint/pr, and then you also need to use client side pretty printing (the calva print engine). Like so:

  "calva.prettyPrintingOptions": {
    "printEngine": "calva",
    "printFn": {
      "name": "cider.nrepl.pprint/pr",
    },
    "enabled": true,
    "width": 120,
    "maxLength": 200
  },

However, there's a bug in there that makes pretty printing croak with this combo. I've submitted a PR that fixes this:

So, with any luck this should work in Calva soon. I'll cut a release soon. (As in probably tonight.)

PEZ commented 1 month ago

Calva v2.0.474 is out now, and the workaround config should work. Let's keep this issue open a while and see if we can get some clarity around the nrepl.middleware.print/print issue.