mirror of
https://github.com/zsh-users/zsh-syntax-highlighting
synced 2024-09-21 00:49:05 +02:00
0772ddd346
* Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
zsh-syntax-highlighting / highlighters
|
|
======================================
|
|
|
|
Syntax highlighting is done by pluggable highlighters:
|
|
|
|
* [***main***](main) - the base highlighter, and the only one active by default.
|
|
* [***brackets***](brackets) - matches brackets and parenthesis.
|
|
* [***pattern***](pattern) - matches user-defined patterns.
|
|
|
|
|
|
How to activate highlighters
|
|
----------------------------
|
|
|
|
To activate an highlighter, add it to the `ZSH_HIGHLIGHT_HIGHLIGHTERS` array in `~/.zshrc`, for example:
|
|
|
|
ZSH_HIGHLIGHT_HIGHLIGHTERS=(main brackets pattern)
|
|
|
|
|
|
How to tweak highlighters
|
|
-------------------------
|
|
|
|
Highlighters look up styles from the `ZSH_HIGHLIGHT_STYLES` array. Navigate into each highlighter directory to see what styles it defines and how to configure it.
|
|
|
|
|
|
How to implement a new highlighter
|
|
----------------------------------
|
|
|
|
To create your own ***myhighlighter*** highlighter:
|
|
|
|
* Create your script at **highlighters/*myhighlighter*/*myhighlighter*-highlighter.zsh**.
|
|
* Implement the `_zsh_highlight_myhighlighter_highlighter_predicate` function. This function must return 0 when the highlighter needs to be called, for example:
|
|
|
|
_zsh_highlight_myhighlighter_highlighter_predicate() {
|
|
# Call this highlighter in SVN repositories
|
|
[[ -d .svn ]]
|
|
}
|
|
|
|
* Implement the `_zsh_highlight_myhighlighter_highlighter` function. This function does the actual syntax highlighting, by modifying `region_highlight`, for example:
|
|
|
|
_zsh_highlight_myhighlighter_highlighter() {
|
|
# Colorize the whole buffer with blue background
|
|
region_highlight+=(0 $#BUFFER bg=blue)
|
|
}
|
|
|
|
* Activate your highlighter in `~/.zshrc`:
|
|
|
|
ZSH_HIGHLIGHT_HIGHLIGHTERS+=(myhighlighter)
|