Matthew Martin 683321d862 Merge pull request #529 from wraeth/master main: Probe dirs after blacklist		pirms 6 gadiem
docs	docs: fix typos	pirms 6 gadiem
highlighters	main-highlighter: Probe dirs after blacklist	pirms 6 gadiem
images	README: Add a third image.	pirms 8 gadiem
tests	tests: Directly diff expected_region_highlight against region_highlight	pirms 6 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: install packages required by test suite	pirms 6 gadiem
.version	Post-release version number bump.	pirms 7 gadiem
COPYING.md	'main': Add a regression test for issue #474.	pirms 6 gadiem
HACKING.md	Add regexp highlighter	pirms 6 gadiem
INSTALL.md	docs: Fix links; thanks @dukex for noticing	pirms 6 gadiem
Makefile	#440: Identify the output.	pirms 7 gadiem
README.md	docs: fix typos	pirms 6 gadiem
changelog.md	Tag version 0.6.0-rc1.	pirms 7 gadiem
release.md	release.md: Make a little more copy-pasteable.	pirms 7 gadiem
zsh-syntax-highlighting.plugin.zsh	driver: Stop requiring function_argzero.	pirms 8 gadiem
zsh-syntax-highlighting.zsh	driver: Exclude yank-pop again (#183).	pirms 6 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.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.