Daniel Shahaf 1bdb88aee1 Post-branch version number bump.		vor 8 Jahren
docs	'main': Introduce style fallback for the command word.	vor 8 Jahren
highlighters	'main': Followup to fdaeec45146b: Update comment.	vor 8 Jahren
images	Add screenshot.	vor 9 Jahren
tests	dev tools: Automagically handle newlines (\n) in $BUFFER.	vor 8 Jahren
.gitattributes	versionstamp: Set up '.revision-hash' file.	vor 9 Jahren
.gitignore	docs: Create all.md	vor 8 Jahren
.revision-hash	versionstamp: Set up '.revision-hash' file.	vor 9 Jahren
.version	Post-branch version number bump.	vor 8 Jahren
COPYING.md	Bump copyright years.	vor 8 Jahren
HACKING.md	dev docs: Document a useful tab completion setting.	vor 8 Jahren
INSTALL.md	docs: Honour $ZDOTDIR in code examples.	vor 8 Jahren
Makefile	tests: Add a 'print failures only' mode to 'make test', called 'make quiet-test'.	vor 8 Jahren
README.md	noop: Rewrap.	vor 8 Jahren
changelog.md	changelog: Write `arg0` entry.	vor 8 Jahren
release.md	release.md: Record the specific command I used.	vor 8 Jahren
zsh-syntax-highlighting.plugin.zsh	driver: Stop requiring function_argzero.	vor 8 Jahren
zsh-syntax-highlighting.zsh	driver: Warn just once when a highlighter is missing.	vor 8 Jahren

README.md

zsh-syntax-highlighting

Fish shell-like like syntax highlighting for Zsh.

Requirements: zsh 4.3.17+.

This package provides syntax highlighing for the shell zsh. It enables highlighing 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.

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.zsh wraps ZLE widgets. It must be sourced after all custom widgets have been created (i.e., after all zle -N calls and after running compinit). Widgets created later will work, but will not update the syntax highlighting.

Does syntax highlighting work during incremental history search?

Highlighting the command line during an incremental history search (with the history-incremental-search-backward widget, which is bound by default to Ctrl+R in zsh's emacs keymap) requires zsh 5.3 or newer.

Under zsh 5.2 and older, 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 issue #288 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.