diff options
| author | Daniel Mendler <mail@daniel-mendler.de> | 2022-04-06 08:32:19 +0200 |
|---|---|---|
| committer | Daniel Mendler <mail@daniel-mendler.de> | 2022-04-06 08:32:19 +0200 |
| commit | 7c30d180b8d38f93025e4f95ffc981c0e91418ee (patch) | |
| tree | 56e3912950017972a82f10f175f37c2bd7d2f1a8 /README.org | |
| parent | e94d303cd1456ba5d5115f22c7d3940397301972 (diff) | |
README updates
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 49 |
1 files changed, 28 insertions, 21 deletions
@@ -68,13 +68,6 @@ example in an Elisp buffer or in an Eshell or Shell buffer. For auto completion, set ~corfu-auto=t~ before turning on ~corfu-global-mode~. - If you start to configure the package more deeply, I recommend to give the - Orderless completion style a try for filtering. Orderless completion is - different from the familiar prefix TAB completion. Corfu can be used with the - default completion styles. The use of Orderless is not a necessity. See also - the [[https://github.com/minad/corfu/wiki][Corfu Wiki]] for additional configuration tips. In particular the Lsp-mode - configuration is documented in the Wiki. - Here is an example configuration: #+begin_src emacs-lisp @@ -102,19 +95,6 @@ :init (corfu-global-mode)) - ;; Optionally use the `orderless' completion style. See `+orderless-dispatch' - ;; in the Consult wiki for an advanced Orderless style dispatcher. - ;; Enable `partial-completion' for files to allow path expansion. - ;; You may prefer to use `initials' instead of `partial-completion'. - (use-package orderless - :init - ;; Configure a custom style dispatcher (see the Consult wiki) - ;; (setq orderless-style-dispatchers '(+orderless-dispatch) - ;; orderless-component-separator #'orderless-escapable-split-on-space) - (setq completion-styles '(orderless basic) - completion-category-defaults nil - completion-category-overrides '((file (styles . (partial-completion)))))) - ;; Use dabbrev with Corfu! (use-package dabbrev ;; Swap M-/ and C-M-/ @@ -137,7 +117,34 @@ (setq tab-always-indent 'complete)) #+end_src - See also the [[https://github.com/minad/corfu/wiki][Corfu Wiki]] for additional configuration tips. For more general + If you start to configure the package more deeply, I recommend to give the + Orderless completion style a try for filtering. Orderless completion is + different from the familiar prefix TAB completion. Corfu can be used with the + default completion styles. The use of Orderless is not a necessity. + +#+begin_src emacs-lisp + ;; Optionally use the `orderless' completion style. + (use-package orderless + :init + ;; Configure a custom style dispatcher (see the Consult wiki) + ;; (setq orderless-style-dispatchers '(+orderless-dispatch) + ;; orderless-component-separator #'orderless-escapable-split-on-space) + (setq completion-styles '(orderless basic) + completion-category-defaults nil + completion-category-overrides '((file (styles . (partial-completion)))))) +#+end_src + + The =basic= completion style is specified as fallback in addition to =orderless= + in order to ensure that completion commands which rely on dynamic completion + tables, e.g., ~completion-table-dynamic~ or ~completion-table-in-turn~, work + correctly. See =+orderless-dispatch= in the [[https://github.com/minad/consult/wiki][Consult wiki]] for an advanced + Orderless style dispatcher. Additionally enable =partial-completion= for file + path expansion. =partial-completion= is important for file wildcard support. + Multiple files can be opened at once with =find-file= if you enter a wildcard. + You may also give the =initials= completion style a try. + + See also the [[https://github.com/minad/corfu/wiki][Corfu Wiki]] for additional configuration tips. In particular the + Lsp-mode configuration is documented in the wiki. For more general documentation read the chapter about completion in the [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Completion.html][Emacs manual]]. If you want to create your own Capfs, you can find documentation about completion in the [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Completion.html][Elisp manual]]. |
