https://github.com/meqif/flymake-diagnostic-at-point

Minor mode for showing flymake diagnostics at point
https://github.com/meqif/flymake-diagnostic-at-point

emacs

Last synced: 3 months ago
JSON representation

Minor mode for showing flymake diagnostics at point

• Host: GitHub
• URL: https://github.com/meqif/flymake-diagnostic-at-point
• Owner: meqif
• License: gpl-3.0
• Created: 2018-07-14T22:09:33.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-10-24T06:27:51.000Z (over 5 years ago)
• Last Synced: 2024-08-05T06:04:28.852Z (6 months ago)
• Topics: emacs
• Language: Emacs Lisp
• Size: 62.5 KB
• Stars: 42
• Watchers: 3
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flymake-diagnostic-at-point

Minor mode for showing flymake diagnostics at point.

The diagnostics may be displayed in a popup or in the minibuffer. You may also

provide a custom display function to use instead.

![Flymake diagnostics in a popup](./screenshots/popup.png "Flymake diagnostics in a popup")

![Flymake diagnostics in the minibuffer](./screenshots/minibuffer.png "Flymake diagnostics in the minibuffer")

## Installation

Save the `.el` file in your Emacs' load path.

## Usage

Add the following to your `init.el`:

``` emacs-lisp

(eval-after-load 'flymake

  (require 'flymake-diagnostic-at-point)

  (add-hook 'flymake-mode-hook #'flymake-diagnostic-at-point-mode))

```

Alternatively, if you prefer using `use-package`:

``` emacs-lisp

(use-package flymake-diagnostic-at-point

  :after flymake

  :config

  (add-hook 'flymake-mode-hook #'flymake-diagnostic-at-point-mode))

```

## Customization

There are a few customizable variables:

- `flymake-diagnostic-at-point-timer-delay` controls the delay in seconds before displaying the diagnostics at point

- `flymake-diagnostic-at-point-error-prefix` defines the string to be displayed before each error line (e.g. "➤ ")

- `flymake-diagnostic-at-point-display-diagnostic-function` is the display function to be used. It can be set to `flymake-diagnostic-at-point-display-popup` to display in a popup, `flymake-diagnostic-at-point-display-minibuffer` to display in the minibuffer, or any other  function of your choosing that takes a string argument