Editor integration

[monkeysees]

First of all, I want to say thank you for this library, I use it all the time.

I'm wondering if you'd be open to add editor integrations for it.

I remember you sharing with me the following Emacs helpers a while ago:

(defun clj-insert-persist-scope-macro ()
  (interactive)
  (insert
   "(defmacro persist-scope
              \"Takes local scope vars and defines them in the global scope. Useful for RDD\"
              []
              `(do ~@(map (fn [v] `(def ~v ~v))
                  (keys (cond-> &env (contains? &env :locals) :locals)))))"))

(defun persist-scope ()
  (interactive)
  (let ((beg (point)))
    (clj-insert-persist-scope-macro)
    (cider-eval-region beg (point))
    (delete-region beg (point))
    ;; If emacs is slow, it may start evaluating function at point
    ;; before macro is evaluated and deleted.
    (sleep-for 0 10)
    (insert "(persist-scope)")
    (cider-eval-defun-at-point)
    (delete-region beg (point))))

(defun unpersist-scope ()
  (interactive)
  (let ((beg (point)))
    (insert "(remove-ns (.getName *ns*))")
    (cider-eval-region beg (point))
    (delete-region beg (point))
    (cider-eval-buffer)))

I think it'd be nice to put them into an Elisp package so that people have easier time using them. I think something similar can be done for VS Code as well.

[monkeysees]

I also want to share another Elisp helper (see persist-scope-do) for cases where a single s-expression is expected (instead of a list of them) e.g. if-let.

(defun wrap-next-sexp (open close)
  "Wrap the next `sexp' from point with OPEN and CLOSE strings.
  The cursor is placed after the opening delimiter."
  (forward-sexp)
  (let ((bounds (bounds-of-thing-at-point 'sexp)))
    (when bounds
      (goto-char (cdr bounds))
      (insert close)
      (goto-char (car bounds))
      (insert open))))

(defun wrap-next-sexp-with-do ()
  "Wrap the next `sexp' with `do' function.
  The cursor is placed between `do' and `sexp`."
  (when (ignore-errors (wrap-next-sexp "(do  " ")"))
    (backward-char 1)))

(defun persist-scope-do ()
  (interactive)
  (undo-boundary)
  (wrap-next-sexp-with-do)
  (clj-insert-persist-scope-macro)
  (cider-eval-last-sexp)
  (backward-sexp)
  (kill-sexp)
  ;; If emacs is slow, it may start evaluating function at point
  ;; before macro is evaluated and deleted.
  (sleep-for 0 10)
  (insert "(persist-scope)")
  (cider-eval-defun-at-point)
  (undo-tree-undo))

[KGOH]

I'm happy to know that you find this library useful! Indeed, IDE integration is highly necessary for this repository, but I’m unsure how to structure it best from a maintenance standpoint. The entire library is covered by tests, but I’m not sure how to test the integrations themselves. If I add new features to the library, I don’t want to manually recheck all the IDEs every time.
Do you have any suggestions?

[monkeysees]

Integrations can also be covered by tests. For example, there is CIDER which has extensive test coverage. I believe similar testing capabilities are available for other editors as well.

I understand that providing these integrations and covering them with tests can be a huge effort. If you're open to incorporating them into this repo, I'd be happy to help 🙂

[KGOH]

@monkeysees since I'm currently not using emacs, it would be very helpful if you create a PR with full or partial implementation of such tests, so I can take this from that and add to the repo

[monkeysees]

So far I've come up only with VS Code extension for a plain persist-scope macro. Currently it's a separate repo for the sake of development convenience but I don't mind incorporating it into this repo later on. It's not covered by tests yet as I wanted first to have a working POC extension first. I'll think about proper ways to test both it and the Emacs version.

[KGOH]

@monkeysees btw, do you use ps.sc or just ps?

[monkeysees]

Just ps. I've been using it as a Clojure macro defined with my Emacs, not via this library. And I forgot about the ps.sc part for quite a while. Now I plan to get more used to it. It'd be nice to have an editor integration for it as well. And also compare how it matches FlowStorm and Portal experiences.