updating config and corfu module

This commit is contained in:
Matt Nish-Lapidus 2023-10-19 11:23:45 -04:00
parent 8bd123ef11
commit b59a7f8cf8
8 changed files with 224 additions and 298 deletions

View file

@ -25,12 +25,12 @@ highly non-native, but has some extra features and more maturity.
supported.
- +orderless ::
Pull in [[doom-package:orderless]] if necessary and apply multi-component
completion (still needed if [[:completion vertico]] is active).
completion (still needed if [[doom-module::completion vertico]] is active).
** Packages
- [[doom-package:corfu]]
- [[doom-package:cape]]
- [[doom-package:kind-icon]] if [[doom-module::completion corfu +icons]]
- [[doom-package:nerd-icons-completion]] if [[doom-module::completion corfu +icons]]
- [[doom-package:orderless]] if [[doom-module::completion corfu +orderless]]
- [[doom-package:corfu-terminal]] if [[doom-module::os tty]]
- [[doom-package:yasnippet-capf]] if [[doom-module::editor snippets]]
@ -78,13 +78,13 @@ is visible, the following relevant keys are available:
| [[kbd:][C-S-j]] | (evil) Go to next doc line |
| [[kbd:][C-S-k]] | (evil) Go to previous doc line |
| [[kbd:][C-h]] | Toggle documentation (if available) |
| [[kbd:][s-<down>]] | Export to minibuffer (if [[doom-module:][:completion vertico]]) |
| [[kbd:][s-j]] | (evil) Export to minibuffer (if [[doom-module:][:completion vertico]]) |
| [[kbd:][s-<down>]] | Export to minibuffer (if [[doom-module::completion vertico]]) |
| [[kbd:][s-j]] | (evil) Export to minibuffer (if [[doom-module::completion vertico]]) |
| [[kbd:][RET]] | Insert candidate |
| [[kbd:][C-SPC]] | (when completing) Insert separator (see below) |
| [[kbd:][C-SPC]] | Complete (unless [[doom-module:][:completion corfu +tng]]) |
| [[kbd:][C-SPC]] | Complete (unless [[doom-module::completion corfu +tng]]) |
If you prefer a [[kbd:][TAB]]-centric completion style, enable the [[doom-module:][:completion corfu +tng]]
If you prefer a [[kbd:][TAB]]-centric completion style, enable the [[doom-module::completion corfu +tng]]
flag so that, instead, you trigger completion with [[kbd:][TAB]], getting the following
additional binds:
@ -95,15 +95,16 @@ additional binds:
| [[kbd:][S-TAB]] | (when completing) Go to previous candidate |
** Searching with multiple keywords
If the ~+orderless~ flag is enabled, users can perform code completion
with multiple search keywords by use of space as separator. More information can
be found [[https://github.com/oantolin/orderless#company][here]]. Pressing [[kdb:][C-SPC]] again while completing inserts a space as
separator. This allows searching with space-separated terms; each piece will
match individually and in any order, with smart casing. Pressing just [[kbd:][SPC]] acts
as normal and restarts completion, so that when typing sentences it doesn't try
to complete the whole sentence instead of just the word.
If the [[doom-module::completion corfu +orderless]] flag is enabled, users can
perform code completion with multiple search keywords by use of space as
separator. More information can be found [[https://github.com/oantolin/orderless#company][here]]. Pressing [[kdb:][C-SPC]] again while
completing inserts a space as separator. This allows searching with
space-separated terms; each piece will match individually and in any order, with
smart casing. Pressing just [[kbd:][SPC]] acts as normal and restarts completion, so that
when typing sentences it doesn't try to complete the whole sentence instead of
just the word.
** Exporting to the minibuffer (requires [[doom-module:][:completion vertico]])
** Exporting to the minibuffer (requires [[doom-module::completion vertico]])
When using the [[doom-module::completion vertico]] module, which pulls in the
[[doom-package:consult]] package, the entries shown in the completion popup can be
exported to a consult minibuffer, giving access to all the manipulations the
@ -117,13 +118,28 @@ A few variables may be set to change behavior of this module:
Number of seconds till completion occurs automatically. Defaults to 0.1.
- [[var:corfu-auto-prefix]] ::
Number of characters till auto-completion starts to happen. Defaults to 2.
- [[var:+corfu-want-multi-component]] ::
Sets whether orderless-style matching should be supported with space as a
separator.
- [[var:corfu-on-exact-match]] ::
Configures behavior for exact matches. Its default is nil, and it's
recommended to leave it at that. Otherwise, single matches on snippet keys
expand immediately.
- [[var:+corfu-completion-styles]] ::
Used to override [[var:completion-styles]] for corfu invocations, such that it
can have a value separate from, say, [[doom-package:consult]].
- [[var:+corfu-icon-mapping]] ::
Configures icons used for each completion. See its documentation for details.
** Adding CAPFs to a mode
To add other CAPFs on a mode-per-mode basis, put either of the following in your
~config.el~:
#+begin_src emacs-lisp
(add-hook! some-mode (add-to-list 'completion-at-point-functions #'some-capf))
;; OR, but note the different call signature
(add-hook 'some-mode-hook (lambda () (add-to-list 'completion-at-point-functions #'some-capf)))
#+end_src
Also see ~add-hook!~'s documentation for additional ways to call it.
~add-hook~ only accepts the quoted arguments form above.
* Troubleshooting
[[doom-report:][Report an issue?]]

View file

@ -1,9 +1,64 @@
;;; completion/corfu/config.el -*- lexical-binding: t; -*-
(defvar +corfu-completion-styles '(basic partial-completion flex)
"Completion styles for corfu to use.
If the user enables +orderless, `orderless' is automatically appended to this
list before fowarding to `completion-styles'.")
(defvar +corfu-icon-mapping
`((array ,(nerd-icons-codicon "nf-cod-symbol_array") :face font-lock-type-face)
(boolean ,(nerd-icons-codicon "nf-cod-symbol_boolean") :face font-lock-builtin-face)
(class ,(nerd-icons-codicon "nf-cod-symbol_class") :face font-lock-type-face)
(color ,(nerd-icons-codicon "nf-cod-symbol_color") :face success)
(command ,(nerd-icons-codicon "nf-cod-terminal") :face default)
(constant ,(nerd-icons-codicon "nf-cod-symbol_constant") :face font-lock-constant-face)
(constructor ,(nerd-icons-codicon "nf-cod-triangle_right") :face font-lock-function-name-face)
(enummember ,(nerd-icons-codicon "nf-cod-symbol_enum_member") :face font-lock-builtin-face)
(enum-member ,(nerd-icons-codicon "nf-cod-symbol_enum_member") :face font-lock-builtin-face)
(enum ,(nerd-icons-codicon "nf-cod-symbol_enum") :face font-lock-builtin-face)
(event ,(nerd-icons-codicon "nf-cod-symbol_event") :face font-lock-warning-face)
(field ,(nerd-icons-codicon "nf-cod-symbol_field") :face font-lock-variable-name-face)
(file ,(nerd-icons-codicon "nf-cod-symbol_file") :face font-lock-string-face)
(folder ,(nerd-icons-codicon "nf-cod-folder") :face font-lock-doc-face)
(interface ,(nerd-icons-codicon "nf-cod-symbol_interface") :face font-lock-type-face)
(keyword ,(nerd-icons-codicon "nf-cod-symbol_keyword") :face font-lock-keyword-face)
(macro ,(nerd-icons-codicon "nf-cod-symbol_misc") :face font-lock-keyword-face)
(magic ,(nerd-icons-codicon "nf-cod-wand") :face font-lock-builtin-face)
(method ,(nerd-icons-codicon "nf-cod-symbol_method") :face font-lock-function-name-face)
(function ,(nerd-icons-codicon "nf-cod-symbol_method") :face font-lock-function-name-face)
(module ,(nerd-icons-codicon "nf-cod-file_submodule") :face font-lock-preprocessor-face)
(numeric ,(nerd-icons-codicon "nf-cod-symbol_numeric") :face font-lock-builtin-face)
(operator ,(nerd-icons-codicon "nf-cod-symbol_operator") :face font-lock-comment-delimiter-face)
(param ,(nerd-icons-codicon "nf-cod-symbol_parameter") :face default)
(property ,(nerd-icons-codicon "nf-cod-symbol_property") :face font-lock-variable-name-face)
(reference ,(nerd-icons-codicon "nf-cod-references") :face font-lock-variable-name-face)
(snippet ,(nerd-icons-codicon "nf-cod-symbol_snippet") :face font-lock-string-face)
(string ,(nerd-icons-codicon "nf-cod-symbol_string") :face font-lock-string-face)
(struct ,(nerd-icons-codicon "nf-cod-symbol_structure") :face font-lock-variable-name-face)
(text ,(nerd-icons-codicon "nf-cod-text_size") :face font-lock-doc-face)
(typeparameter ,(nerd-icons-codicon "nf-cod-list_unordered") :face font-lock-type-face)
(type-parameter ,(nerd-icons-codicon "nf-cod-list_unordered") :face font-lock-type-face)
(unit ,(nerd-icons-codicon "nf-cod-symbol_ruler") :face font-lock-constant-face)
(value ,(nerd-icons-codicon "nf-cod-symbol_field") :face font-lock-builtin-face)
(variable ,(nerd-icons-codicon "nf-cod-symbol_variable") :face font-lock-variable-name-face)
(t ,(nerd-icons-codicon "nf-cod-code") :face font-lock-warning-face))
"Mapping of completion kinds to icons.
It should be a list of elements with the form (KIND ICON-TXT [:face FACE]).
KIND is a symbol determining what the completion is, and comes from calling the
`:company-kind' property of the completion. ICON-TXT is a string with the icon
to use, usually as a character from the `nerd-icons' symbol font. See that
package for how to get these. Note that it can be simple text if that is
preferred. FACE, if present, is applied to the icon, mainly for its color. The
special `t' symbol should be used for KIND to represent the default icon, and
must be present.")
;;
;;; Packages
(use-package! corfu
:hook (doom-first-buffer . global-corfu-mode)
:hook (org-mode . corfu-mode)
:init
;; Auto-completion settings, must be set before calling `global-corfu-mode'.
;; Due to lazy-loading, setting them in config.el works too.
@ -16,8 +71,6 @@
gud-mode
vterm-mode))
:config
(add-to-list 'completion-styles 'partial-completion t)
(add-to-list 'completion-styles 'initials t)
(setq corfu-cycle t
corfu-separator (when (modulep! +orderless) ?\s)
corfu-preselect t
@ -30,12 +83,50 @@
;; In the case of +tng, TAB should be smart regarding completion;
;; However, it should otherwise behave like normal, whatever normal was.
tab-always-indent (if (modulep! +tng) 'complete tab-always-indent))
(when (modulep! +orderless)
(cond ((modulep! :tools lsp +eglot) (add-to-list 'completion-category-overrides '(eglot (styles orderless))))
((modulep! :tools lsp) (add-hook 'lsp-completion-mode-hook
(defun doom--use-orderless-lsp-capf ()
(setf (alist-get 'styles (alist-get 'lsp-capf completion-category-defaults))
'(orderless)))))))
(after! 'lsp-mode
(add-to-list 'completion-category-overrides
`(lsp-capf (styles ,@+corfu-completion-styles ,(when (modulep! +orderless) 'orderless)))))
(after! 'eglot
(add-to-list 'completion-category-overrides
`(eglot (styles ,@+corfu-completion-styles ,(when (modulep! +orderless) 'orderless))))))
;; For the icons, we use a custom margin formatter, which simply reads the
;; mapping in `+corfu-icon-mapping'.
(when (modulep! +icons)
(defun icon-margin-formatter (metadata)
(when-let ((kindfunc (or (plist-get completion-extra-properties :company-kind)
(assq 'company-kind metadata))))
(lambda (cand)
(let* ((kind (funcall kindfunc cand))
(icon-entry (assq (or kind t) +corfu-icon-mapping))
(str (cadr icon-entry))
(props (cddr icon-entry))
(extra-face (plist-get props :face))
(space (propertize " " 'display '(space :width 1)))
(str (concat " " str space)))
(when extra-face
(put-text-property 0 3 'face extra-face str))
str))))
(setq corfu-margin-formatters '(icon-margin-formatter)))
;; This is to decouple the use of `completion-styles' in corfu from other
;; completion packages, such as vertico. That way, the user can leave the
;; global value of the variable alone, say, to be used by the default
;; front-end or consult. The vertico module also does something similar with
;; `+vertico-company-completion-styles'.
(defadvice! +corfu--completion-styles (orig &rest args)
"Try default completion styles before orderless.
Meant as :around advice for `corfu--recompute'."
:around #'corfu--recompute
(let ((completion-styles
(append +corfu-completion-styles (when (modulep! +orderless)
'(orderless))))
completion-category-overrides completion-category-defaults)
(apply orig args)))
(map! (:unless (modulep! +tng)
"C-SPC" #'completion-at-point)
(:map 'corfu-map
@ -46,8 +137,7 @@
[backtab] #'corfu-previous
"TAB" #'corfu-next
"S-TAB" #'corfu-previous)))
(when (modulep! :editor evil)
(after! evil-collection-corfu
(evil-collection-define-key 'insert 'corfu-map
(kbd "RET") #'corfu-insert
[return] #'corfu-insert))
@ -66,10 +156,9 @@
(use-package! cape
:after corfu
:config
(add-hook 'prog-mode-hook
(lambda () (add-to-list 'completion-at-point-functions #'cape-file)))
(add-hook! (markdown-mode org-mode)
(lambda () (add-to-list 'completion-at-point-functions #'cape-elisp-block))))
(add-hook! prog-mode (add-to-list 'completion-at-point-functions #'cape-file))
(add-hook! (org-mode markdown-mode) (add-to-list 'completion-at-point-functions #'cape-elisp-block))
(advice-add #'lsp-completion-at-point :around #'cape-wrap-noninterruptible))
(use-package! yasnippet-capf
:after corfu
@ -77,47 +166,6 @@
(add-hook 'yas-minor-mode-hook
(lambda () (add-to-list 'completion-at-point-functions #'yasnippet-capf))))
(use-package! svg-lib
:after kind-icon)
(use-package! kind-icon
:commands (kind-icon-margin-formatter
kind-icon-reset-cache
kind-icon-formatted)
:init
(add-hook 'corfu-margin-formatters #'kind-icon-margin-formatter)
:config
(defface corfu-kind-icon '((t :inherit corfu-default))
"Face for the icons in the corfu popup.
For changing color, you should probably use `kind-icon-mapping', which see. The
purpose here is overriding size and helping with scaling issues."
:group 'corfu)
(setq kind-icon-default-face 'corfu-kind-icon
kind-icon-blend-background t
kind-icon-blend-frac 0.2)
(let ((def-style (svg-lib-style-compute-default 'corfu-kind-icon))
res)
(cl-loop for (key value) on def-style by 'cddr
do (unless (member key '(:foreground
:background
:font-size
:font-width
:font-weight
:font-family
:width))
(setq res (plist-put res key value))))
(setq kind-icon-default-style (plist-put res :stroke 0.25)))
(defadvice! doom--kind-icon-remove-padding (orig kind)
"Rescale icon images to 1, and set surrounding spaces to width 0.
This fixes the cropping due to scaling issues."
:around #'kind-icon-formatted
(let* ((text (funcall orig kind))
(image (get-text-property 1 'display text)))
(when (eq (car-safe image) 'image)
(setf (image-property image :scale) 1)
(put-text-property 0 1 'display '(space :width (0)) text)
(put-text-property 2 3 'display '(space :width (0)) text))
text)))
(use-package! corfu-terminal
:when (not (display-graphic-p))
:hook (corfu-mode . corfu-terminal-mode))

View file

@ -1,14 +1,13 @@
;; -*- no-byte-compile: t; -*-
;;; completion/corfu/packages.el
(package! corfu)
(package! cape)
(package! corfu :recipe (:files ("*.el" "extensions/*.el")) :pin "cc244c54b392ce4d27ed166730efde4f4d01a07f")
(package! cape :pin "4506ee82129a8e9ff9e4650a9b16eb8c4ae355f3")
(when (modulep! +icons)
(package! svg-lib)
(package! kind-icon))
(package! nerd-icons-completion :pin "c2db8557a3c1a9588d111f8c8e91cae96ee85010"))
(when (modulep! +orderless)
(package! orderless))
(package! orderless :pin "e6784026717a8a6a7dcd0bf31fd3414f148c542e"))
(when (modulep! :os tty)
(package! corfu-terminal))
(package! corfu-terminal :pin "501548c3d51f926c687e8cd838c5865ec45d03cc"))
(when (modulep! :editor snippets)
(package! yasnippet-capf))
(package! yasnippet-capf :pin "40654214db7a44db3a99321447632b43a10fae57"))

View file

@ -56,116 +56,6 @@
"'" #'repeat
"<escape>" #'corfu-quit))
;; Colemak
(defun meow/setup-colemak ()
(setq meow-cheatsheet-layout meow-cheatsheet-layout-colemak)
(meow/setup)
(when (modulep! +override)
(meow-motion-overwrite-define-key
;; Use e to move up, n to move down.
;; Since special modes usually use n to move down, we only overwrite e here.
'("e" . meow-prev))
(when (modulep! :editor meow +leader)
(meow-motion-overwrite-define-key '("\\ e" . "H-e")))
(meow-leader-define-key '("e" . "H-e")))
(map! :map meow-normal-state-keymap
"[" #'meow-beginning-of-thing
"]" #'meow-end-of-thing
"/" #'meow-visit
"a" #'meow-append
"A" #'meow-open-below
"b" #'meow-back-word
"B" #'meow-back-symbol
"c" #'meow-change
"d" #'meow-delete
"e" #'meow-prev
"E" #'meow-prev-expand
"f" #'meow-find
"g" #'meow-cancel-selection
"G" #'meow-grab
"h" #'meow-left
"H" #'meow-left-expand
"i" #'meow-right
"I" #'meow-right-expand
"j" #'meow-join
"k" #'meow-kill
"l" #'meow-line
"L" #'meow-goto-line
"m" #'meow-mark-word
"M" #'meow-mark-symbol
"n" #'meow-next
"N" #'meow-next-expand
"o" #'meow-block
"O" #'meow-to-block
"p" #'meow-yank
"q" #'meow-quit
"r" #'meow-replace
"s" #'meow-insert
"S" #'meow-open-above
"t" #'meow-till
"u" #'meow-undo
"U" #'meow-undo-in-selection
"v" #'meow-search
"w" #'meow-next-word
"W" #'meow-next-symbol
"x" #'meow-delete
"X" #'meow-backward-delete
"y" #'meow-save
"z" #'meow-pop-selection))
;; Dvorak
(defun meow/setup-dvorak ()
(setq meow-cheatsheet-layout meow-cheatsheet-layout-dvorak)
(when (modulep! +override)
(meow-motion-overwrite-define-key)) ; custom keybinding for motion state
(meow/setup)
(map! :map meow-normal-state-keymap
"<" #'meow-beginning-of-thing
">" #'meow-end-of-thing
"a" #'meow-append
"A" #'meow-open-below
"b" #'meow-back-word
"B" #'meow-back-symbol
"c" #'meow-change
"d" #'meow-delete
"D" #'meow-backward-delete
"e" #'meow-line
"E" #'meow-goto-line
"f" #'meow-find
"g" #'meow-cancel-selection
"G" #'meow-grab
"h" #'meow-left
"H" #'meow-left-expand
"I" #'meow-open-above
"i" #'meow-insert
"j" #'meow-join
"k" #'meow-kill
"l" #'meow-till
"m" #'meow-mark-word
"M" #'meow-mark-symbol
"n" #'meow-next
"N" #'meow-next-expand
"o" #'meow-block
"O" #'meow-to-block
"p" #'meow-prev
"P" #'meow-prev-expand
"q" #'meow-quit
"Q" #'meow-goto-line
"r" #'meow-replace
"R" #'meow-swap-grab
"s" #'meow-search
"t" #'meow-right
"T" #'meow-right-expand
"u" #'meow-undo
"U" #'meow-undo-in-selection
"v" #'meow-visit
"w" #'meow-next-word
"W" #'meow-next-symbol
"x" #'meow-save
"X" #'meow-sync-grab
"y" #'meow-yank
"z" #'meow-pop-selection))
;; Qwerty
(defun meow/setup-qwerty ()
(setq meow-cheatsheet-layout meow-cheatsheet-layout-qwerty)
@ -229,93 +119,11 @@
"Y" #'meow-sync-grab
"z" #'meow-pop-selection))
;; Programmer Dvorak
(defun meow/setup-dvp ()
(setq meow-cheatsheet-layout meow-cheatsheet-layout-dvp)
(when (modulep! +override)
(meow-motion-overwrite-define-key)) ; custom keybinding for motion state
(map! :map meow-normal-state-keymap
"?" #'meow-cheatsheet
"*" #'meow-expand-0
"=" #'meow-expand-9
"!" #'meow-expand-8
"[" #'meow-expand-7
"]" #'meow-expand-6
"{" #'meow-expand-5
"+" #'meow-expand-4
"}" #'meow-expand-3
")" #'meow-expand-2
"(" #'meow-expand-1
"1" #'digit-argument
"2" #'digit-argument
"3" #'digit-argument
"4" #'digit-argument
"5" #'digit-argument
"6" #'digit-argument
"7" #'digit-argument
"8" #'digit-argument
"9" #'digit-argument
"0" #'digit-argument
"-" #'negative-argument
";" #'meow-reverse
"," #'meow-inner-of-thing
"." #'meow-bounds-of-thing
"<" #'meow-beginning-of-thing
">" #'meow-end-of-thing
"a" #'meow-append
"A" #'meow-open-below
"b" #'meow-back-word
"B" #'meow-back-symbol
"c" #'meow-change
"d" #'meow-delete
"D" #'meow-backward-delete
"e" #'meow-line
"E" #'meow-goto-line
"f" #'meow-find
"g" #'meow-cancel-selection
"G" #'meow-grab
"h" #'meow-left
"H" #'meow-left-expand
"i" #'meow-insert
"I" #'meow-open-above
"j" #'meow-join
"k" #'meow-kill
"l" #'meow-till
"m" #'meow-mark-word
"M" #'meow-mark-symbol
"n" #'meow-next
"N" #'meow-next-expand
"o" #'meow-block
"O" #'meow-to-block
"p" #'meow-prev
"P" #'meow-prev-expand
"q" #'meow-quit
"r" #'meow-replace
"R" #'meow-swap-grab
"s" #'meow-search
"t" #'meow-right
"T" #'meow-right-expand
"u" #'meow-undo
"U" #'meow-undo-in-selection
"v" #'meow-visit
"w" #'meow-next-word
"W" #'meow-next-symbol
"x" #'meow-save
"X" #'meow-sync-grab
"y" #'meow-yank
"z" #'meow-pop-selection
"'" #'repeat
"<escape>" #'ignore))
(use-package! meow
:hook (doom-after-modules-config . meow-global-mode)
:demand t
:config
(cond
((modulep! +colemak) (meow/setup-colemak))
((modulep! +dvorak) (meow/setup-dvorak))
((modulep! +qwerty) (meow/setup-qwerty))
((modulep! +dvp) (meow/setup-dvp)))
(meow/setup-qwerty)
(cond
((modulep! +leader)
(map! :map meow-normal-state-keymap
@ -328,4 +136,5 @@
(t (meow/setup-keypad)))
(pushnew! meow-mode-state-list '(sly-db-mode . motion))
(pushnew! meow-mode-state-list '(sly-inspector-mode . motion))
(map! :map meow-keymap [remap describe-key] #'helpful-key))
(pushnew! meow-mode-state-list '(Custom-mode . normal))
(map! :map meow-keymap [remap describe-key] #'helpfl-key))