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

Merge pull request #4471 from gagbo/fix/eglot-flycheck-freeze

Browse source 
Re-document flycheck-eglot compatibility layer
This commit is contained in:
Henrik Lissner 2021-02-25 12:26:56 -05:00 • committed by GitHub
commit c0f2da7057
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

27
modules/tools/lsp/autoload/flycheck-eglot.el
View file

@ -1,10 +1,21 @@
;;; flycheck-eglot --- Hacky eglot support in flycheck -*- lexical-binding: t; -*- ;;; flycheck-eglot --- Hacky eglot support in flycheck -*- lexical-binding: t; -*-
;;; Commentary:
;; This file sets up flycheck so that, when eglot receives a publishDiagnostics method
;; from the server, then eglot calls a report function that creates diagnostics for
;; flycheck.
;;
;; It works by creating an eglot-specific callback function, and using this as
;; the REPORT-FN argument of `eglot-flymake-backend', which internally registers
;; that lambda as the function to use whenever there is a publishDiagnostics method.
;; Calling `+lsp--flycheck-eglot-init' "too late" is not a problem, since if there
;; are any unreported/missed diagnostics, eglot ensures that the
;; REPORT-FN function is called immediately.
;;
;; Note: as long as joaotavora/eglot#596 isn't fixed/dealt with, this checker cannot
;; work. Please check the issue on github for more context
;;; Code: ;;; Code:
(defun +lsp--flycheck-eglot-init (checker callback) (defun +lsp--flycheck-eglot-init (checker callback)
"Clean up errors when done. "CHECKER is the checker (eglot).
CHECKER is the checker (eglot).
CALLBACK is the function that we need to call when we are done, on all the errors." CALLBACK is the function that we need to call when we are done, on all the errors."
(cl-labels (cl-labels
((flymake-diag->flycheck-err ((flymake-diag->flycheck-err
@ -23,13 +34,13 @@ CALLBACK is the function that we need to call when we are done, on all the error
:buffer (current-buffer) :buffer (current-buffer)
:filename (buffer-file-name))))) :filename (buffer-file-name)))))
;; NOTE: Setting up eglot to automatically create flycheck errors for the buffer. ;; NOTE: Setting up eglot to automatically create flycheck errors for the buffer.
;; Internally, this sets the lambda as the callback to be used by eglot
;; when it receives a publishDiagnostics method from the server
(eglot-flymake-backend (eglot-flymake-backend
(lambda (flymake-diags &rest _) (lambda (flymake-diags &rest _)
(funcall callback (funcall callback
'finished 'finished
(mapcar #'flymake-diag->flycheck-err flymake-diags)))) (mapcar #'flymake-diag->flycheck-err flymake-diags))))))
;; NOTE: Forcefully trigger a check in the buffer (function name is confusing)
(flycheck-buffer)))
(defun +lsp--flycheck-eglot-available-p () (defun +lsp--flycheck-eglot-available-p ()
(bound-and-true-p eglot--managed-mode)) (bound-and-true-p eglot--managed-mode))
@ -42,7 +53,7 @@ CALLBACK is the function that we need to call when we are done, on all the error
(push 'eglot flycheck-checkers) (push 'eglot flycheck-checkers)
(add-hook! 'eglot--managed-mode-hook (add-hook! 'eglot-managed-mode-hook
(defun +lsp-eglot-prefer-flycheck-h () (defun +lsp-eglot-prefer-flycheck-h ()
(when eglot--managed-mode (when eglot--managed-mode
(when-let ((current-checker (flycheck-get-checker-for-buffer))) (when-let ((current-checker (flycheck-get-checker-for-buffer)))