zsh-syntax-highlighting/docs/highlighters/regexp.md
2016-10-14 23:38:21 +03:00

25 lines
1.2 KiB
Markdown

zsh-syntax-highlighting / highlighters / regexp
------------------------------------------------
This is the `regexp` highlighter, that highlights user-defined regular expressions. It's similar to pattern highlighter, but allows more complex patterns.
### How to tweak it
To use this highlighter, associate regular expressions with styles in the
`ZSH_HIGHLIGHT_REGEXP` associative array, for example in `~/.zshrc`:
ZSH_HIGHLIGHT_REGEXP+=('\bsudo\b' fg=123,bold)
This will highlight "sudo" only if it's surrounded by word boundary, i.e. "sudo cmd", but not "sudoedit"
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].
See also: [regular expressions on wikipedia][regexp-wiki], zsh regexp operator `=~` in [zsh manual page][zsh-man-regexp]
[zshzle-Character-Highlighting]: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting
[regexp-wiki]: https://en.wikipedia.org/wiki/Regular_expression
[zsh-man-regexp]: http://zsh.sourceforge.net/Doc/Release/Conditional-Expressions.html#Conditional-Expressions