Skip to content
master
Switch branches/tags
Code

flycheck-inline

License GPL 3 MELPA

This is an extension for Flycheck. It implements a minor-mode for displaying errors from Flycheck right below their reporting location, using overlays.

flycheck-inline warning preview

It also supports displaying related errors from Flycheck checkers that support them. Here is an example of this behavior for Rust borrowing errors:

flycheck-inline related errors preview

(See also flycheck-rust for automatically setting up your Rust projects for Flycheck)

Installation

Add flycheck-inline.el somewhere to your load-path and add the following to your init file:

(with-eval-after-load 'flycheck
  (add-hook 'flycheck-mode-hook #'flycheck-inline-mode))

This will turn on inline errors in all buffers where Flycheck is activated.

You can enable flycheck-inline in a subset of languages supported by Flycheck by conditionally enabling flycheck-inline-mode in the hook above, since the mode is buffer-local.

Alternatively, if you do not use the setup above, you can use the command global-flycheck-inline-mode to enable flycheck-inline-mode in all current and future Flycheck buffers.

Configuration

The colors used to display the error/warning/info messages are inherited from the compilation faces. You can customize them through M-x customize-group RET flycheck-inline RET.

If you wish to change the delay before errors are displayed, see flycheck-display-errors-delay.

You can change the way overlays are created by customizing flycheck-inline-display-function and flycheck-inline-clear-function. Here is an example using quick-peek to display the overlays which adds bars around them:

(setq flycheck-inline-display-function
      (lambda (msg pos err)
        (let* ((ov (quick-peek-overlay-ensure-at pos))
               (contents (quick-peek-overlay-contents ov)))
          (setf (quick-peek-overlay-contents ov)
                (concat contents (when contents "\n") msg))
          (quick-peek-update ov)))
      flycheck-inline-clear-function #'quick-peek-hide)

The result:

flycheck-inline overlays with quick-peek

Contributing

We welcome all kinds of contributions, whether you write patches, open pull requests, write documentation, help others with issues, or just tell other people about your experiences with this extension.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.