emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

refactor!(format): simplify & gate lsp/eglot impl behind +lsp

Browse source 
BREAKING CHANGE: This commit introduces two changes, a breaking, one
not.

The breaking change: `+format-with-lsp` used to control lsp-mode/eglot
integration for this module, but it is now gated behind a new +lsp flag.
Users will need to add it to their `doom!` blocks (in $DOOMDIR/init.el)
to restore the integration.

The other change: I've merged the former `lsp` and `eglot` formatters
into a single `lsp` formatter that dispatches to the appropriate
backend, as well as wrapping this integration in a
`+format-with-lsp-mode` minor mode, so it can be toggled at will; mainly
to assist in debugging formatter behavior.

A unified formatter makes it easier for folks to configure
`+format-with` on a per-project/directory/file basis, without needing to
know what backend this module uses, and opens us up to integrating other
LSP backends in the future (like lsp-bridge).
This commit is contained in:
Henrik Lissner 2024-07-07 20:44:33 -04:00
parent cca40c0277
commit fd1941b95f
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
3 changed files with 70 additions and 59 deletions
Download patch file Download diff file Expand all files Collapse all files

99
modules/editor/format/autoload/lsp.el
View file

@ -1,67 +1,86 @@
;;; editor/format/autoload/lsp.el -*- lexical-binding: t; -*-
;;;###if (modulep! :tools lsp)
(defvar +format-with--last nil)
(defvar +format-lsp--last nil)
;;;###autoload
(defun +format-enable-lsp-formatter-h ()
"TODO"
(when (and +format-with-lsp (null +format-with))
(when (or (lsp-feature? "textDocument/formatting")
(lsp-feature? "textDocument/rangeFormatting"))
(setq-local +format-with--last +format-with
+format-with 'lsp))))
(define-minor-mode +format-with-lsp-mode
"Toggles `lsp-mode'/`eglot' integration with `apheleia-mode' in this buffer.
When enabled, it changes `+format-with' to `lsp', and back to its old value when
disabled. Use `+format-wtih-lsp-maybe-h' to activate it, to ensure it only
activates if lsp-mode/eglot are on and connected to a valid client, and so this
mode won't conflict with pre-existing user config on `+format-with'."
:init-value nil
(unless (local-variable-p '+format-lsp--last)
(setq-local +format-lsp--last +format-with))
(setq-local +format-with
(if +format-with-lsp-mode
(cl-remove-duplicates (cons 'lsp +format-with) :test #'eq)
(prog1 (remq 'lsp (ensure-list +format-lsp--last))
(kill-local-variable '+format-lsp--last)))))
(defvar +format--lsp-alist
'((lsp-managed-mode . +format--with-lsp-mode)
(eglot--managed-mode . +format--with-eglot))
"A list of LSP formatter functions to try on `+format-lsp-buffer'.")
(defun +format--lsp-fn ()
(cl-loop for (sym . fn) in +format--lsp-alist
if (and (boundp sym) (symbol-value sym))
return fn))
;;;###autoload
(defun +format-disable-lsp-formatter-h ()
"TODO"
(when (local-variable-p '+format-with--last)
(kill-local-variable '+format-with--last)
(setq-local +format-with +format-with--last)))
(defun +format-with-lsp-toggle-h ()
"Toggle `+format-with-lsp-mode' depending on the state of lsp-mode/eglot.
;;;###autoload
(defun +format-toggle-eglot-formatter-h ()
"TODO"
(if (bound-and-true-p eglot--managed-mode)
(when (and +format-with-lsp (null +format-with))
(when (or (eglot-server-capable :documentFormattingProvider)
(eglot-server-capable :documentRangeFormattingProvider))
(setq-local +format-with--last +format-with
+format-with 'eglot)))
(when +format-with--last
(kill-local-variable '+format-with--last)
(setq-local +format-with +format-with--last))))
Does not activate the mode if `+format-with' is already set. To activate the
mode unconditionally, call `+format-with-lsp-mode' instead."
(when (or (null +format-with) +format-with-lsp-mode)
(+format-with-lsp-mode (if (+format--lsp-fn) +1 -1))))
;;
;;; Apheleia formatters
;;;###autoload
(cl-defun +format-lsp-buffer (&key buffer scratch callback &allow-other-keys)
(cl-defun +format-lsp-buffer (&rest plist &key callback &allow-other-keys)
"Format the current buffer with any available lsp-mode or eglot formatter."
(if-let* ((fn (+format--lsp-fn))
((apply fn plist)))
(funcall callback)
(funcall callback "LSP server doesn't support formatting")))
(cl-defun +format--with-lsp-mode (&key buffer scratch &allow-other-keys)
"Format the current buffer with any available lsp-mode formatter."
(with-current-buffer buffer
(let ((edits
(cond
((lsp-feature? "textDocument/formatting")
(lsp-request "textDocument/formatting" (lsp--make-document-formatting-params)))
(lsp-request "textDocument/formatting"
(lsp--make-document-formatting-params)))
((lsp-feature? "textDocument/rangeFormatting")
(lsp-request "textDocument/rangeFormatting"
(lsp--make-document-range-formatting-params
(point-min) (point-max)))))))
(unless (seq-empty-p edits)
(with-current-buffer scratch
(lsp--apply-text-edits edits 'format))))
(funcall callback)))
(point-min) (point-max))))
(:err))))
(unless (eq edits :err)
(unless (seq-empty-p edits)
(with-current-buffer scratch
(lsp--apply-text-edits edits 'format)))
t))))
;;;###autoload
(cl-defun +format-eglot-buffer (&key buffer scratch callback &allow-other-keys)
(cl-defun +format--with-eglot (&key buffer scratch &allow-other-keys)
"Format the current buffer with any available eglot formatter."
(with-current-buffer scratch
(setq-local eglot--cached-server
(with-current-buffer buffer
(eglot-current-server)))
(let ((buffer-file-name (buffer-file-name buffer)))
(eglot-format-buffer))
(funcall callback)))
(when (setq-local
eglot--cached-server
(with-current-buffer buffer
(when (or (eglot-server-capable :documentFormattingProvider)
(eglot-server-capable :documentRangeFormattingProvider))
(eglot-current-server))))
(let ((buffer-file-name (buffer-file-name buffer)))
(eglot-format-buffer))
t)))
;;; lsp.el ends here