mirror of
https://github.com/zsh-users/zsh-syntax-highlighting.git
synced 2025-03-06 10:35:31 +08:00
f19ff89432
Many users use modular configuration loaders for zshrc. Adding a note to users explaining how to define ZSH_HIGHLIGHT_PATTERNS before sourcing zsh-syntax-highlighting. The typeset is important, since simply setting the variable doesn't have the desired effect.
22 lines
939 B
Markdown
22 lines
939 B
Markdown
zsh-syntax-highlighting / highlighters / pattern
|
|
------------------------------------------------
|
|
|
|
This is the `pattern` highlighter, that highlights user-defined patterns.
|
|
|
|
|
|
### How to tweak it
|
|
|
|
To use this highlighter, associate patterns with styles in the
|
|
`ZSH_HIGHLIGHT_PATTERNS` associative array, for example in `~/.zshrc`:
|
|
|
|
# To have commands starting with `rm -rf` in red:
|
|
ZSH_HIGHLIGHT_PATTERNS+=('rm -rf *' 'fg=white,bold,bg=red')
|
|
|
|
The syntax for values is the same as the syntax of "types of highlighting" of
|
|
the zsh builtin `$zle_highlight` array, which is documented in [the `zshzle(1)`
|
|
manual page][zshzle-Character-Highlighting]. Note: if you would like to define this
|
|
variable before you source zsh-syntax-highlighting, you will need to declare it first with:
|
|
`typeset -gA ZSH_HIGHLIGHT_PATTERNS`.
|
|
|
|
[zshzle-Character-Highlighting]: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting
|