Repository files navigation

Fish shell-like syntax highlighting forZsh.

Requirements: zsh 4.3.11+.

This package provides syntax highlighting for the shell zsh. It enableshighlighting of commands whilst they are typed at a zsh prompt into aninteractive terminal. This helps in reviewing commands before runningthem, particularly in catching syntax errors.

Some examples:

Before:
After: 

Before:
After: 

Before:
After: 

Before:
After: 

SeeINSTALL.md.

zsh-syntax-highlighting works by hooking into the Zsh Line Editor (ZLE) andcomputing syntax highlighting for the command-line buffer as it stands at thetime z-sy-h's hook is invoked.

In zsh 5.2 and older,zsh-syntax-highlighting.zsh hooks into ZLE by wrapping ZLE widgets. It mustbe sourced after all custom widgets have been created (i.e., after allzle -Ncalls and after runningcompinit) in order to be able to wrap all of them.Widgets created after z-sy-h is sourced will work, but will not update thesyntax highlighting.

In zsh newer than 5.8 (not including 5.8 itself),zsh-syntax-highlighting uses theadd-zle-hook-widget facility to installazle-line-pre-redraw hook. Hooks are run in order of registration,therefore, z-sy-h must be sourced (and register its hook) after anything elsethat adds hooks that modify the command-line buffer.

Highlighting the command line during an incremental history search (by default bound totoCtrl+R in zsh's emacs keymap) requires zsh 5.4 or newer.

Under zsh versions older than 5.4, the zsh-defaultunderliningof the matched portion of the buffer remains available, but zsh-syntax-highlighting'sadditional highlighting is unavailable. (Those versions of zsh do not provideenough information to allow computing the highlighting correctly.)

See issues#288 and#415 for details.

There is currently no "push" announcements channel. However, the followingalternatives exist:

• GitHub's RSS feed of releases:https://github.com/zsh-users/zsh-syntax-highlighting/releases.atom
• An anitya entry:https://release-monitoring.org/project/7552/

Syntax highlighting is done by pluggable highlighter scripts. See thedocumentation on highlighters for details andconfiguration settings.