Fish shell like syntax highlighting for Zsh.

screenshot shell syntax-highlighting zsh zsh-syntax-highlighting

Go to file

Daniel Shahaf e43e4fd2c7 'main': Fix $flags_sans_argument for 'nice'. Follow-up to `2c15b0e996` ("Learn $flags_sans_arguments…").		2018-10-10 22:20:19 -05:00
docs	main: Highlight {command,process} substitution delimiters	2018-09-30 16:26:01 -04:00
highlighters	'main': Fix $flags_sans_argument for 'nice'.	2018-10-10 22:20:19 -05:00
images	README: Add a third image.	2016-10-20 01:02:27 +00:00
tests	tests: Directly diff expected_region_highlight against region_highlight	2018-02-10 14:49:07 -06: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
.travis.yml	Enable testing on zsh 5.5.x/5.6.x releases	2018-09-22 21:27:01 +02:00
.version	Post-release version number bump.	2017-08-29 06:05:57 +00:00
changelog.md	Tag version 0.6.0-rc1.	2017-07-31 17:31:25 +00:00
COPYING.md	'main': Add a regression test for issue #474 .	2018-01-01 05:05:10 +00:00
HACKING.md	Add regexp highlighter	2017-12-09 16:17:22 -06:00
INSTALL.md	docs: Remove superfluous indentations in code block	2018-10-07 14:57:42 +00:00
Makefile	#440 : Identify the output.	2017-08-09 18:42:35 +00:00
README.md	docs: fix typos	2018-05-26 09:39:25 -04:00
release.md	release.md: Make a little more copy-pasteable.	2017-08-30 07:32:56 +00:00
zsh-syntax-highlighting.plugin.zsh	driver: Stop requiring function_argzero.	2016-06-10 15:18:46 +00:00
zsh-syntax-highlighting.zsh	#535 : locally enable BARE_GLOB_QUAL option when loading highlighters	2018-09-22 22:50:46 +02:00

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.