Consecutive result overlays can now seen

Previously, if multiple overlays were created one after another that
are meant to last for one command, every second overlay wouldn't show
up. This is because there's a hook in the 'post-command-hook that will
delete all overlays, and it runs right after the second overlay is
created.

Instead, if we're creating an overlay as we speak (ie. we are in the
function 'cider--make-result-overlay), we already know that the
previous overlay has been deleted, and thus we can remove
'cider--remove-result-overlay from the 'post-command-hook.

Author: pestctrl

cider-overlays.el

@@ -232,6 +232,13 @@ overlay."
                (display-string (format (propertize format 'face 'default) value))
                (o nil))
           (remove-overlays beg end 'category type)
+          ;; This hook was meant to delete the previous overlay. Since
+          ;; we already deleted it in the line above, remove the
+          ;; hook. Otheriwse, the new overlay that we're about to
+          ;; create would get deleted too.
+          (when (member #'cider--remove-result-overlay post-command-hook)
+            (remove-hook 'post-command-hook
+                         #'cider--remove-result-overlay 'local))
           (funcall (if cider-overlays-use-font-lock
                        #'font-lock-prepend-text-property
                      #'put-text-property)