mirror of https://github.com/zsh-users/zsh-syntax-highlighting synced 2024-12-15 16:04:38 +00:00

Fish shell like syntax highlighting for Zsh.

Go to file

m0viefreak 28e661bbc8 README: Fix FAQ entry about isearch highlighting Fixes #423		2017-07-30 19:08:18 +02:00
docs	'main': Introduce style fallback for the command word.	2016-09-28 13:25:05 +00:00
highlighters	'main': Highlight mismatched 'if'/'fi'.	2017-03-05 17:33:36 +00:00
images	README: Add a third image.	2016-10-20 01:02:27 +00:00
tests	tests: Add a regression test for issue #392 (aliases beginning with a '+' are lost).	2016-12-03 13:54:47 +00:00
.gitattributes	versionstamp: Set up '.revision-hash' file.	2015-10-19 07:21:20 +00:00
.gitignore	docs: Create all.md	2015-11-24 00:22:26 -06:00
.revision-hash	versionstamp: Set up '.revision-hash' file.	2015-10-19 07:21:20 +00:00
.version	Post-branch version number bump.	2016-10-19 23:08:18 +00:00
changelog.md	changelog: Update through `5feed23962`.	2017-07-30 16:38:30 +00:00
COPYING.md	Bump copyright years.	2016-04-30 02:11:17 +00:00
HACKING.md	dev docs: Document a useful tab completion setting.	2016-06-03 08:46:30 +00:00
INSTALL.md	docs: Unbreak Fedora link.	2017-07-28 11:30:31 +00:00
Makefile	tests: Add a 'print failures only' mode to 'make test', called 'make quiet-test'.	2016-01-02 21:22:01 +00:00
README.md	README: Fix FAQ entry about isearch highlighting	2017-07-30 19:08:18 +02:00
release.md	release.md: Record the specific command I used.	2016-10-18 22:53:17 +00:00
zsh-syntax-highlighting.plugin.zsh	driver: Stop requiring function_argzero.	2016-06-10 15:18:46 +00:00
zsh-syntax-highlighting.zsh	driver: Fix printing error message to file when cannot resolve highlighters directory location	2017-04-09 16:47:42 +00:00

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.

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.