emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(helm): revise and expand

Browse source 
- Added links to external documentation.
- Added commands for key bindings (especially useful for non-Evil users).
- Documented configuration for helm-mode and treemacs icons.

Close: #6676
Co-authored-by: johanwiden <johanwiden@users.noreply.github.com>
This commit is contained in:
Henrik Lissner 2023-02-23 22:43:06 -05:00
parent 4158e5124a
commit b4034a590b
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
1 changed files with 81 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

138
modules/completion/helm/README.org
View file

@ -1,11 +1,15 @@
#+title: :completion helm #+title: :completion helm
#+subtitle: A tank for hunting a house fly #+subtitle: A bazooka for hunting house flies
#+created: February 20, 2017 #+created: February 20, 2017
#+since: 2.0.0 #+since: 2.0.0
* Description :unfold: * Description :unfold:
This module provides Helm integration for a variety of Emacs commands, as well This module provides Helm integration to a variety of Emacs commands, as well as
as a unified interface for project search and replace, powered by [[https://github.com/BurntSushi/ripgrep][Ripgrep]]. a unified interface for project search and replace, powered by [[https://github.com/BurntSushi/ripgrep][Ripgrep]].
For official documentation about Helm, see:
- [[https://rnchzn.github.io/helm/doc/helm-manual.html]]
- [[https://tuhdo.github.io/helm-intro.html]]
** Maintainers ** Maintainers
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]] /This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
@ -49,39 +53,43 @@ as a unified interface for project search and replace, powered by [[https://gith
This module has only one requirement: [[https://github.com/BurntSushi/ripgrep][Ripgrep]], which is a hard dependency of This module has only one requirement: [[https://github.com/BurntSushi/ripgrep][Ripgrep]], which is a hard dependency of
Doom itself, so you should already have it installed. Doom itself, so you should already have it installed.
Otherwise, Helm provides many commands to interface with a variety of programs By enabling this module, it will enable helm-mode and remap many commands to
from [[https://github.com/junegunn/fzf][fzf]] to [[https://kapeli.com/dash][Dash docsets]] to [[https://www.passwordstore.org/][pass]] and /much/ more. These programs are optional their helm equivalents, such as:
for this module, but must be installed if you intend to use their associated
Helm command or plugin. - [[cmd:][find-file]] ([[kbd:][C-c C-f]] or [[kbd:][<leader> f f]]) -> [[cmd:][helm-find-files]]
- [[cmd:][execute-extended-command]] ([[kbd:][M-x]]) -> [[cmd:][helm-M-x]]
- [[cmd:][switch-to-buffer]] ([[kbd:][C-x b]] or [[kbd:][<leader> b b]]) -> [[cmd:][helm-buffers-list]]
- ...among others
No setup is required on your part. Helm provides many commands to interface with
a variety of programs from [[https://github.com/junegunn/fzf][fzf]] to [[https://kapeli.com/dash][Dash docsets]] to [[https://www.passwordstore.org/][pass]] and /much/ more. These
programs are optional for this module, but must be installed if you intend to
use their associated Helm command or package.
* TODO Usage * TODO Usage
#+begin_quote Much like [[doom-package:ivy]] and [[doom-package:vertico]], [[doom-package:helm]] is a /large/ framework. Covering
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]] all its features is not within the scope of this module's documentation, so only
#+end_quote its highlights will be covered here.
Much like [[doom-package:ivy]] and [[doom-package:vertico]], [[doom-package:helm]] is a /large/ framework. Covering all its
features is not within the scope of this module's documentation, so only its
highlights will be covered here.
** Jump-to navigation ** Jump-to navigation
Similar to Ivy, this module provides an interface to navigate within a project Similar to Ivy, this module provides an interface to navigate within a project
using [[doom-package:projectile]]: using [[doom-package:projectile]]:
| Keybind | Description | | Keybind | Description |
|------------------+-------------------------------------| |------------------+---------------------------------------------------------|
| [[kbd:][SPC p f]], [[kbd:][SPC SPC]] | Jump to file in project | | [[kbd:][SPC p f]], [[kbd:][SPC SPC]] | Jump to file in project (~+helm/projectile-find-file~) |
| [[kbd:][SPC f f]], [[kbd:][SPC .]] | Jump to file from current directory | | [[kbd:][SPC f f]], [[kbd:][SPC .]] | Jump to file from current directory (~helm-find-files~) |
| [[kbd:][SPC s i]] | Jump to symbol in file | | [[kbd:][SPC s i]] | Jump to symbol in file (~helm-semantic-or-imenu~) |
** Project search & replace ** Project search & replace
This module also provides interactive text search and replace using ripgrep. This module also provides interactive text search and replace using [[https://github.com/BurntSushi/ripgrep][Ripgrep]].
*** Search *** Search
| Keybind | Description | | Keybind | Description |
|---------+--------------------------| |---------+-----------------------------------------------------------|
| [[kbd:][SPC s p]] | Search project | | [[kbd:][SPC s p]] | Search project (~+default/search-project~) |
| [[kbd:][SPC s P]] | Search another project | | [[kbd:][SPC s P]] | Search another project (~+default/search-other-project~) |
| [[kbd:][SPC s d]] | Search this directory | | [[kbd:][SPC s d]] | Search this directory (~+default/search-cwd~) |
| [[kbd:][SPC s D]] | Search another directory | | [[kbd:][SPC s D]] | Search another directory (~+default/search-other-cwd~) |
Prefixing these keys with the universal argument ([[kbd:][SPC u]] for evil users; [[kbd:][C-u]] Prefixing these keys with the universal argument ([[kbd:][SPC u]] for evil users; [[kbd:][C-u]]
otherwise) changes the behavior of these commands, instructing the underlying otherwise) changes the behavior of these commands, instructing the underlying
@ -105,18 +113,19 @@ These keybindings are available while a search is active:
| [[kbd:][C-SPC]] | Preview the current candidate | | [[kbd:][C-SPC]] | Preview the current candidate |
| [[kbd:][C-RET]] | Open the selected candidate in other-window | | [[kbd:][C-RET]] | Open the selected candidate in other-window |
Changes to the resulting wgrep buffer (opened by [[kbd:][C-c C-e]]) can be committed with Changes to the resulting [[doom-package:wgrep]] buffer (opened by [[kbd:][C-c C-e]]) can be
[[kbd:][C-c C-c]] and aborted with [[kbd:][C-c C-k]] (alternatively [[kbd:][ZZ]] and [[kbd:][ZQ]], for evil users). committed with [[kbd:][C-c C-c]] and aborted with [[kbd:][C-c C-k]] (alternatively [[kbd:][ZZ]] and [[kbd:][ZQ]], for
evil users).
** In-buffer searching ** In-buffer searching
The [[doom-package:swiper]] package provides an interactive buffer search powered by helm. It can The [[doom-package:swiper]] package provides an interactive buffer search powered by helm. It can
be invoked with: be invoked with:
- [[kbd:][SPC s s]] (~swiper-isearch~) - [[kbd:][SPC s s]] ([[cmd:][swiper-isearch]])
- [[kbd:][SPC s S]] (~swiper-isearch-thing-at-point~) - [[kbd:][SPC s S]] ([[cmd:][swiper-isearch-thing-at-point]])
- [[kbd:][SPC s b]] (~swiper~) - [[kbd:][SPC s b]] ([[cmd:][swiper]])
- ~:sw[iper] [QUERY]~ - ~:sw[iper] [QUERY]~
A wgrep buffer can be opened from swiper with [[kbd:][C-c C-e]]. A [[doom-package:wgrep]] buffer can be opened from swiper with [[kbd:][C-c C-e]].
** Helm integration for various completing commands ** Helm integration for various completing commands
Helm also has a number of overrides for built-in functionality: Helm also has a number of overrides for built-in functionality:
@ -128,45 +137,60 @@ Helm also has a number of overrides for built-in functionality:
| [[kbd:][SPC ']] | Resume last ivy session | | [[kbd:][SPC ']] | Resume last ivy session |
*** Jump to files, buffers or projects *** Jump to files, buffers or projects
| Keybind | Description | | Keybind | Description |
|------------------+---------------------------------------| |---------+----------------------------------------------------------------------|
| [[kbd:][SPC RET]] | Find bookmark | | [[kbd:][SPC p t]] | List all TODO/FIXMEs in project |
| [[kbd:][SPC f f]], [[kbd:][SPC .]] | Browse from current directory | | [[kbd:][SPC s b]] | Search the current buffer (~+default/search-buffer~) |
| [[kbd:][SPC p f]], [[kbd:][SPC SPC]] | Find file in project | | [[kbd:][SPC s d]] | Search this directory (~+default/search-cwd~) |
| [[kbd:][SPC f r]] | Find recently opened file | | [[kbd:][SPC s D]] | Search another directory (~+default/search-other-cwd~) |
| [[kbd:][SPC p p]] | Open another project | | [[kbd:][SPC s i]] | Search for symbol in current buffer |
| [[kbd:][SPC b b]], [[kbd:][SPC ,]] | Switch to buffer in current workspace | | [[kbd:][SPC s p]] | Search project (~+default/search-project~) |
| [[kbd:][SPC b B]], [[kbd:][SPC <]] | Switch to buffer | | [[kbd:][SPC s P]] | Search another project (~+default/search-other-project~) |
| [[kbd:][SPC s s]] | Search the current buffer (incrementally) (~+default/search-buffer~) |
*** Search *** Search
| Keybind | Description | | Keybind | Description |
|---------+-------------------------------------------| |---------+----------------------------------------------------------------------|
| [[kbd:][SPC p t]] | List all TODO/FIXMEs in project | | [[kbd:][SPC p t]] | List all TODO/FIXMEs in project |
| [[kbd:][SPC s b]] | Search the current buffer | | [[kbd:][SPC s b]] | Search the current buffer (~+default/search-buffer~) |
| [[kbd:][SPC s d]] | Search this directory | | [[kbd:][SPC s d]] | Search this directory (~+default/search-cwd~) |
| [[kbd:][SPC s D]] | Search another directory | | [[kbd:][SPC s D]] | Search another directory (~+default/search-other-cwd~) |
| [[kbd:][SPC s i]] | Search for symbol in current buffer | | [[kbd:][SPC s i]] | Search for symbol in current buffer |
| [[kbd:][SPC s p]] | Search project | | [[kbd:][SPC s p]] | Search project (~+default/search-project~) |
| [[kbd:][SPC s P]] | Search another project | | [[kbd:][SPC s P]] | Search another project (~+default/search-other-project~) |
| [[kbd:][SPC s s]] | Search the current buffer (incrementally) | | [[kbd:][SPC s s]] | Search the current buffer (incrementally) (~+default/search-buffer~) |
* TODO Configuration * TODO Configuration
#+begin_quote #+begin_quote
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]] 🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote #+end_quote
** Icons ** helm-mode
Icon support is now included, through one of two providers: [[doom-package:all-the-icons]] and This module enables helm-mode by default, which will force any functions that
[[doom-package:treemacs]]. By default, to maintain consistency we use [[doom-package:all-the-icons]]; however if call ~completing-read~, ~read-file-name~, ~completion-in-region~ and friends to
you wish to modify this you can do so using the below snippet: use Helm's completion interface instead. Any function listed in the
[[var:][helm-completing-read-handlers-alist]] variable will be exempt from this.
For example, an emacs command ~foo~ in package ~bar~ that uses a completion
framework other than helm, say company, may break if handed off to Helm, so it
makes sense to exempt ~foo~ with the following:
#+begin_src emacs-lisp #+begin_src emacs-lisp
;; add to $DOOMDIR/config.el
(after! helm
(add-to-list 'helm-completing-read-handlers-alist (cons #'foo nil)))
#+end_src
** Icons
There are two icon "themes" available for this module:
[[doom-package:all-the-icons]] and [[doom-package:treemacs]]. By default, and to
maintain consistency with other icons across Doom's modules,
[[doom-package:all-the-icons]] is used. To change this:
#+begin_src emacs-lisp
;; add to $DOOMDIR/config.el
(after! helm (after! helm
(setq helm-icons-provider 'treemacs)) (setq helm-icons-provider 'treemacs))
#+end_src #+end_src
** TODO Posframe
* Troubleshooting * Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]] /There are no known problems with this module./ [[doom-report:][Report one?]]