refactor(corfu): settings and keybinding overhaul
Previously, a distinction was made only between "regular" style (assumed to be for people who prefer to cycle directionally and commit with RET) and +tng (assumed to be for people who prefer TAB and auto-commit). This made composing further variations harder on the user, as they would have to work around our bindings. Now we many features as documentation, and the user can compose to their liking. The global CAPF list was pruned, suggesting to use individual keys for those functions if required.
This commit is contained in:
parent
2bb5f29a01
commit
93faae87eb
5 changed files with 236 additions and 213 deletions
|
@ -8,7 +8,7 @@ This module provides code completion, powered by [[doom-package:corfu]].
|
||||||
|
|
||||||
It is recommended to enable either this or [[doom-module::completion company]], in
|
It is recommended to enable either this or [[doom-module::completion company]], in
|
||||||
case you desire pre-configured auto-completion. Corfu is much lighter weight and
|
case you desire pre-configured auto-completion. Corfu is much lighter weight and
|
||||||
focused, plus it's built on native Emacs functionality, whereas company is heavy
|
focused, plus it's built on native Emacs functionality, whereas Company is heavy
|
||||||
and highly non-native, but has some extra features and more maturity.
|
and highly non-native, but has some extra features and more maturity.
|
||||||
|
|
||||||
** Maintainers
|
** Maintainers
|
||||||
|
@ -19,21 +19,14 @@ and highly non-native, but has some extra features and more maturity.
|
||||||
** Module flags
|
** Module flags
|
||||||
- +icons ::
|
- +icons ::
|
||||||
Display icons beside completion suggestions.
|
Display icons beside completion suggestions.
|
||||||
- +tng ::
|
|
||||||
Known as Tab'n'Go to Company users, changes behavior to invoke completion on
|
|
||||||
[[kbd:][TAB]]. When Corfu is active, [[kbd:][TAB]] and [[kbd:][S-TAB]] will navigate the completion
|
|
||||||
candidates. Arrow keys and evil-style movement are still supported.
|
|
||||||
- +orderless ::
|
- +orderless ::
|
||||||
Pull in [[doom-package:orderless]] if necessary and apply multi-component
|
Pull in [[doom-package:orderless]] if necessary and apply multi-component
|
||||||
completion (still needed if [[doom-module::completion vertico]] is active).
|
completion (still needed if [[doom-module::completion vertico]] is active).
|
||||||
- +dabbrev ::
|
- +dabbrev ::
|
||||||
Enable and configure [[doom-package:dabbrev]] as a close-to-universal CAPF
|
Enable and configure [[doom-package:dabbrev]] as a close-to-universal CAPF
|
||||||
fallback.
|
fallback.
|
||||||
- +dict ::
|
- +on-ret +on-ret-pt ::
|
||||||
Enable and configure dictionary completion for text modes and related regions
|
Enable corresponding completion-style features. See [[*Usage]].
|
||||||
in programming modes.
|
|
||||||
- +emoji ::
|
|
||||||
Enable and configure emoji completion via the emoji input method.
|
|
||||||
|
|
||||||
** Packages
|
** Packages
|
||||||
- [[doom-package:corfu]]
|
- [[doom-package:corfu]]
|
||||||
|
@ -68,65 +61,127 @@ words. Snippets may also appear in the candidate list if available.
|
||||||
|
|
||||||
** Code completion
|
** Code completion
|
||||||
By default, completion gets triggered after typing 2 non-space consecutive
|
By default, completion gets triggered after typing 2 non-space consecutive
|
||||||
characters, or by means of the [[kbd:][C-SPC]] keybinding at any moment. While the popup
|
characters, by means of [[kbd:][C-SPC]] at any moment or [[kbd:][TAB]] on a line with proper
|
||||||
is visible, the following relevant keys are available:
|
indentation. Many styles of completion are documented below, which can be
|
||||||
|
composed to suit the user. The following keybindings are generally available:
|
||||||
|
|
||||||
| Keybind | Description |
|
| Keybind | Description |
|
||||||
|----------+-----------------------------------------------------------|
|
|---------+---------------------------------------------|
|
||||||
| [[kbd:][<down>]] | Go to next candidate |
|
|
||||||
| [[kbd:][<up>]] | Go to previous candidate |
|
|
||||||
| [[kbd:][C-n]] | Go to next candidate |
|
| [[kbd:][C-n]] | Go to next candidate |
|
||||||
| [[kbd:][C-p]] | Go to previous candidate |
|
| [[kbd:][C-p]] | Go to previous candidate |
|
||||||
|
| [[kbd:][C-u]] | (evil) Go to next candidate page |
|
||||||
|
| [[kbd:][C-d]] | (evil) Go to previous candidate page |
|
||||||
|
| [[kbd:][C-S-n]] | Go to next doc line |
|
||||||
|
| [[kbd:][C-S-p]] | Go to previous doc line |
|
||||||
|
| [[kbd:][C-S-h]] | (emacs) Toggle documentation (if available) |
|
||||||
|
| [[kbd:][C-h]] | (evil) Toggle documentation (if available) |
|
||||||
|
| [[kbd:][C-S-s]] | Export to minibuffer |
|
||||||
|
| [[kbd:][DEL]] | Reset completion DWIM |
|
||||||
|
| [[kbd:][TAB]] | (when not completing) Indent or complete |
|
||||||
|
| [[kbd:][C-SPC]] | (when not completing) Complete |
|
||||||
|
| [[kbd:][C-M-i]] | (emacs) (when not completing) Complete |
|
||||||
|
|
||||||
|
Bindings in the following sections are additive, and get enabled by including
|
||||||
|
the corresponding ~config.el~ snippets or via flags. Additionally, for users of
|
||||||
|
evil, [[kdb:][C-SPC]] is smart regarding your state. In normal-like states, enter insert
|
||||||
|
then start corfu; in visual-like states, perform [[help:evil-change][evil-change]] (which leaves you
|
||||||
|
in insert state) then start corfu; in insert-like states, start corfu
|
||||||
|
immediatelly.
|
||||||
|
|
||||||
|
** Commit preview on type
|
||||||
|
When the completion popup is visible, by default the current candidate is
|
||||||
|
previewed into the buffer, and further input commits that candidate as previewed
|
||||||
|
(note it does not perform candidate exit actions, such as expanding snippets).
|
||||||
|
If neither ~+on-ret~ or ~+on-ret-pt~ are enabled, this becomes the only default
|
||||||
|
way to commit a candidate ([[kbd:][RET]] is unbound in that case).
|
||||||
|
|
||||||
|
The feature is in line with other common editors, but if you prefer the preview
|
||||||
|
to be only visual or for there to be no preview, configure
|
||||||
|
[[var:corfu-preview-current]].
|
||||||
|
|
||||||
|
#+begin_src emacs-lisp
|
||||||
|
;; Non-inserting preview
|
||||||
|
(setq corfu-preview-current t)
|
||||||
|
;; No preview
|
||||||
|
(setq corfu-preview-current nil)
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
** Commit on [[kbd:][RET]] (~+on-ret~)
|
||||||
|
Some people prefer to use [[kbd:][RET]] to commit, so here we bind it to Corfu's insertion
|
||||||
|
function. Note that Corfu allows "no candidate" to be selected, and in that
|
||||||
|
case, it will just quit without inserting. To make it less obtrusive by default,
|
||||||
|
the popup starts in this unselected state. See [[var:corfu-preselect]] to alter this
|
||||||
|
behavior; it can start with the first candidate selected, for instance.
|
||||||
|
|
||||||
|
| Keybind | Description |
|
||||||
|
|---------+--------------------------|
|
||||||
|
| [[kbd:][RET]] | Insert candidate or quit |
|
||||||
|
|
||||||
|
** Commit on [[kbd:][RET]] with pass-through (~+on-ret-pt~)
|
||||||
|
This enables [[kbd:][RET]] to work as a finisher like above. The difference is that
|
||||||
|
without a current candidate, after quitting it passes-through to whatever action
|
||||||
|
would have happened normally. So if you're in the minibuffer composing a shell
|
||||||
|
command and press [[kbd:][RET]], unless a candidate is selected, it quits completion then
|
||||||
|
commits the minibuffer automatically. Contrast to the above, you would need to
|
||||||
|
press twice to commit. [[var:corfu-preselect]] is important here, as having the
|
||||||
|
first candidate from the start prevents the pass-through.
|
||||||
|
|
||||||
|
| Keybind | Description |
|
||||||
|
|---------+-------------------------------------------|
|
||||||
|
| [[kbd:][RET]] | Insert candidate or quit and pass-through |
|
||||||
|
|
||||||
|
** Cycle directionally
|
||||||
|
If you'd rather think in directions rather than next/previous, arrow keys and vi
|
||||||
|
movements to control the selection and documentation view are bound by default.
|
||||||
|
A snippet to unbind them is included after the table.
|
||||||
|
|
||||||
|
| Keybind | Description |
|
||||||
|
|----------+---------------------------------|
|
||||||
|
| [[kbd:][<down>]] | Go to next candidate |
|
||||||
|
| [[kbd:][<up>]] | Go to previous candidate |
|
||||||
| [[kbd:][C-j]] | (evil) Go to next candidate |
|
| [[kbd:][C-j]] | (evil) Go to next candidate |
|
||||||
| [[kbd:][C-k]] | (evil) Go to previous candidate |
|
| [[kbd:][C-k]] | (evil) Go to previous candidate |
|
||||||
| [[kbd:][C-<down>]] | Go to next doc line |
|
| [[kbd:][C-<down>]] | Go to next doc line |
|
||||||
| [[kbd:][C-<up>]] | Go to previous doc line |
|
| [[kbd:][C-<up>]] | Go to previous doc line |
|
||||||
| [[kbd:][C-S-n]] | Go to next doc line |
|
|
||||||
| [[kbd:][C-S-p]] | Go to previous doc line |
|
|
||||||
| [[kbd:][C-S-j]] | (evil) Go to next doc line |
|
| [[kbd:][C-S-j]] | (evil) Go to next doc line |
|
||||||
| [[kbd:][C-S-k]] | (evil) Go to previous doc line |
|
| [[kbd:][C-S-k]] | (evil) Go to previous doc line |
|
||||||
| [[kbd:][C-h]] | Toggle documentation (if available) |
|
|
||||||
| [[kbd:][C-S-s]] | Export to minibuffer (if [[doom-module::completion vertico]]) |
|
|
||||||
| [[kbd:][RET]] | Insert candidate |
|
|
||||||
| [[kbd:][SPC]] | Quit autocompletion or pass-through after a wildcard |
|
|
||||||
| [[kbd:][C-SPC]] | Complete (unless [[doom-module::completion corfu +tng]]) |
|
|
||||||
| [[kbd:][C-SPC]] | (when completing) Insert separator DWIM (see below) |
|
|
||||||
|
|
||||||
If you prefer a [[kbd:][TAB]]-centric completion style, enable the [[doom-module::completion
|
#+begin_src emacs-lisp
|
||||||
corfu +tng]] flag so that, instead, you trigger completion with [[kbd:][TAB]], getting the
|
(map! (:after corfu
|
||||||
following additional binds:
|
:map corfu-map
|
||||||
|
"<up>" nil
|
||||||
|
"<down>" nil
|
||||||
|
;; Evil
|
||||||
|
"C-k" nil
|
||||||
|
"C-j" nil)
|
||||||
|
(:after corfu-popupinfo
|
||||||
|
:map corfu-popupinfo-map
|
||||||
|
"C-<up>" nil
|
||||||
|
"C-<down>" nil
|
||||||
|
;; Evil
|
||||||
|
"C-S-k" nil
|
||||||
|
"C-S-j" nil))
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
** Cycle with [[kbd:][TAB]]
|
||||||
|
You may wish to bind the following [[kbd:][TAB]]-based cycling alternatives with the
|
||||||
|
snippet below the table:
|
||||||
|
|
||||||
| Keybind | Description |
|
| Keybind | Description |
|
||||||
|---------+-----------------------------------------------|
|
|---------+--------------------------|
|
||||||
| [[kbd:][TAB]] | Complete |
|
| [[kbd:][TAB]] | Go to next candidate |
|
||||||
| [[kbd:][TAB]] | (when completing) Go to next candidate |
|
| [[kbd:][S-TAB]] | Go to previous candidate |
|
||||||
| [[kbd:][S-TAB]] | (when completing) Go to previous candidate |
|
|
||||||
| [[kbd:][DEL]] | (when completing) Reset completion DWIM-style |
|
|
||||||
|
|
||||||
*** Completion in the minibuffer
|
#+begin_src emacs-lisp
|
||||||
In the minibuffer, sometimes autocompletion can interfere with your goal;
|
(map! :after corfu
|
||||||
Imagine you're composing a search pattern incrementally, and you find what you
|
:map corfu-map
|
||||||
want early, with only half the word. You then press [[kbd:RET]]. If completion
|
[tab] #'corfu-next
|
||||||
kicked in as you typed, you may lose the match, since it will complete the
|
"TAB" #'corfu-next
|
||||||
first candidate. On the other hand, if you were paying attention to the
|
[backtab] #'corfu-previous
|
||||||
suggestions and selecting one appropriate, that's desired behavior, and you may
|
"S-TAB" #'corfu-previous)
|
||||||
even desire to modify the prompt further (if you were composing a command
|
#+end_src
|
||||||
instead, you may want to extend it after the candidate). To allow better
|
|
||||||
control, there are 3 confirm bindings when Corfu appears in the minibuffer:
|
|
||||||
|
|
||||||
| Keybind | Description |
|
** Searching with multiple keywords (~+orderless~)
|
||||||
|-----------+--------------------------------------------------------------------|
|
|
||||||
| [[kbd:RET]] | Accept the candidate only |
|
|
||||||
| [[kbd:C-RET]] | Confirm the current prompt only |
|
|
||||||
| [[kbd:S-RET]] | Accept the candidate then immediately confirm the completed prompt |
|
|
||||||
|
|
||||||
- Use [[kbd:RET]] when you want to continue composing after completing;
|
|
||||||
- Use [[kbd:C-RET]] when you already have the desired string, and completing would
|
|
||||||
break it;
|
|
||||||
- Use [[kbd:S-RET]] when you know the composition will be finished after completion
|
|
||||||
(thus avoiding the need to type [[kbd:RET]] twice);
|
|
||||||
|
|
||||||
** Searching with multiple keywords
|
|
||||||
If the [[doom-module::completion corfu +orderless]] flag is enabled, users can
|
If the [[doom-module::completion corfu +orderless]] flag is enabled, users can
|
||||||
perform code completion with multiple search keywords by use of space as the
|
perform code completion with multiple search keywords by use of space as the
|
||||||
separator. More information can be found [[https://github.com/oantolin/orderless#company][here]]. Pressing [[kdb:][C-SPC]] again while
|
separator. More information can be found [[https://github.com/oantolin/orderless#company][here]]. Pressing [[kdb:][C-SPC]] again while
|
||||||
|
@ -139,16 +194,12 @@ backslash, including the space in the search term, and pressing it with an
|
||||||
already escaped separator before point deletes it. Thus, you can cycle back if
|
already escaped separator before point deletes it. Thus, you can cycle back if
|
||||||
you accidentaly press more than needed.
|
you accidentaly press more than needed.
|
||||||
|
|
||||||
Additionally, for users of evil and regular corfu style, [[kdb:][C-SPC]] is smart
|
| Keybind | Description |
|
||||||
regarding your state. In normal-like states, enter insert then start corfu; in
|
|---------+-------------------------------------------------|
|
||||||
visual-like states, perform [[help:evil-change][evil-change]] (which leaves you in insert state) then
|
| [[kbd:][C-SPC]] | (evil) (when completing) Insert separator DWIM |
|
||||||
start corfu; in insert-like states, start corfu immediatelly.
|
| [[kbd:][M-SPC]] | (emacs) (when completing) Insert separator DWIM |
|
||||||
|
| [[kbd:][SPC]] | (when completing) Quit autocompletion |
|
||||||
** Exporting to the minibuffer
|
| [[kbd:][SPC]] | (when completing with separators) Self-insert |
|
||||||
The entries shown in the completion popup can be exported to a ~completing-read~
|
|
||||||
minibuffer, giving access to all the manipulations that suite allows. Using
|
|
||||||
Vertico for instance, one could use this to export with [[doom-package:embark]] via
|
|
||||||
[[kbd:][C-c C-l]] and get a buffer with all candidates.
|
|
||||||
|
|
||||||
** Manually call generic CAPFs
|
** Manually call generic CAPFs
|
||||||
Completion at point functions have the property that, when called interactively
|
Completion at point functions have the property that, when called interactively
|
||||||
|
@ -156,21 +207,37 @@ via their symbol, they work as a call to ~completion-at-point~ where
|
||||||
[[var:completion-at-point-functions]] is bound to that CAPF alone. This allows to
|
[[var:completion-at-point-functions]] is bound to that CAPF alone. This allows to
|
||||||
assign generic functions to a binding and call as needed, leaving the default
|
assign generic functions to a binding and call as needed, leaving the default
|
||||||
value used for most completion tasks much leaner (thus, faster and easier to
|
value used for most completion tasks much leaner (thus, faster and easier to
|
||||||
look through). This module provides some such bindings for Evil users (see the
|
look through). As an example, set the these binds with the following snippet:
|
||||||
table below), and you're free map your own of course. Emacs users have to map it
|
|
||||||
themselves for now, due to the author's lack of knowledge on ergonomic
|
|
||||||
equivalents to the Evil ones. If you have suggestions, though, we'd be happy to
|
|
||||||
know!
|
|
||||||
|
|
||||||
| Keybind | Description |
|
| Keybind | Description |
|
||||||
|---------+---------------------------------|
|
|---------+------------------|
|
||||||
| [[kbd:][C-x]] [[kbd:][C-l]] | (insert-state) ~cape-line~ |
|
| [[kbd:][C-x]] [[kbd:][C-l]] | ~cape-line~ |
|
||||||
| [[kbd:][C-x]] [[kbd:][C-k]] | (insert-state) ~cape-keyword~ |
|
| [[kbd:][C-x]] [[kbd:][C-k]] | ~cape-keyword~ |
|
||||||
| [[kbd:][C-x]] [[kbd:][C-f]] | (insert-state) ~cape-file~ |
|
| [[kbd:][C-x]] [[kbd:][C-f]] | ~cape-file~ |
|
||||||
| [[kbd:][C-x]] [[kbd:][s]] | (insert-state) ~cape-dict~ |
|
| [[kbd:][C-x]] [[kbd:][s]] | ~cape-dict~ |
|
||||||
| [[kbd:][C-x]] [[kbd:][C-s]] | (insert-state) ~yasnippet-capf~ |
|
| [[kbd:][C-x]] [[kbd:][C-s]] | ~yasnippet-capf~ |
|
||||||
| [[kbd:][C-x]] [[kbd:][C-n]] | (insert-state) ~cape-dabbrev~ |
|
| [[kbd:][C-x]] [[kbd:][C-n]] | ~cape-dabbrev~ |
|
||||||
| [[kbd:][C-x]] [[kbd:][C-p]] | (insert-state) ~cape-history~ |
|
| [[kbd:][C-x]] [[kbd:][C-p]] | ~cape-history~ |
|
||||||
|
|
||||||
|
#+begin_src emacs-lisp
|
||||||
|
;; `corfu-mode-map' is not tied to the popup being visible, whereas `corfu-map'
|
||||||
|
;; is only active while completing.
|
||||||
|
(map! :map corfu-mode-map
|
||||||
|
:prefix "C-x"
|
||||||
|
"C-l" #'cape-line
|
||||||
|
"C-k" #'cape-keyword
|
||||||
|
"C-f" #'cape-file
|
||||||
|
"s" #'cape-dict
|
||||||
|
"C-s" #'yasnippet-capf
|
||||||
|
"C-n" #'cape-dabbrev
|
||||||
|
"C-p" #'cape-history)
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
** Exporting to the minibuffer
|
||||||
|
The entries shown in the completion popup can be exported to another
|
||||||
|
~completion-in-region~ minibuffer, giving access to all the manipulations those
|
||||||
|
suites allow. Using Vertico for instance, one could use this to export with
|
||||||
|
[[doom-package:embark]] via [[kbd:][C-c C-l]] and get a buffer with all candidates.
|
||||||
|
|
||||||
* Configuration
|
* Configuration
|
||||||
A few variables may be set to change behavior of this module:
|
A few variables may be set to change behavior of this module:
|
||||||
|
@ -191,15 +258,18 @@ A few variables may be set to change behavior of this module:
|
||||||
- [[var:corfu-auto-prefix]] ::
|
- [[var:corfu-auto-prefix]] ::
|
||||||
Number of characters till auto-completion starts to happen. Defaults to 2.
|
Number of characters till auto-completion starts to happen. Defaults to 2.
|
||||||
- [[var:corfu-on-exact-match]] ::
|
- [[var:corfu-on-exact-match]] ::
|
||||||
Configures behavior for exact matches. Its default is nil, and it's
|
Configures behavior for exact matches.
|
||||||
recommended to leave it at that. Otherwise, single matches on snippet keys
|
- [[var:corfu-preselect]] ::
|
||||||
expand immediately.
|
Configures startup selection, choosing between the first candidate or the
|
||||||
|
prompt.
|
||||||
|
- [[var:corfu-preview-current]] ::
|
||||||
|
Configures current candidate preview.
|
||||||
- [[var:+corfu-buffer-scanning-size-limit]] ::
|
- [[var:+corfu-buffer-scanning-size-limit]] ::
|
||||||
Sets the maximum buffer size to be scanned by ~cape-dabbrev~. Defaults to 1
|
Sets the maximum buffer size to be scanned by ~cape-dabbrev~. Defaults to 1
|
||||||
MB. Set this if you are having performance problems using the CAPF.
|
MB. Set this if you are having performance problems using the CAPF.
|
||||||
- [[var:+corfu-want-C-x-bindings]] ::
|
- [[var:+corfu-want-minibuffer-completion]] ::
|
||||||
Enables autocompletion backends to be bound under the ~C-x~ prefix. This
|
Enables Corfu in the minibuffer, where it may be obtrusive. May also be set
|
||||||
overrides some built-in Emacs keybindings.
|
to ~aggresive~ to enable even in some places without ~completion-at-point~.
|
||||||
|
|
||||||
** Adding CAPFs to a mode
|
** Adding CAPFs to a mode
|
||||||
To add other CAPFs on a mode-per-mode basis, put either of the following in your
|
To add other CAPFs on a mode-per-mode basis, put either of the following in your
|
||||||
|
@ -215,6 +285,30 @@ To add other CAPFs on a mode-per-mode basis, put either of the following in your
|
||||||
see ~add-hook!~'s documentation for additional ways to call it. ~add-hook~ only
|
see ~add-hook!~'s documentation for additional ways to call it. ~add-hook~ only
|
||||||
accepts the quoted arguments form above.
|
accepts the quoted arguments form above.
|
||||||
|
|
||||||
|
For programming modes where you want a CAPF to be active only in documentation
|
||||||
|
and comments, define the following function and use it as a Cape predicate. It
|
||||||
|
fixes the issue Cape's implementation has with tree-sitter.
|
||||||
|
|
||||||
|
#+begin_src emacs-lisp
|
||||||
|
;;;###autoload
|
||||||
|
(defun +corfu-in-doc-or-comment-p (&optional _sym)
|
||||||
|
"Return non-nil if point is in a docstring or comment."
|
||||||
|
(or (nth 4 (syntax-ppss))
|
||||||
|
(when-let ((faces '(font-lock-comment-face
|
||||||
|
font-lock-doc-face
|
||||||
|
tree-sitter-hl-face:doc
|
||||||
|
tree-sitter-hl-face:comment))
|
||||||
|
(fs (get-text-property (point) 'face)))
|
||||||
|
(if (listp fs)
|
||||||
|
(cl-loop for f in fs
|
||||||
|
if (memq f faces)
|
||||||
|
return t)
|
||||||
|
(memq fs faces)))))
|
||||||
|
|
||||||
|
;; Use this as #'some-capf above
|
||||||
|
(cape-capf-predicate #'another-capf #'+corfu-in-doc-or-comment-p)
|
||||||
|
#+end_src
|
||||||
|
|
||||||
** Adding CAPFs to a key
|
** Adding CAPFs to a key
|
||||||
To add other CAPFs to keys, adapt the snippet below into your ~config.el~:
|
To add other CAPFs to keys, adapt the snippet below into your ~config.el~:
|
||||||
#+begin_src emacs-lisp
|
#+begin_src emacs-lisp
|
||||||
|
@ -222,7 +316,7 @@ To add other CAPFs to keys, adapt the snippet below into your ~config.el~:
|
||||||
;; after some-mode-hook runs. Line 2 is needed only if the binding can't leak
|
;; after some-mode-hook runs. Line 2 is needed only if the binding can't leak
|
||||||
;; into other Corfu buffers. When neither of the above make sense, the `map!'
|
;; into other Corfu buffers. When neither of the above make sense, the `map!'
|
||||||
;; call is enough.
|
;; call is enough.
|
||||||
(add-hook! some-mode ; Only needed if the binding is mode-specific
|
(add-hook! some-mode
|
||||||
(make-local-variable 'corfu-mode-map)
|
(make-local-variable 'corfu-mode-map)
|
||||||
(map! :map corfu-mode-map
|
(map! :map corfu-mode-map
|
||||||
:prefix "C-x" ; C-x is usually used as prefix, but it's not required
|
:prefix "C-x" ; C-x is usually used as prefix, but it's not required
|
||||||
|
|
|
@ -1,13 +1,5 @@
|
||||||
;;; completion/corfu/autoload.el -*- lexical-binding: t; -*-
|
;;; completion/corfu/autoload.el -*- lexical-binding: t; -*-
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun +corfu-complete-and-exit-minibuffer ()
|
|
||||||
(interactive)
|
|
||||||
(if (>= corfu--index 0)
|
|
||||||
(corfu-complete)
|
|
||||||
(corfu-insert))
|
|
||||||
(exit-minibuffer))
|
|
||||||
|
|
||||||
;;;###autoload
|
;;;###autoload
|
||||||
(defun +corfu-move-to-minibuffer ()
|
(defun +corfu-move-to-minibuffer ()
|
||||||
"Move the current list of candidates to your choice of minibuffer completion UI."
|
"Move the current list of candidates to your choice of minibuffer completion UI."
|
||||||
|
@ -46,21 +38,4 @@
|
||||||
(save-excursion (backward-char 1)
|
(save-excursion (backward-char 1)
|
||||||
(insert-char ?\\)))
|
(insert-char ?\\)))
|
||||||
(t
|
(t
|
||||||
;; Without this corfu quits immediately.
|
|
||||||
(setq this-command #'corfu-insert-separator)
|
|
||||||
(call-interactively #'corfu-insert-separator))))
|
(call-interactively #'corfu-insert-separator))))
|
||||||
|
|
||||||
;;;###autoload
|
|
||||||
(defun +corfu-in-doc-or-comment-p (_sym)
|
|
||||||
"Return non-nil if point is in a docstring or comment."
|
|
||||||
(or (nth 4 (syntax-ppss))
|
|
||||||
(when-let ((faces '(font-lock-comment-face
|
|
||||||
font-lock-doc-face
|
|
||||||
tree-sitter-hl-face:doc
|
|
||||||
tree-sitter-hl-face:comment))
|
|
||||||
(fs (get-text-property (point) 'face)))
|
|
||||||
(if (listp fs)
|
|
||||||
(cl-loop for f in fs
|
|
||||||
if (memq f faces)
|
|
||||||
return t)
|
|
||||||
(memq fs faces)))))
|
|
||||||
|
|
|
@ -3,9 +3,6 @@
|
||||||
(defvar +corfu-buffer-scanning-size-limit (* 1 1024 1024) ; 1 MB
|
(defvar +corfu-buffer-scanning-size-limit (* 1 1024 1024) ; 1 MB
|
||||||
"Size limit for a buffer to be scanned by `cape-dabbrev'.")
|
"Size limit for a buffer to be scanned by `cape-dabbrev'.")
|
||||||
|
|
||||||
(defvar +corfu-want-C-x-bindings t
|
|
||||||
"Whether `C-x' is a completion prefix in Evil insert state.")
|
|
||||||
|
|
||||||
(defvar +corfu-want-minibuffer-completion t
|
(defvar +corfu-want-minibuffer-completion t
|
||||||
"Whether to enable Corfu in the minibuffer.
|
"Whether to enable Corfu in the minibuffer.
|
||||||
Setting this to `aggressive' will enable Corfu in more commands which
|
Setting this to `aggressive' will enable Corfu in more commands which
|
||||||
|
@ -50,22 +47,18 @@ use the minibuffer such as `query-replace'.")
|
||||||
t)
|
t)
|
||||||
corfu-cycle t
|
corfu-cycle t
|
||||||
corfu-separator (when (modulep! +orderless) ?\s)
|
corfu-separator (when (modulep! +orderless) ?\s)
|
||||||
corfu-preselect (if (modulep! +tng) 'prompt 'valid)
|
corfu-preselect 'prompt
|
||||||
corfu-count 16
|
corfu-count 16
|
||||||
corfu-max-width 120
|
corfu-max-width 120
|
||||||
corfu-preview-current 'insert
|
corfu-preview-current 'insert
|
||||||
corfu-on-exact-match nil
|
corfu-on-exact-match nil
|
||||||
corfu-quit-at-boundary (if (modulep! +orderless) 'separator t)
|
corfu-quit-at-boundary (if (modulep! +orderless) 'separator t)
|
||||||
corfu-quit-no-match (if (modulep! +orderless) 'separator t)
|
corfu-quit-no-match (if (modulep! +orderless) 'separator t)
|
||||||
;; In the case of +tng, TAB should be smart regarding completion;
|
tab-always-indent 'complete)
|
||||||
;; However, it should otherwise behave like normal, whatever normal was.
|
|
||||||
tab-always-indent (if (modulep! +tng) 'complete tab-always-indent))
|
|
||||||
(add-to-list 'completion-category-overrides `(lsp-capf (styles ,@completion-styles)))
|
(add-to-list 'completion-category-overrides `(lsp-capf (styles ,@completion-styles)))
|
||||||
(add-to-list 'corfu-auto-commands #'lispy-colon)
|
(add-to-list 'corfu-auto-commands #'lispy-colon)
|
||||||
|
|
||||||
(add-to-list 'corfu-continue-commands #'+corfu-move-to-minibuffer)
|
(add-to-list 'corfu-continue-commands #'+corfu-move-to-minibuffer)
|
||||||
|
(add-to-list 'corfu-continue-commands #'+corfu-smart-sep-toggle-escape)
|
||||||
|
|
||||||
(add-hook 'evil-insert-state-exit-hook #'corfu-quit)
|
(add-hook 'evil-insert-state-exit-hook #'corfu-quit)
|
||||||
|
|
||||||
(when (modulep! +icons)
|
(when (modulep! +icons)
|
||||||
|
@ -116,28 +109,6 @@ use the minibuffer such as `query-replace'.")
|
||||||
"\\(TAGS\\|tags\\|ETAGS\\|etags\\|GTAGS\\|GRTAGS\\|GPATH\\)\\(<[0-9]+>\\)?")
|
"\\(TAGS\\|tags\\|ETAGS\\|etags\\|GTAGS\\|GRTAGS\\|GPATH\\)\\(<[0-9]+>\\)?")
|
||||||
dabbrev-upcase-means-case-search t)
|
dabbrev-upcase-means-case-search t)
|
||||||
(add-to-list 'dabbrev-ignored-buffer-modes 'pdf-view-mode)))
|
(add-to-list 'dabbrev-ignored-buffer-modes 'pdf-view-mode)))
|
||||||
;; Complete emojis :).
|
|
||||||
(when (and (modulep! +emoji) (> emacs-major-version 28))
|
|
||||||
(add-hook! (prog-mode conf-mode)
|
|
||||||
(defun +corfu-add-cape-emoji-h ()
|
|
||||||
(add-hook 'completion-at-point-functions
|
|
||||||
(cape-capf-predicate (cape-capf-prefix-length #'cape-emoji 1)
|
|
||||||
#'+corfu-in-doc-or-comment-p)
|
|
||||||
10 t)))
|
|
||||||
(add-hook! text-mode
|
|
||||||
(defun +corfu-add-cape-emoji-text-h ()
|
|
||||||
(add-hook 'completion-at-point-functions
|
|
||||||
(cape-capf-prefix-length #'cape-emoji 1) 10 t))))
|
|
||||||
;; Enable dictionary-based autocompletion.
|
|
||||||
(when (modulep! +dict)
|
|
||||||
(add-hook! (prog-mode conf-mode)
|
|
||||||
(defun +corfu-add-cape-dict-h ()
|
|
||||||
(add-hook 'completion-at-point-functions
|
|
||||||
(cape-capf-predicate #'+corfu-in-doc-or-comment-p #'cape-dict)
|
|
||||||
40 t)))
|
|
||||||
(add-hook! text-mode
|
|
||||||
(defun +corfu-add-cape-dict-text-h ()
|
|
||||||
(add-hook 'completion-at-point-functions #'cape-dict 40 t))))
|
|
||||||
|
|
||||||
;; Make these capfs composable.
|
;; Make these capfs composable.
|
||||||
(advice-add #'comint-completion-at-point :around #'cape-wrap-nonexclusive)
|
(advice-add #'comint-completion-at-point :around #'cape-wrap-nonexclusive)
|
||||||
|
|
|
@ -162,34 +162,32 @@
|
||||||
(:when (modulep! :completion corfu)
|
(:when (modulep! :completion corfu)
|
||||||
(:after corfu
|
(:after corfu
|
||||||
(:map corfu-mode-map
|
(:map corfu-mode-map
|
||||||
:e "C-M-i" #'completion-at-point
|
|
||||||
(:when +corfu-want-C-x-bindings
|
|
||||||
(:prefix "C-x"
|
|
||||||
:i "C-l" #'cape-line
|
|
||||||
:i "C-k" #'cape-keyword
|
|
||||||
:i "C-f" #'cape-file
|
|
||||||
:i "s" #'cape-dict
|
|
||||||
:i "C-s" #'yasnippet-capf
|
|
||||||
:i "C-n" #'cape-dabbrev
|
|
||||||
:i "C-p" #'cape-history))
|
|
||||||
(:unless (modulep! :completion corfu +tng)
|
|
||||||
:i "C-SPC" #'completion-at-point
|
:i "C-SPC" #'completion-at-point
|
||||||
:n "C-SPC" (cmd! (call-interactively #'evil-insert-state)
|
:n "C-SPC" (cmd! (call-interactively #'evil-insert-state)
|
||||||
(call-interactively #'completion-at-point))
|
(call-interactively #'completion-at-point))
|
||||||
:v "C-SPC" (cmd! (call-interactively #'evil-change)
|
:v "C-SPC" (cmd! (call-interactively #'evil-change)
|
||||||
(call-interactively #'completion-at-point))))
|
(call-interactively #'completion-at-point)))
|
||||||
(:map corfu-map
|
(:map corfu-map
|
||||||
|
"C-SPC" #'corfu-insert-separator
|
||||||
|
"C-k" #'corfu-previous
|
||||||
|
"C-j" #'corfu-next
|
||||||
"C-u" (cmd! (let (corfu-cycle)
|
"C-u" (cmd! (let (corfu-cycle)
|
||||||
(funcall-interactively #'corfu-next (- corfu-count))))
|
(funcall-interactively #'corfu-next (- corfu-count))))
|
||||||
"C-d" (cmd! (let (corfu-cycle)
|
"C-d" (cmd! (let (corfu-cycle)
|
||||||
(funcall-interactively #'corfu-next corfu-count)))))
|
(funcall-interactively #'corfu-next corfu-count)))))
|
||||||
(:after corfu-popupinfo
|
(:after corfu-popupinfo
|
||||||
:map corfu-popupinfo-map
|
:map corfu-popupinfo-map
|
||||||
|
"C-h" #'corfu-popupinfo-toggle
|
||||||
;; Reversed because popupinfo assumes opposite of what feels intuitive
|
;; Reversed because popupinfo assumes opposite of what feels intuitive
|
||||||
;; with evil.
|
;; with evil.
|
||||||
"C-S-k" #'corfu-popupinfo-scroll-down
|
"C-S-k" #'corfu-popupinfo-scroll-down
|
||||||
"C-S-j" #'corfu-popupinfo-scroll-up
|
"C-S-j" #'corfu-popupinfo-scroll-up
|
||||||
"C-h" #'corfu-popupinfo-toggle)))
|
"C-<up>" #'corfu-popupinfo-scroll-down
|
||||||
|
"C-<down>" #'corfu-popupinfo-scroll-up
|
||||||
|
"C-S-p" #'corfu-popupinfo-scroll-down
|
||||||
|
"C-S-n" #'corfu-popupinfo-scroll-up
|
||||||
|
"C-S-u" (cmd! (funcall-interactively #'corfu-popupinfo-scroll-down corfu-popupinfo-min-height))
|
||||||
|
"C-S-d" (cmd! (funcall-interactively #'corfu-popupinfo-scroll-up corfu-popupinfo-min-height)))))
|
||||||
|
|
||||||
;;; :completion (separate)
|
;;; :completion (separate)
|
||||||
(map! (:when (modulep! :completion ivy)
|
(map! (:when (modulep! :completion ivy)
|
||||||
|
|
|
@ -465,51 +465,36 @@ Continues comments if executed from a commented line. Consults
|
||||||
"C-p" #'corfu-previous
|
"C-p" #'corfu-previous
|
||||||
"C-n" #'corfu-next
|
"C-n" #'corfu-next
|
||||||
(:when (modulep! :completion corfu +orderless)
|
(:when (modulep! :completion corfu +orderless)
|
||||||
[remap completion-at-point] #'+corfu-smart-sep-toggle-escape)
|
[remap corfu-insert-separator] #'+corfu-smart-sep-toggle-escape)))
|
||||||
(:when (modulep! :completion corfu +tng)
|
(when-let ((cmds-del
|
||||||
:gi [tab] #'corfu-next
|
|
||||||
:gi "TAB" #'corfu-next
|
|
||||||
:gi [backtab] #'corfu-previous
|
|
||||||
:gi "S-TAB" #'corfu-previous))
|
|
||||||
(:after corfu-popupinfo
|
|
||||||
:map corfu-popupinfo-map
|
|
||||||
"C-<up>" #'corfu-popupinfo-scroll-down
|
|
||||||
"C-<down>" #'corfu-popupinfo-scroll-up
|
|
||||||
"C-S-p" #'corfu-popupinfo-scroll-down
|
|
||||||
"C-S-n" #'corfu-popupinfo-scroll-up
|
|
||||||
"C-S-u" (cmd! (funcall-interactively #'corfu-popupinfo-scroll-down corfu-popupinfo-min-height))
|
|
||||||
"C-S-d" (cmd! (funcall-interactively #'corfu-popupinfo-scroll-up corfu-popupinfo-min-height)))
|
|
||||||
(:when (not (modulep! :completion corfu +tng))
|
|
||||||
(:map corfu-map
|
|
||||||
"C-<return>" `(menu-item "Conclude the minibuffer" exit-minibuffer
|
|
||||||
:filter ,(lambda (cmd) (when (minibufferp nil t) cmd)))
|
|
||||||
"S-<return>" `(menu-item "Insert completion and conclude"
|
|
||||||
+corfu-complete-and-exit-minibuffer
|
|
||||||
:filter ,(lambda (cmd) (when (minibufferp nil t) cmd))))))
|
|
||||||
(when-let ((cmds-del (and (modulep! :completion corfu +tng)
|
|
||||||
`(menu-item "Reset completion" corfu-reset
|
`(menu-item "Reset completion" corfu-reset
|
||||||
:filter ,(lambda (cmd)
|
:filter ,(lambda (cmd)
|
||||||
|
(interactive)
|
||||||
(when (and (>= corfu--index 0)
|
(when (and (>= corfu--index 0)
|
||||||
(eq corfu-preview-current 'insert))
|
(eq corfu-preview-current 'insert))
|
||||||
cmd)))))
|
cmd))))
|
||||||
(cmds-ret `(menu-item "Insert completion" corfu-insert
|
(cmds-ret-pt
|
||||||
|
`(menu-item "Insert completion or pass-through" corfu-insert
|
||||||
:filter ,(lambda (cmd)
|
:filter ,(lambda (cmd)
|
||||||
(cond ((eq corfu--index -1)
|
(interactive)
|
||||||
(corfu-quit))
|
(if (>= corfu--index 0)
|
||||||
((and (modulep! :completion corfu +tng)
|
cmd
|
||||||
(eq corfu-preview-current 'insert)
|
(corfu-quit))))))
|
||||||
(minibufferp nil t))
|
|
||||||
(corfu-insert)
|
|
||||||
nil)
|
|
||||||
(t
|
|
||||||
cmd))))))
|
|
||||||
(map! :when (modulep! :completion corfu)
|
(map! :when (modulep! :completion corfu)
|
||||||
:after corfu
|
:after corfu
|
||||||
:map corfu-map
|
:map corfu-map
|
||||||
[backspace] cmds-del
|
[backspace] cmds-del
|
||||||
"DEL" cmds-del
|
"DEL" cmds-del
|
||||||
:ig [return] cmds-ret
|
(:when (modulep! :completion corfu +on-ret)
|
||||||
:ig "RET" cmds-ret))
|
:gi [return] #'corfu-insert
|
||||||
|
:gi "RET" #'corfu-insert)
|
||||||
|
(:when (modulep! :completion corfu +on-ret-pt)
|
||||||
|
:gi [return] cmds-ret-pt
|
||||||
|
:gi "RET" cmds-ret-pt)
|
||||||
|
(:unless (or (modulep! :completion corfu +on-ret)
|
||||||
|
(modulep! :completion corfu +on-ret-pt))
|
||||||
|
:gi [return] nil
|
||||||
|
:gi "RET" nil)))
|
||||||
|
|
||||||
;; Smarter C-a/C-e for both Emacs and Evil. C-a will jump to indentation.
|
;; Smarter C-a/C-e for both Emacs and Evil. C-a will jump to indentation.
|
||||||
;; Pressing it again will send you to the true bol. Same goes for C-e, except
|
;; Pressing it again will send you to the true bol. Same goes for C-e, except
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue