merge: rewrite-docs
I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.
This commit is contained in:
Henrik Lissner
commit
1f8bf7accb
179 changed files with 13125 additions and 8630 deletions
|
|
@ -1,169 +1,183 @@
|
|||
#+TITLE: completion/helm
|
||||
#+DATE: January 22, 2021
|
||||
#+SINCE: v2.0
|
||||
#+STARTUP: inlineimages
|
||||
# -*- mode: doom-docs-org -*-
|
||||
#+title: :completion helm
|
||||
#+subtitle: A tank for hunting a house fly
|
||||
#+created: February 20, 2017
|
||||
#+since: 2.0.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#features][Features]]
|
||||
- [[#jump-to-navigation][Jump-to navigation]]
|
||||
- [[#project-search--replace][Project search & replace]]
|
||||
- [[#search][Search]]
|
||||
- [[#replace][Replace]]
|
||||
- [[#in-buffer-searching][In-buffer searching]]
|
||||
- [[#helm-integration-for-various-completing-commands][Helm integration for various completing commands]]
|
||||
- [[#general][General]]
|
||||
- [[#jump-to-files-buffers-or-projects][Jump to files, buffers or projects]]
|
||||
- [[#search-1][Search]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#icons][Icons]]
|
||||
- [[#posframe][Posframe]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
* Description :unfold:
|
||||
This module provides Helm integration for a variety of Emacs commands, as well
|
||||
as a unified interface for project search and replace, powered by [[https://github.com/BurntSushi/ripgrep][Ripgrep]].
|
||||
|
||||
* Description
|
||||
This module provides Helm integration for a variety of Emacs commands, as well as
|
||||
a unified interface for project search and replace, powered by ripgrep.
|
||||
** Maintainers
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module flags
|
||||
- +childframe ::
|
||||
Display Helm windows in a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Child-Frames.html][child frame]] rather than an popup buffer. *Requires
|
||||
GUI Emacs.*
|
||||
- +fuzzy ::
|
||||
Enable fuzzy completion for Helm searches.
|
||||
- +icons ::
|
||||
Display icons on completion results (where possible) using either
|
||||
[[doom-package:][all-the-icons]] or [[doom-package:][treemacs]] iconsets.
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][helm]]
|
||||
- [[doom-package:][helm-company]]
|
||||
- [[doom-package:][helm-c-yasnippet]]
|
||||
- [[doom-package:][helm-descbinds]]
|
||||
- [[doom-package:][helm-describe-modes]]
|
||||
- [[doom-package:][helm-flx]]* if [[doom-module:][+fuzzy]]
|
||||
- [[doom-package:][helm-icons]]* if [[doom-module:][+icons]]
|
||||
- [[doom-package:][helm-org]]* if [[doom-module:][:lang org]]
|
||||
- [[doom-package:][helm-posframe]]* if [[doom-module:][+childframe]]
|
||||
- [[doom-package:][helm-projectile]]
|
||||
- [[doom-package:][helm-rg]]
|
||||
- [[doom-package:][helm-swiper]]
|
||||
|
||||
** TODO Hacks
|
||||
#+begin_quote
|
||||
I prefer ivy over ido for its flexibility. I prefer ivy over helm because it's
|
||||
lighter, simpler and faster in many cases.
|
||||
🔨 This module's hacks haven't been documented yet. [[doom-contrib-module:][Document them?]]
|
||||
#+end_quote
|
||||
|
||||
Ivy is considered a first-class citizen in Doom, however it is still possible to use Helm if you so desire.
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
** Module Flags
|
||||
+ =+fuzzy= Enables fuzzy completion for Helm searches.
|
||||
+ =+childframe= Causes Helm to display in a floating child frame, above Emacs.
|
||||
+ =+icons= Enables icons (supports both =all-the-icons= and =treemacs= icons)
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/emacs-helm/helm][helm]]
|
||||
+ [[https://github.com/microamp/helm-rg][helm-rg]]
|
||||
+ [[https://github.com/emacs-jp/helm-c-yasnippet][helm-c-yasnippet]]
|
||||
+ [[https://github.com/tuhdo/helm-company][helm-company]]
|
||||
+ [[https://github.com/emacs-helm/helm-describe-modes][helm-describe-modes]]
|
||||
+ [[https://github.com/bbatsov/helm-projectile][helm-projectile]]
|
||||
+ [[https://github.com/abo-abo/swiper-helm][helm-swiper]]
|
||||
+ [[https://github.com/emacs-helm/helm-descbinds][helm-descbinds]]
|
||||
+ [[https://github.com/PythonNut/helm-flx][helm-flx]]* (=+fuzzy=)
|
||||
+ [[https://github.com/tumashu/helm-posframe][helm-posframe]]* (=+childframe=)
|
||||
+ [[https://github.com/emacs-helm/helm-org][helm-org]]* (=:lang org=)
|
||||
+ [[https://github.com/yyoncho/helm-icons][helm-icons]]* (=+icons=)
|
||||
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.
|
||||
|
||||
* Prerequisites
|
||||
This module has no prerequisites.
|
||||
Otherwise, 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 plugin.
|
||||
|
||||
* Features
|
||||
Much like Ivy, Helm is a /large/ framework and as such
|
||||
covering everything is not in scope, however a number
|
||||
of Doom-specific features are shown below:
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
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
|
||||
Similar to Ivy, this module provides an interface to
|
||||
navigate within a project using =projectile=:
|
||||
|
||||
Similar to Ivy, this module provides an interface to navigate within a project
|
||||
using [[doom-package:][projectile]]:
|
||||
| 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 |
|
||||
| [[kbd:][SPC p f]], [[kbd:][SPC SPC]] | Jump to file in project |
|
||||
| [[kbd:][SPC f f]], [[kbd:][SPC .]] | Jump to file from current directory |
|
||||
| [[kbd:][SPC s i]] | Jump to symbol in file |
|
||||
|
||||
** Project search & replace
|
||||
This module also provides interacetive text search and replace using ripgrep
|
||||
This module also provides interactive text search and replace using ripgrep.
|
||||
|
||||
*** Search
|
||||
|
||||
| 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 |
|
||||
Prefixing these keys with the universal argument (=SPC u= for evil users; =C-u=
|
||||
| [[kbd:][SPC s p]] | Search project |
|
||||
| [[kbd:][SPC s P]] | Search another project |
|
||||
| [[kbd:][SPC s d]] | Search this directory |
|
||||
| [[kbd:][SPC s D]] | Search another directory |
|
||||
|
||||
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
|
||||
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
|
||||
The optional ~!~ is equivalent to the universal argument for the previous
|
||||
commands.
|
||||
|
||||
*** Replace
|
||||
|
||||
These keybindings are available while a search is active:
|
||||
| Keybind | Description |
|
||||
|---------+-----------------------------------------------|
|
||||
| [[kbd:][C-c C-o]] | Open a buffer with your search results |
|
||||
| [[kbd:][C-c C-e]] | Open a writable buffer of your search results |
|
||||
| [[kbd:][C-SPC]] | Preview the current candidate |
|
||||
| [[kbd:][C-RET]] | Open the selected candidate in other-window |
|
||||
|
||||
| Keybind | Description |
|
||||
|-----------+-----------------------------------------------|
|
||||
| =C-c C-o= | Open a buffer with your search results |
|
||||
| =C-c C-e= | Open a writable buffer of your search results |
|
||||
| =C-SPC= | Preview the current candidate |
|
||||
| =C-RET= | Open the selected candidate in other-window |
|
||||
|
||||
Changes to the resulting wgrep buffer (opened by =C-c C-e=) can be committed
|
||||
with =C-c C-c= and aborted with =C-c C-k= (alternatively =ZZ= and =ZQ=, for evil
|
||||
users).
|
||||
Changes to the resulting wgrep buffer (opened by [[kbd:][C-c C-e]]) can be 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
|
||||
The =swiper= package provides an interactive buffer search powered by helm. It
|
||||
can be invoked with:
|
||||
The [[doom-package:][swiper]] package provides an interactive buffer search powered by helm. It can
|
||||
be invoked with:
|
||||
- [[kbd:][SPC s s]] (~swiper-isearch~)
|
||||
- [[kbd:][SPC s S]] (~swiper-isearch-thing-at-point~)
|
||||
- [[kbd:][SPC s b]] (~swiper~)
|
||||
- ~:sw[iper] [QUERY]~
|
||||
|
||||
+ =SPC s s= (~swiper-isearch~)
|
||||
+ =SPC s S= (~swiper-isearch-thing-at-point~)
|
||||
+ =SPC s b= (~swiper~)
|
||||
+ ~:sw[iper] [QUERY]~
|
||||
A wgrep buffer can be opened from swiper with [[kbd:][C-c C-e]].
|
||||
|
||||
A wgrep buffer can be opened from swiper with =C-c C-e=.
|
||||
** Helm integration for various completing commands
|
||||
Helm also has a number of overrides for built-in functionality:
|
||||
|
||||
*** General
|
||||
| Keybind | Description |
|
||||
|------------+---------------------------|
|
||||
| =M-x=, =SPC := | Smarter, smex-powered M-x |
|
||||
| =SPC '= | Resume last ivy session |
|
||||
| [[kbd:][M-x]], [[kbd:][SPC :]] | Smarter, smex-powered M-x |
|
||||
| [[kbd:][SPC ']] | Resume last ivy 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 |
|
||||
| [[kbd:][SPC RET]] | Find bookmark |
|
||||
| [[kbd:][SPC f f]], [[kbd:][SPC .]] | Browse from current directory |
|
||||
| [[kbd:][SPC p f]], [[kbd:][SPC SPC]] | Find file in project |
|
||||
| [[kbd:][SPC f r]] | Find recently opened file |
|
||||
| [[kbd:][SPC p p]] | Open another project |
|
||||
| [[kbd:][SPC b b]], [[kbd:][SPC ,]] | Switch to buffer in current workspace |
|
||||
| [[kbd:][SPC b B]], [[kbd:][SPC <]] | Switch to buffer |
|
||||
|
||||
*** 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) |
|
||||
| [[kbd:][SPC p t]] | List all TODO/FIXMEs in project |
|
||||
| [[kbd:][SPC s b]] | Search the current buffer |
|
||||
| [[kbd:][SPC s d]] | Search this directory |
|
||||
| [[kbd:][SPC s D]] | Search another directory |
|
||||
| [[kbd:][SPC s i]] | Search for symbol in current buffer |
|
||||
| [[kbd:][SPC s p]] | Search project |
|
||||
| [[kbd:][SPC s P]] | Search another project |
|
||||
| [[kbd:][SPC s s]] | Search the current buffer (incrementally) |
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
* Configuration
|
||||
** Icons
|
||||
Icons are now included, and support 2 providers ([[https://github.com/domtronn/all-the-icons.el][all-the-icons]] and [[https://github.com/Alexander-Miller/treemacs][treemacs]]).
|
||||
By default, to maintain consistency we use =all-the-icons=; however if you wish
|
||||
to modify this you can do so using the below snippet:
|
||||
Icon support is now included, through one of two providers: [[doom-package:][all-the-icons]] and
|
||||
[[doom-package:][treemacs]]. By default, to maintain consistency we use [[doom-package:][all-the-icons]]; however if
|
||||
you wish to modify this you can do so using the below snippet:
|
||||
|
||||
#+begin_src emacs-lisp
|
||||
(after! helm
|
||||
(setq helm-icons-provider 'treemacs))
|
||||
#+end_src
|
||||
|
||||
** Posframe
|
||||
** TODO Posframe
|
||||
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
* Frequently asked questions
|
||||
[[doom-suggest-faq:][Ask a question?]]
|
||||
|
||||
** Helm vs Ivy vs Ido vs Vertico
|
||||
See [[id:4f36ae11-1da8-4624-9c30-46b764e849fc][this answer]].
|
||||
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||
#+end_quote
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue