Homepage: https://repo.or.cz/emacs-capf-autosuggest.git
Author: jakanakaevangeli
Updated:
History autosuggestions for comint and eshell
capf-autosuggest lets you preview the most recent matching history element,
similar to zsh-autosuggestions or fish. It works in eshell and in modes
derived from comint-mode, for example M-x shell and M-x run-python.
As you type, the history auto-suggestion is shown as an overlay after point.
Type [C-e] to insert text from this overlay or [M-f] to only insert a word
from this overlay. [C-n] is a shorthand for [C-e] followed by [RET]: it
inserts text from the overlay and sends it to the process.
Installation:
To install capf-autosuggest, type
M-x package-install RET capf-autosuggest RET.
Enable it with M-x capf-autosuggest-mode. It is best to add the following
elisp snippet to your Emacs init file to enable `capf-autosuggest-mode'
automatically for every comint and eshell buffer:
(add-hook 'comint-mode-hook #'capf-autosuggest-mode)
(add-hook 'eshell-mode-hook #'capf-autosuggest-mode)
Configuration:
Use `capf-autosuggest-define-partial-accept-cmd' to make a command that can
move point into an auto-suggested overlay.
Example: to make [C-M-f] (forward-sexp) movable into suggested text, put the
following into your Emacs init file:
(with-eval-after-load 'capf-autosuggest
(capf-autosuggest-define-partial-accept-cmd
movable-forward-sexp forward-sexp)
(define-key capf-autosuggest-active-mode-map
[remap forward-sexp] #'movable-forward-sexp))
By default, [C-n] (next-line) will accept the currently displayed suggestion
and send input to shell/eshell. To disable this behaviour or enable it for
other commands such as [C-c C-n] or [M-n], see the customization group
`capf-autosuggest'
Details:
capf-autosuggest provides a minor mode, capf-autosuggest-mode, that lets you
preview the first completion candidate for in-buffer completion as an
overlay. Instead of using the default hook `completion-at-point-functions',
it uses its own hook `capf-autosuggest-capf-functions'. However, by
default, this hook contains a function that reads the default hook, but only
if point is at end of line, because an auto-suggested overlay can be
annoying in the middle of a line. If you want, you can try enabling this
minor mode in an ordinary buffer for previewing tab completion candidates at
end of line.
A completion-at-point function for comint and eshell history is also
provided. Because it is less useful for tab completion and more useful for
auto-suggestion preview, it is a member of
`capf-autosuggest-capf-functions', which doesn't interfere with tab
completion. By default, if there are no matches for history completion and
point is at end of line, we fall back to previewing the default tab
completion candidates, as described in the previous paragraph.
You can customize this behaviour by customizing
`capf-autosuggest-capf-functions'. For example, you could add
`capf-autosuggest-orig-capf' to enable auto-suggestions of tab completion
candidates in the middle of a line.
Alternatives:
There is also esh-autosuggest[1] with similar functionality. Differences:
it is simpler and more concise, however it depends on company. It optionally
allows having a delay and it is implemented only for eshell.
[1]: http://github.com/dieggsy/esh-autosuggest
Bugs, suggestions and patches can be sent to
bugs-doseganje (at) groups.io
and can be viewed at https://groups.io/g/bugs-doseganje/topics. As this
package is stored in GNU ELPA, non-trivial patches require copyright
assignment to the FSF, see info node "(emacs) Copyright Assignment".