dcarrillo
/
prezto
mirror of https://github.com/dcarrillo/prezto.git
1
0
Fork 0
Code Issues Releases Wiki Activity
prezto/modules/autosuggestions/README.md

63 lines
1.9 KiB
Markdown
Raw Normal View History

general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
# Autosuggestions
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
Integrates [zsh-autosuggestions][1] into Prezto, which implements the
[Fish shell][2]'s autosuggestions feature, where the user can type in any part
of a previously entered command and Zsh suggests commands as you type based on
history and completions.
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
If this module is used in conjunction with the [_`syntax-highlighting`_][3]
module, this module must be loaded _after_ the _`syntax-highlighting`_ module.
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
Additionally, if this module is used in conjunction with the
[_`history-substring-search`_][4] module, this module must be loaded _after_ the
_`history-substring-search`_ module as well.
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To elaborate, the relative order of loading the modules would be
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
_`syntax-highlighting`_, _`history-substring-search`_ and _`autosuggestions`_.
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Contributors
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
New features and bug fixes should be submitted to the [zsh-autosuggestions][1]
project according to its rules and regulations. This module will be synchronized
against it.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Settings
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
### Highlighting
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
If colors are enabled, _autosuggestions_ will automatically highlight
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
positive results.
To enable highlighting for this module only, add the following line to
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:autosuggestions' color 'yes'
```
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To set the query found color, add the following line to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:autosuggestions:color' found ''
```
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Troubleshooting
autosuggestions: add basic history troubleshooting information
2018-02-17 16:06:34 +00:00
### Autosuggestions from previous sessions don't show up
For autosuggestions from previous shell sessions to work, please make sure you
also have the `history` module enabled.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Authors
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
_The authors of this module should be contacted via the [issue tracker][5]._
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[Fix #532] Integrate autosuggestions
2016-03-02 21:31:30 +00:00
[1]: https://github.com/tarruda/zsh-autosuggestions
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
[2]: https://fishshell.com
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
[3]: ../syntax-highlighting#readme
[4]: ../history-substring-search#readme
[5]: https://github.com/sorin-ionescu/prezto/issues