flycheck-popup-tip

This is extension for Flycheck. It implements minor-mode for displaying errors from Flycheck using popup.el.

There is another official flycheck-pos-tip extension for displaying errors under point. However, it does not display popup if you run Emacs under TTY. It displays message on echo area and that is often used for ELDoc. Also, popups made by pos-tip library does not always look good, especially on macOS and Windows.

Installation

Melpa

Package is available on Melpa.

In your Cask file:

(source gnu)
(source melpa)

(depends-on "flycheck-popup-tip")

In your init.el:

(with-eval-after-load 'flycheck
  '(add-hook 'flycheck-mode-hook 'flycheck-popup-tip-mode))

Configuration options

There is only one configuration option, flycheck-popup-tip-error-prefix. Default value is "\u27a4 ": ➤ .

(custom-set-variables
 '(flycheck-popup-tip-error-prefix "* "))

Usage with `flycheck-pos-tip`

If you are planning to use flycheck-pos-tip with GUI Emacs and this extension on TTY, you can do it with following configuration:

(eval-after-load 'flycheck
  (if (display-graphic-p)
      (flycheck-pos-tip-mode)
    (flycheck-popup-tip-mode)))

You can also do the following:

(setq flycheck-pos-tip-display-errors-tty-function #'flycheck-popup-tip-show-popup)
(flycheck-pos-tip-mode)

That will help if you start Emacs in GUI, but run emacsclient in TTY.

Contributing

We welcome all kinds of contributions, whether you write patches, open pull requests, write documentation, help others with Flycheck issues, or just tell other people about your experiences with Flycheck. Please take a look at our Contributor’s Guide for help and guidance about contributing to Flycheck.

Running tests

UNDERCOVER_FORCE=true UNDERCOVER_CONFIG='("*.el" (:report-file "local-report.json") (:send-report nil))' cask exec buttercup -L . -L tests

This will also generate local-report.json file where you can check if coverage dropped below 100%.

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/.

flycheck/flycheck-popup-tip