Variable: eglot-code-action-indications

eglot-code-action-indications is a customizable variable defined in eglot.el.gz.

Value

(eldoc-hint left-fringe margin)

Documentation

How Eglot indicates there's are code actions available at point.

Value is a list of symbols, more than one can be specified:

- eldoc-hint: ElDoc is used to hint about at-point actions;
- left-fringe: A special indicator appears on the left fringe;
- margin: A special indicator appears in the margin;
- nearby: A special indicator appears near point;
- mode-line: A special indicator appears in the mode-line.

If the list is empty, Eglot will not hint about code actions at point.

Note additionally:

- Some values are incompatible; if one or more of nearby,
  left-fringe and margin are specified, earlier values take
  precedence.
- The indicators for many of these are customizable via
 eglot-code-action-indicator (which see), except for left-fringe.
- mode-line only works if eglot-mode-line-action-suggestion exists
  in eglot-mode-line-format (which see).

This variable was added, or its default value changed, in Eglot version 1.19.

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/eglot.el.gz
(defcustom eglot-code-action-indications
  '(eldoc-hint left-fringe margin)
  "How Eglot indicates there's are code actions available at point.
Value is a list of symbols, more than one can be specified:

- `eldoc-hint': ElDoc is used to hint about at-point actions;
- `left-fringe': A special indicator appears on the left fringe;
- `margin': A special indicator appears in the margin;
- `nearby': A special indicator appears near point;
- `mode-line': A special indicator appears in the mode-line.

If the list is empty, Eglot will not hint about code actions at point.

Note additionally:

- Some values are incompatible; if one or more of `nearby',
  `left-fringe' and `margin' are specified, earlier values take
  precedence.
- The indicators for many of these are customizable via
 `eglot-code-action-indicator' (which see), except for `left-fringe'.
- `mode-line' only works if `eglot-mode-line-action-suggestion' exists
  in `eglot-mode-line-format' (which see)."
  :type '(set
          :tag "Tick the ones you're interested in"
          (const :tag "ElDoc textual hint" eldoc-hint)
          (const :tag "Right besides point" nearby)
          (const :tag "In mode line" mode-line)
          (const :tag "In left fringe" left-fringe)
          (const :tag "In margin" margin))
  :package-version '(Eglot . "1.19"))