Variable: flymake-diagnostic-format-alist

flymake-diagnostic-format-alist is a customizable variable defined in flymake.el.gz.

Value

((:help-echo origin code oneliner) (:eol oneliner)
 (:eldoc origin code message) (:eldoc-echo origin code oneliner)
 (t origin code oneliner))

Documentation

How to format diagnostics for different output destinations.

Value is an alist where each element looks like (DESTINATION . PARTS). DESTINATION is a symbol designating an outlet. One of:

- :help-echo, for the native Flymake echoing of diagnostics in the
   echo area as used my flymake-goto-next-error and flymake-goto-prev-error;
- :eol, for use with flymake-show-diagnostics-at-end-of-line;
- :eldoc, for use with Flymake's ElDoc backend;
- :eldoc-echo, for use with Flymake's ElDoc backend, but for ElDoc's own
   confined outlets;
- t for all other destinations.

PARTS says which parts of the diagnostic to include. It is a list of symbols where the following values are meaningful:

- origin: include diagnostic origin if it exists;
- code: include diagnostics code if it exists;
- message: include the full diagnostic's message text;
- oneliner: include truncated diagnostic text;

This variable was added, or its default value changed, in Flymake version 1.4.0.

Probably introduced at or before Emacs version 31.1.

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/flymake.el.gz
(defcustom flymake-diagnostic-format-alist
  '((:help-echo . (origin code oneliner))
    (:eol . (oneliner))
    (:eldoc . (origin code message))
    (:eldoc-echo . (origin code oneliner))
    (t . (origin code oneliner)))
  "How to format diagnostics for different output destinations.
Value is an alist where each element looks like (DESTINATION . PARTS).
DESTINATION is a symbol designating an outlet.  One of:

- `:help-echo', for the native Flymake echoing of diagnostics in the
   echo area as used my `flymake-goto-next-error' and `flymake-goto-prev-error';
- `:eol', for use with `flymake-show-diagnostics-at-end-of-line';
- `:eldoc', for use with Flymake's ElDoc backend;
- `:eldoc-echo', for use with Flymake's ElDoc backend, but for ElDoc's own
   confined outlets;
- t for all other destinations.

PARTS says which parts of the diagnostic to include.  It is a list of
symbols where the following values are meaningful:

- `origin': include diagnostic origin if it exists;
- `code': include diagnostics code if it exists;
- `message': include the full diagnostic's message text;
- `oneliner': include truncated diagnostic text;"
  :package-version '(Flymake . "1.4.0")
  :type '(alist :key-type (choice (const :help-echo)
                                  (const :eol)
                                  (const :eldoc)
                                  (const :eldoc-echo)
                                  (const t))
                :value-type (set (const origin)
                                 (const code)
                                 (const message)
                                 (const oneliner))))