public/zsh-syntax-highlighting
1
0
Fork 0
mirror of https://github.com/zsh-users/zsh-syntax-highlighting.git synced 2025-04-17 11:35:32 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
c98632431a
zsh-syntax-highlighting/docs/highlighters/regexp.md
Nuri Jung c98632431a
Change document structure 
This changes document structure and adds comments for the platform-dependency
of regular expressions.

Fixes #746.
2020-07-02 00:49:57 +09:00

1.7 KiB
Raw Blame History

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:

  • GNU-Linux

    typeset -A ZSH_HIGHLIGHT_REGEXP
ZSH_HIGHLIGHT_REGEXP+=('\<sudo\>' fg=123,bold)

  • BSD-based platforms

    typeset -A ZSH_HIGHLIGHT_REGEXP
ZSH_HIGHLIGHT_REGEXP+=('[[:<:]]sudo[[:>:]]' fg=123,bold)

This will highlight "sudo" only as a complete word, i.e., "sudo cmd", but not "sudoedit".

As in the example, some regex patterns are platform-dependent. Refer to the manual page of re_format before applying regular expressions to avoid confusing results. If portability matters, using only POSIX ERE (extended regular expressions) could be an option.

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.

See also: regular expressions tutorial, zsh regexp operator =~ in the zshmisc(1) manual page, GNU