mirror of
https://github.com/zsh-users/zsh-syntax-highlighting.git
synced 2025-04-17 11:35:32 +08:00
d7d9f8fddc
In BSD-based platform such as macOS, the metacharacters with leading "\" are not supported. This adds comments for users with those OS, to avoid confusing results. Also changes the wrong associative array name in the example(s).
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
zsh-syntax-highlighting / highlighters / regexp
|
|
------------------------------------------------
|
|
|
|
This is the `regexp` highlighter, that highlights user-defined regular
|
|
expressions. It's similar to the `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
|
|
typeset -A ZSH_HIGHLIGHT_REGEXP
|
|
ZSH_HIGHLIGHT_REGEXP+=('\bsudo\b' fg=123,bold)
|
|
```
|
|
|
|
This will highlight "sudo" only as a complete word, 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 tutorial][perlretut], zsh regexp operator `=~`
|
|
in [the `zshmisc(1)` manual page][zshmisc-Conditional-Expressions]
|
|
|
|
[zshzle-Character-Highlighting]: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting
|
|
[perlretut]: http://perldoc.perl.org/perlretut.html
|
|
[zshmisc-Conditional-Expressions]: http://zsh.sourceforge.net/Doc/Release/Conditional-Expressions.html#Conditional-Expressions
|
|
|
|
### Cautions to BSD-based platform users
|
|
|
|
In BSD-based platform such as macOS, the regex metacharacters with leading backslash (`\`)
|
|
such as `\b`, `\w`, etc. are [not supported](https://stackoverflow.com/a/12696899).
|
|
|
|
So if you want something like the above example, you should use `[[:<:]]`(matches the beginning of a word)
|
|
with `[[:>:]]`(matches the end of a word). The complete example would be like:
|
|
|
|
```zsh
|
|
typeset -A ZSH_HIGHLIGHT_REGEXP
|
|
ZSH_HIGHLIGHT_REGEXP+=('[[:<:]]sudo[[:>:]]' fg=123,bold)
|
|
```
|
|
|
|
For other metacharacters, consider using
|
|
[POSIX ERE](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html#tag_09_04) instead.
|