Matthew Martin 7b417be1ce tests: Escape newlines in TAP description		6 vuotta sitten
docs	docs: main: Clarify back-quoted-argument, back-double-quoted-argument, back-dollar-quoted-argument, and assign.	6 vuotta sitten
highlighters	regexp: Add missing local for arrays match mbegin mend	6 vuotta sitten
images	README: Add a third image.	8 vuotta sitten
tests	tests: Escape newlines in TAP description	6 vuotta sitten
.gitattributes	versionstamp: Set up '.revision-hash' file.	9 vuotta sitten
.gitignore	docs: Create all.md	8 vuotta sitten
.revision-hash	versionstamp: Set up '.revision-hash' file.	9 vuotta sitten
.travis.yml	CI: customize IRC notifcation message	7 vuotta sitten
.version	Post-release version number bump.	7 vuotta sitten
COPYING.md	'main': Add a regression test for issue #474.	6 vuotta sitten
HACKING.md	Add regexp highlighter	6 vuotta sitten
INSTALL.md	docs: Fix links; thanks @dukex for noticing	6 vuotta sitten
Makefile	#440: Identify the output.	7 vuotta sitten
README.md	Typo	6 vuotta sitten
changelog.md	Tag version 0.6.0-rc1.	7 vuotta sitten
release.md	release.md: Make a little more copy-pasteable.	7 vuotta sitten
zsh-syntax-highlighting.plugin.zsh	driver: Stop requiring function_argzero.	8 vuotta sitten
zsh-syntax-highlighting.zsh	driver: Run under emulate -L zsh and add zsyh_user_options	6 vuotta sitten

README.md

zsh-syntax-highlighting

Fish shell-like syntax highlighting for Zsh.

Requirements: zsh 4.3.11+.

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.

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.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 (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.