Matthew Martin e4408343a1 driver: Remove now unneeded localoptions		pirms 4 gadiem
docs	docs: regexp highlighter: Fix a wrong associative array name in the example.	pirms 4 gadiem
highlighters	Autoload highlighters	pirms 4 gadiem
images	Highlight redirections by default, and add that to the examples in README.	pirms 4 gadiem
tests	Merge remote-tracking branch 'origin/master' into feature/redrawhook	pirms 4 gadiem
.editorconfig	editorconfig: Fix Makefile settings	pirms 4 gadiem
.gitattributes	versionstamp: Set up '.revision-hash' file.	pirms 9 gadiem
.gitignore	docs: Create all.md	pirms 8 gadiem
.revision-hash	versionstamp: Set up '.revision-hash' file.	pirms 9 gadiem
.travis.yml	CI += zsh-5.8	pirms 4 gadiem
.version	Post-release version number bump.	pirms 4 gadiem
COPYING.md	Bump copyright years.	pirms 4 gadiem
HACKING.md	Use the new, unreleased zsh 'memo=' feature to remove only our own entries from $region_highlight.	pirms 4 gadiem
INSTALL.md	docs: Add OpenBSD port	pirms 4 gadiem
Makefile	make test: Re-enable syntax highlighting of TAP output in interactive runs	pirms 4 gadiem
README.md	docs: Track making the new codepath conditional upon the 'memo=' feature.	pirms 4 gadiem
_zsh_highlight_internal	driver: Split out autoloadable part of _zsh_highlight	pirms 4 gadiem
changelog.md	changelog: Document #712 under the last tag, 0.8.0-alpha1-pre-redrawhook.	pirms 4 gadiem
driver.zsh	driver: Remove now unneeded localoptions	pirms 4 gadiem
release.md	release.md: Update with the step that was missed in 0.7.0.	pirms 4 gadiem
zsh-syntax-highlighting.plugin.zsh	driver: Stop requiring function_argzero.	pirms 8 gadiem
zsh-syntax-highlighting.zsh	driver: Run under emulate zsh	pirms 4 gadiem

README.md

zsh-syntax-highlighting

Fish shell-like syntax highlighting for Zsh.

Requirements: zsh 4.3.11+.

This package provides syntax highlighting for the shell zsh. It enables highlighting of commands whilst they are typed at a zsh prompt into an interactive terminal. This helps in reviewing commands before running them, particularly in catching syntax errors.

Some examples:

Before:
After:

How to install

See INSTALL.md.

FAQ

Why must `zsh-syntax-highlighting.zsh` be sourced at the end of the `.zshrc` file?

zsh-syntax-highlighting works by hooking into the Zsh Line Editor (ZLE) and computing syntax highlighting for the command-line buffer as it stands at the time 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 must be sourced after all custom widgets have been created (i.e., after all zle -N calls and after running compinit) in order to be able to wrap all of them. Widgets created after z-sy-h is sourced will work, but will not update the syntax highlighting.

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

Does syntax highlighting work during incremental history search?

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

Under zsh versions older than 5.4, the zsh-default underlining of the matched portion of the buffer remains available, but zsh-syntax-highlighting's additional highlighting is unavailable. (Those versions of zsh do not provide enough information to allow computing the highlighting correctly.)

See issues #288 and #415 for details.

How are new releases announced?

There is currently no "push" announcements channel. However, the following alternatives 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/

How to tweak

Syntax highlighting is done by pluggable highlighter scripts. See the documentation on highlighters for details and configuration settings.