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

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.