emacs-sideline/sideline-flycheck

Show flycheck errors with sideline

sideline-flycheck's Issues

Customize faces used by sideline-flycheck

I was investigating why neither my sideline-backend nor sideline-default font settings were honored and found:

sideline-flycheck/sideline-flycheck.el

Lines 95 to 96 in ed4d7ef

	(let* ((level (flycheck-error-level err))
	(face (if (eq level 'info) 'success level))

I'm not certain, yet, but wonder if the sideline display of flycheck-* faces warrants a replacement. I use smaller and variable width sideline fonts to put more info there, for example.

My thinking is to map all flycheck-* fonts to sideline-flycheck-* faces that by default merely inherit from their flycheck counterparts.

E.g. this:

(defgroup sideline-flycheck-faces nil
  "Faces used to display on-the-fly syntax checking in the sideline."
  :prefix "sideline-flycheck-"
  :group 'sideline-flycheck)

(defface sideline-flycheck-error-list-error
  '((t :inherit flycheck-error-list-error))
  "Sideline Flycheck face for error messages in the error list."
  :package-version '(sideline-flycheck . "0.1")
  :group 'sideline-flycheck-faces)

What do you think about that?

Exported list of error faces

flycheck-error                           Flycheck face for errors.                                                       
flycheck-error-list-id                   Face for the error ID in the error list.                                        
flycheck-error-delimiter                 Flycheck face for errors spanning multiple lines.                               
flycheck-error-list-info                 Flycheck face for info messages in the error list.                              
flycheck-error-list-error                Flycheck face for error messages in the error list.                             
flycheck-error-list-warning              Flycheck face for warning messages in the error list.                           
flycheck-error-list-filename             Face for filenames in the error list.                                           
flycheck-error-list-highlight            Flycheck face to highlight errors in the error list.                            
flycheck-error-list-line-number          Face for line numbers in the error list.                                        
flycheck-error-list-checker-name         Face for the syntax checker name in the error list.                             
flycheck-error-list-column-number        Face for line numbers in the error list.                                        
flycheck-error-list-error-message        Face for the error message in the error list.                                   
flycheck-error-list-id-with-explainer    Face for the error ID in the error list, for errors that have an explainer.     

How to trigger display outside highlighted region on the same line like `lsp-ui`?

It's a bit inconvenient that one has to move the point to the highlighted region to see the sideline message.

lsp-ui

sideline

`flycheck-display-errors-delay` must be larger than `sideline-delay` for this to work

Apparently it currently works like this:

1. sideline-render is called after an idle timer of sideline-delay (default 0.2s)
2. Inside sideline-render, it calls sideline-flycheck backend which is async. sideline-flycheck only keeps the callback for future use
3. flycheck-display-error-at-point is called after an idle timer of flycheck-display-errors-delay (default 0.9s)
4. Inside flycheck-display-error-at-point, it calls sideline-flycheck--show which in turn calls the sideline render callback in step 2.

So this process only works when flycheck-display-error-at-point is larger than sideline-delay.

How to start automatically?

Hi there. I'm loving sideline-flycheck :)

This is more of a question than an issue. How can I start it automatically? I can start it manually by typing M-x sideline-flycheck-mode per buffer, but can I have it running by default for every buffer?

Relevant part of my .emacs:

;; Use sideline and sideline-flycheck to display messages from flycheck.
(use-package sideline
  :init
  (global-sideline-mode)
  (setq
   sideline-backends-right '(sideline-flycheck)
   ;; sideline-backends-skip-current-line t  ; don't display on current line
   sideline-order-right 'down                ; or 'up
   sideline-format-left "%s   "              ; format for left aligment
   sideline-format-right "   %s"             ; format for right aligment
   sideline-priority 100                     ; overlays' priority
   sideline-display-backend-name t           ; display the backend name
   )
  )
(use-package sideline-flycheck
  :init (sideline-flycheck-mode)
  :hook
  (flycheck-mode-hook . sideline-mode)
  (flycheck-mode-hook . sideline-flycheck-setup)
  )

Message not being full displayed

See the screenshots below.

lsp-ui

sideline

config

(use-package sideline
  :hook ((flycheck-mode . sideline-mode))
  :init
  (setq sideline-delay .1
        sideline-backends-right '(sideline-flycheck))

  :config
  (set-face-attribute 'sideline-default nil :inherit 'success :foreground 'unspecified))

(use-package sideline-flycheck
  :hook (flycheck-mode . sideline-flycheck-setup))