doomemacs · hlissner · Jul 25, 2021 · Jan 15, 2021 · Jan 16, 2021 · Jan 16, 2021
diff --git a/core/autoload/help.el b/core/autoload/help.el
@@ -226,6 +226,8 @@ will be automatically appended to the result."
                   #'+ivy-file-search)
                  ((fboundp '+helm-file-search)
                   #'+helm-file-search)
+                 ((fboundp '+vertico-file-search)
+                  #'+vertico-file-search)
                  ((rgrep
                    (read-regexp
                     "Search for" (or initial-input 'grep-tag-default)

diff --git a/core/autoload/projects.el b/core/autoload/projects.el
@@ -128,11 +128,13 @@ If DIR is not a project, it will be indexed (but not cached)."
             (if (doom-module-p :completion 'ivy)
                 #'counsel-projectile-find-file
               #'projectile-find-file)))
-          ((fboundp 'counsel-file-jump) ; ivy only
+          ((and (bound-and-true-p ivy-mode)
+                (fboundp 'counsel-file-jump))
            (call-interactively #'counsel-file-jump))
           ((project-current nil dir)
            (project-find-file-in nil nil dir))
-          ((fboundp 'helm-find-files)
+          ((and (bound-and-true-p helm-mode)
+                (fboundp 'helm-find-files))
            (call-interactively #'helm-find-files))
           ((call-interactively #'find-file)))))
 

diff --git a/docs/modules.org b/docs/modules.org
@@ -46,6 +46,7 @@ completion.
 + helm =+fuzzy +childframe= - *Another* search engine for love and life
 + ido - The /other/ *other* search engine for love and life
 + [[file:../modules/completion/ivy/README.org][ivy]] =+fuzzy +prescient +childframe +icons= - /The/ search engine for love and life
++ [[file:../modules/completion/vertico/README.org][vertico]] =+icons= - The search engine of the future
 
 * :config
 Modules that configure Emacs one way or another, or focus on making it easier

diff --git a/init.example.el b/init.example.el
@@ -24,6 +24,7 @@
        ;;helm              ; the *other* search engine for love and life
        ;;ido               ; the other *other* search engine...
        ivy               ; a search engine for love and life
+       ;;vertico           ; the search engine of the future
 
        :ui
        ;;deft              ; notational velocity for Emacs

diff --git a/modules/app/irc/autoload/irc.el b/modules/app/irc/autoload/irc.el
@@ -68,8 +68,19 @@ workspace for it."
 argument) is non-nil only show channels in current server."
   (interactive "P")
   (call-interactively
-   (cond ((featurep! :completion ivy)  #'+irc/ivy-jump-to-channel)
-         ((user-error "No jump-to-channel backend is enabled. Enable ivy!")))))
+   (cond ((featurep! :completion ivy)       #'+irc/ivy-jump-to-channel)
+         ((featurep! :completion vertico)   #'+irc/vertico-jump-to-channel)
+         ((user-error "No jump-to-channel backend is enabled. Enable vertico or ivy!")))))
+
+;;;###autoload
+(defun +irc--circe-all-buffers ()
+  (cl-loop with servers = (circe-server-buffers)
+           for server in servers
+           collect server
+           nconc
+           (with-current-buffer server
+             (cl-loop for buf in (circe-server-chat-buffers)
+                      collect buf))))
 
 ;;;###autoload
 (defun +irc/tracking-next-buffer ()

diff --git a/modules/app/irc/autoload/vertico.el b/modules/app/irc/autoload/vertico.el
@@ -0,0 +1,23 @@
+;;; app/irc/autoload/vertico.el -*- lexical-binding: t; -*-
+;;;###if (featurep! :completion vertico)
+
+;;;###autoload
+(defun +irc/vertico-jump-to-channel ()
+  "Jump to an open channel or server buffer with vertico."
+  (interactive)
+  (require 'consult)
+  (consult--multi (list (plist-put (copy-sequence +irc--consult-circe-source)
+                                   :hidden nil))
+                  :narrow nil
+                  :require-match t
+                  :prompt "Jump to:"
+                  :sort nil))
+
+;;;###autoload
+(defvar +irc--consult-circe-source
+        `(:name     "circe"
+          :hidden   t
+          :narrow   ?c
+          :category buffer
+          :state    ,#'consult--buffer-state
+          :items    ,(lambda () (mapcar #'buffer-name (+irc--circe-all-buffers)))))
diff --git a/modules/app/irc/config.el b/modules/app/irc/config.el
@@ -141,6 +141,10 @@ playback.")
   ;; Fail gracefully if not in a circe buffer
   (global-set-key [remap tracking-next-buffer] #'+irc/tracking-next-buffer)
 
+  (when (featurep! :completion vertico)
+    (after! consult
+      (add-to-list 'consult-buffer-sources '+irc--consult-circe-source 'append)))
+
   (map! :localleader
         (:map circe-mode-map
           "a" #'tracking-next-buffer

diff --git a/modules/checkers/spell/README.org b/modules/checkers/spell/README.org
@@ -46,7 +46,7 @@ This module has no dedicated maintainers.
   + [[https://github.com/d12frosted/flyspell-correct][flyspell-correct]]
   + [[https://github.com/d12frosted/flyspell-correct#flyspell-correct-ivy-interface][flyspell-correct-ivy]] (=completion/ivy=)
   + [[https://github.com/d12frosted/flyspell-correct#flyspell-correct-helm-interface][flyspell-correct-helm]] (=completion/helm=)
-  + [[https://github.com/d12frosted/flyspell-correct#flyspell-correct-popup-interface][flyspell-correct-popup]] (if *neither* =completion/ivy= or =completion/helm=)
+  + [[https://github.com/d12frosted/flyspell-correct#flyspell-correct-popup-interface][flyspell-correct-popup]] (if *neither* =completion/ivy=, =completion/helm= or =completion/vertico=)
   + [[https://github.com/rolandwalker/flyspell-lazy][flyspell-lazy]]
 + else
   + [[https://gitlab.com/ideasman42/emacs-spell-fu][spell-fu]]

diff --git a/modules/checkers/spell/autoload/+spell-fu.el b/modules/checkers/spell/autoload/+spell-fu.el
@@ -62,7 +62,8 @@
   (save-current-buffer
     (ispell-accept-buffer-local-defs))
   (if (not (or (featurep! :completion ivy)
-               (featurep! :completion helm)))
+               (featurep! :completion helm)
+               (featurep! :completion vertico)))
       (call-interactively #'ispell-word)
     (cl-destructuring-bind (start . end)
         (or (bounds-of-thing-at-point 'word)

diff --git a/modules/checkers/spell/config.el b/modules/checkers/spell/config.el
@@ -234,7 +234,8 @@ e.g. proselint and langtool."
                 (require 'flyspell-correct-helm nil t)))
           ((and (featurep! :completion ivy)
                 (require 'flyspell-correct-ivy nil t)))
-          ((require 'flyspell-correct-popup nil t)
+          ((featurep! :completion vertico)) ; vertico doesn't need any extra configuration
+          ((require 'flyspell-correct-popup nil t) ; only use popup if no compatible completion UI is enabled
            (setq flyspell-popup-correct-delay 0.8)
            (define-key popup-menu-keymap [escape] #'keyboard-quit))))
 

diff --git a/modules/checkers/spell/packages.el b/modules/checkers/spell/packages.el
@@ -3,10 +3,11 @@
 
 (if (not (featurep! +flyspell))
     (package! spell-fu :pin "1abcb5594e1bfe35716d29e64523e4cebdce737c")
-  (package! flyspell-correct :pin "404233604439117301562deadc952fe82cb02120")
+  (package! flyspell-correct :pin "00357953a736e21d0a1c8d76f5605820990544fe")
   (cond ((featurep! :completion ivy)
          (package! flyspell-correct-ivy))
         ((featurep! :completion helm)
          (package! flyspell-correct-helm))
-        ((package! flyspell-correct-popup)))
+        ((not (featurep! :completion vertico))
+         (package! flyspell-correct-popup)))
   (package! flyspell-lazy :pin "0fc5996bcee20b46cbd227ae948d343c3bef7339"))
diff --git a/modules/completion/vertico/README.org b/modules/completion/vertico/README.org
@@ -0,0 +1,221 @@
+#+TITLE:   completion/vertico
+#+DATE:    July 25, 2021
+#+SINCE:   v3.0.0
+#+STARTUP: inlineimages
+
+* Table of Contents :TOC_3:noexport:
+- [[#description][Description]]
+  - [[#maintainers][Maintainers]]
+  - [[#module-flags][Module Flags]]
+  - [[#plugins][Plugins]]
+- [[#prerequisites][Prerequisites]]
+- [[#features][Features]]
+  - [[#vertico-keybindings][Vertico keybindings]]
+  - [[#jump-to-navigation][Jump-to navigation]]
+  - [[#project-search--replace][Project search & replace]]
+  - [[#in-buffer-searching][In-buffer searching]]
+  - [[#vertico-integration-for-various-completing-commands][Vertico integration for various completing commands]]
+    - [[#general][General]]
+    - [[#jump-to-files-buffers-or-projects][Jump to files, buffers or projects]]
+    - [[#search][Search]]
+  - [[#marginalia][Marginalia]]
+  - [[#orderless-filtering][Orderless filtering]]
+- [[#configuration][Configuration]]
+
+* Description
+This module enhances the Emacs search and completion experience, and also
+provides a united interface for project search and replace, powered by [[https://github.com/BurntSushi/ripgrep/][ripgrep]].
+
+It does this with several modular packages focused on enhancing the built-in
+~completing-read~ interface, rather than replacing it with a parallel ecosystem
+like =ivy= and =helm= do. The primary packages are:
+
++ Vertico, which provides the vertical completion user interface
++ Consult, which provides a suite of useful commands using ~completing-read~
++ Embark, which provides a set of minibuffer actions
++ Marginalia, which provides annotations to completion candidates
++ Orderless, which provides better filtering methods
+
+** Maintainers
++ @iyefrat
+
+** Module Flags
++ =+icons= Adds icons to =file= and =buffer= category completion selections.
+
+** Plugins
++ [[https://github.com/minad/vertico][vertico]]
++ [[https://github.com/minad/consult][consult]]
++ [[https://github.com/oantolin/embark/][embark]]
++ [[https://github.com/oantolin/embark/][embark-consult]]
++ [[https://github.com/minad/marginalia][marginalia]]
++ [[https://github.com/oantolin/orderless][orderless]]
++ [[https://github.com/mhayashi1120/Emacs-wgrep][wgrep]]
++ [[https://github.com/minad/consult/][consult-flycheck]] (=:checkers syntax=)
++ [[https://github.com/iyefrat/all-the-icons-completion][all-the-icons-completion]] (=+icons=)
+
+* Prerequisites
+This module has no prerequisites.
+
+* Features
+
+The packages in this module modify and use the built-in ~completing-read~
+function, which is used by any function that requires completion. Due to this
+the full scope of these packages is too large to cover here and you are
+encouraged to go and read their excellent documentation. We will detail
+Doom-specific additions:
+
+** Vertico keybindings
+When in an active Vertico completion session, the following doom added
+keybindings are available:
+
+| Keybind               | Description                                        |
+|-----------------------+----------------------------------------------------|
+| =C-p=                 | Go to previous candidate                           |
+| =C-n=                 | Go to next candidate                               |
+| =C-k=                 | (evil) Go to previous candidate                    |
+| =C-j=                 | (evil) Go to next candidate                        |
+| =C-;= or =<leader> a= | Open an ~embark-act~ menu to chose a useful action |
+| =C-c C-;=             | export the current candidate list to a buffer      |
+| =C-SPC=               | Preview the current candidate                      |
+| =C-M-k=               | (evil) Go to previous candidate and preview.       |
+| =C-M-j=               | (evil) Go to next candidate and preview.           |
+
+~embark-act~ will prompt you with a =which-key= menu with useful commands on the
+selected candidate or candidate list, depending on the completion category. Note
+that you can press =C-h= instead of choosing a command to filter through the
+options with a Vertico buffer, that also has slightly more detailed descriptions
+due to Marginalia annotations.
+
+** Jump-to navigation
+This module provides an interface to navigate within a project using
+=projectile=:
+
+https://assets.doomemacs.org/completion/vertico/projectile.png
+
+| Keybind              | Description                         |
+|----------------------+-------------------------------------|
+| =SPC p f=, =SPC SPC= | Jump to file in project             |
+| =SPC f f=, =SPC .=   | Jump to file from current directory |
+| =SPC s i=            | Jump to symbol in file              |
+
+** Project search & replace
+This module provides interactive text search and replace using ripgrep.
+
+| Keybind   | Description              |
+|-----------+--------------------------|
+| =SPC s p= | Search project           |
+| =SPC s P= | Search another project   |
+| =SPC s d= | Search this directory    |
+| =SPC s D= | Search another directory |
+
+https://assets.doomemacs.org/completion/vertico/search.png
+
+Prefixing these keys with the universal argument (=SPC u= for evil users; =C-u=
+otherwise) changes the behavior of these commands, instructing the underlying
+search engine to include ignored files.
+
+This module also provides Ex Commands for evil users:
+
+| Ex command             | Description                                                      |
+|------------------------+------------------------------------------------------------------|
+| ~:pg[rep][!] [QUERY]~  | Search project (if ~!~, include hidden files)                    |
+| ~:pg[rep]d[!] [QUERY]~ | Search from current directory (if ~!~, don't search recursively) |
+
+The optional `!` is equivalent to the universal argument for the previous
+commands.
+
+-----
+
+On top of the usual Vertico keybindings, search commands also offer support for
+exporting the current candidate list to an editable buffer =C-c C-e=. After
+editing the changes can be committed with =C-c C-c= and aborted with =C-c C-k=
+(alternatively =ZZ= and =ZQ=, for evil users). It uses =wgrep= for grep
+searches, =wdired= for file searches, and =occur= for buffer searches.
+
+https://assets.doomemacs.org/completion/vertico/search-replace.png
+
+** In-buffer searching
+This module provides some in buffer searching bindings:
+
++ =SPC s s= (~isearch~)
++ =SPC s S= (~+vertico/search-symbol-at-point~ via ~consult-line~)
++ =SPC s b= (~consult-line~)
+
+https://assets.doomemacs.org/completion/vertico/buffer-search.png
+
+An ~occur-edit~ buffer can be opened from ~consult-line~ with =C-c C-e=.
+
+** Vertico integration for various completing commands
+*** General
+| Keybind        | Description                 |
+|----------------+-----------------------------|
+| =M-x=, =SPC := | Enhanced M-x                |
+| =SPC '=        | Resume last Vertico session |
+
+*** Jump to files, buffers or projects
+| Keybind              | Description                           |
+|----------------------+---------------------------------------|
+| =SPC RET=            | Find bookmark                         |
+| =SPC f f=, =SPC .=   | Browse from current directory         |
+| =SPC p f=, =SPC SPC= | Find file in project                  |
+| =SPC f r=            | Find recently opened file             |
+| =SPC p p=            | Open another project                  |
+| =SPC b b=, =SPC ,=   | Switch to buffer in current workspace |
+| =SPC b B=, =SPC <=   | Switch to buffer                      |
+
+=SPC b b= and =SPC ,= support changing the workspace you're selecting a buffer from
+via [[https://github.com/minad/consult#narrowing-and-grouping][Consult narrowing]], e.g. if you're on the first workspace, you can switch to
+selecting a buffer from the third workspace by typing =3 SPC= into the prompt,
+or the last workspace by typing =0 SPC=.
+
+=SPC f f= and =SPC .= support exporting to a =wdired= buffer using =C-c C-e=.
+
+*** Search
+| Keybind   | Description                               |
+|-----------+-------------------------------------------|
+| =SPC p t= | List all TODO/FIXMEs in project           |
+| =SPC s b= | Search the current buffer                 |
+| =SPC s d= | Search this directory                     |
+| =SPC s D= | Search another directory                  |
+| =SPC s i= | Search for symbol in current buffer       |
+| =SPC s p= | Search project                            |
+| =SPC s P= | Search another project                    |
+| =SPC s s= | Search the current buffer (incrementally) |
+
+** Marginalia
+| Keybind | Description                     |
+|---------+---------------------------------|
+| =M-A=   | Cycle between annotation levels |
+
+** Orderless filtering
+When using orderless to filter through candidates, the default behaviour is for
+each space separated input to match the candidate as a regular expression or
+literally.
+
+Note that due to this style of matching, pressing tab does not expand the input
+to the longest matching prefix (like shell completion), but rather uses the
+first matched candidate as input. Filtering further is instead achieved by
+pressing space and entering another input. In essence, when trying to match
+=foobar.org=, instead of option 1., use option 2.:
+
+1. (BAD) Enter =foo TAB=, completes to =foobar.=, enter =org RET=
+2. (GOOD) Enter =foo SPC org RET=
+
+Doom has some builtin [[https://github.com/oantolin/orderless#style-dispatchers][style dispatchers]] for more finegrained filtering, which
+you can use to further specify each space separated input in the following ways:
+| Input            | Description                                |
+|------------------+--------------------------------------------|
+| =!foo=           | match without literal input =foo=          |
+| =`bar= or =bar`= | match input =bar= as an initialism         |
+| ==baz= or =baz== | match only with literal input =baz=        |
+| =~qux= or =qux~= | match input =qux= with fuzzy/flex matching |
+
+* Configuration
+If you want to further configure this module, here are some good places to start:
+
++ Vertico provides several [[https://github.com/minad/vertico#extensions][extentions]] that can be used to extend it's interface
++ You can add more Marginalia annotation levels and change the existing ones by
+  editing ~marginalia-annotator-registry~
++ You can change the available commands in Embark for category ~$cat~ by editing
+  ~embark-$cat-map~, and even add new categories. Note that you add categories
+  by defining them [[https://github.com/minad/marginalia/#adding-custom-annotators-or-classifiers][through marginalia]], and embark picks up on them.
diff --git a/modules/completion/vertico/autoload/evil.el b/modules/completion/vertico/autoload/evil.el
@@ -0,0 +1,14 @@
+;; completion/vertico/autoload/evil.el -*- lexical-binding: t; -*-
+;;;###if (featurep! :editor evil)
+
+;;;###autoload (autoload '+vertico:project-search "completion/vertico/autoload/evil" nil t)
+(evil-define-command +vertico:project-search (query &optional all-files-p)
+  "Ex interface for `+vertico/project-search'."
+  (interactive "<a><!>")
+  (+vertico/project-search all-files-p query))
+
+;;;###autoload (autoload '+vertico:project-search-from-cwd "completion/vertico/autoload/evil" nil t)
+(evil-define-command +vertico:project-search-from-cwd (query &optional recurse-p)
+  "Ex interface for `+vertico/project-search-from-cwd'."
+  (interactive "<a><!>")
+  (+vertico/project-search-from-cwd (not recurse-p) query))