Hide result of all functions

[alirezaalavi87]

Hi.

How do I hide the result of all functions? the results of executing a function (defn or fn) is pretty useless in most cases. I want to only show the results of expressions and "variables" (def).

adding ^{:nextjournal.clerk/visibility {:result :hide}} to the top of every function is an option but not a great one.

BTW, where can I find the documentation of what options I have for clerk, like ^{:nextjournal.clerk/foobar}?

[borkdude]

You can do it like this:

clerk/notebooks/viewers/context.clj

Lines 53 to 69 in c0b56ff

	;; By customizing the cell viewer we might override visibility at presentation time: in this example we're
	;; - hiding all forms holding a defn (except the `^:cljc` ones)
	;; - showing the namespace result (which is hidden by default otherwise)
	(defn defn? [cell]
	(and (not (:cljc (meta (:form cell))))
	(some-> cell :result :nextjournal/value ::clerk/var-from-def deref fn?)))
	(def custom-cell-viewer
	(update viewer/cell-viewer
	:transform-fn comp
	(clerk/update-val (fn [cell]
	(update-in cell [:settings ::clerk/visibility]
	#(cond
	(:ns? cell) {:code :hide :result :show}
	(defn? cell) {:code :hide :result :hide}
	'else %))))))

[alirezaalavi87]

Thank you.
But I don't understand what I should do with this. where should I put it?

And where are these docs available? Is the only available doc for clerk the book of clerk?

[borkdude]

Here is an example notebook that doesn't show defn forms, nor their results:

(ns scratch
  (:require [nextjournal.clerk :as clerk]
            [nextjournal.clerk.viewer :as viewer]))

(defn defn? [cell]
  (some-> cell :result :nextjournal/value ::clerk/var-from-def deref fn?))

^{::clerk/visibility {:code :hide :result :hide}}
(def custom-cell-viewer
  (update viewer/cell-viewer
          :transform-fn comp
          (clerk/update-val (fn [cell]
                              (update-in cell [:settings ::clerk/visibility]
                                         #(if
                                              (defn? cell) {:code :hide :result :hide}
                                              %))))))

^{::clerk/visibility {:code :hide :result :hide}
  ::clerk/no-cache true}
(clerk/add-viewers! [custom-cell-viewer])

(defn dude [] 1)

(dude)

Book of clerk is indeed the canonical docs.

[alirezaalavi87]

Thank you very much.

For future reference of newbies like me, adding this to /dev/user.clj will apply it to the whole project.

[jackrusher]

The Book of Clerk is the best documentation source we have, yes. You can find the answer to your question about hiding everything in a namespace in the book under Customizations > Visibility.

[alirezaalavi87]

Thank you.
I did read that, but couldn't figure out how I should only hide function results. Being new to both clerk and clojure didn't help either.

Btw, isn't hiding the function results a good default anyway?