Fish shell like syntax highlighting for Zsh.

Go to file

Daniel Shahaf 343ec1061f 'make perf': Show only a cumulative datum per highligher, rather than per test file. The overall per-highlighter duration should be less prone to random noise than the multitude of per-test-file figures.		2020-05-04 17:48:47 +00:00
docs	'main': Let AUTO_CD directories be highlighted with their own style.	2020-03-19 06:06:30 +00:00
highlighters	'main': Don't trip WARN_NESTED_VAR.	2020-05-04 13:27:33 +00:00
images	Highlight redirections by default, and add that to the examples in README.	2020-02-28 22:49:02 +00:00
tests	'make perf': Show only a cumulative datum per highligher, rather than per test file.	2020-05-04 17:48:47 +00:00
.editorconfig	editorconfig: Fix Makefile settings	2020-04-12 02:59:39 +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
.travis.yml	Revert "test harness: Rewrite the columnar pretty-printer without external tools." and "travis: Remove bsdmainutils since column(1) has been removed, three commits ago."	2020-03-20 00:03:01 +00:00
.version	Post-release version number bump.	2020-02-28 21:34:58 +00:00
COPYING.md	Bump copyright years.	2020-01-16 17:19:25 +00:00
HACKING.md	docs: Enable Syntax Highlighting for Code Snippits	2019-01-13 16:12:41 +08:00
INSTALL.md	docs: Track FreeBSD port rename	2020-01-23 22:09:33 +00:00
Makefile	make test: Re-enable syntax highlighting of TAP output in interactive runs	2020-03-15 18:10:18 +00:00
README.md	Highlight redirections by default, and add that to the examples in README.	2020-02-28 22:49:02 +00:00
changelog.md	'main': precommands += strace	2020-04-20 11:09:24 +00:00
release.md	release.md: Update with the step that was missed in 0.7.0.	2020-02-28 21:33:51 +00:00
zsh-syntax-highlighting.plugin.zsh	driver: Stop requiring function_argzero.	2016-06-10 15:18:46 +00:00
zsh-syntax-highlighting.zsh	Bump copyright years.	2020-04-03 02:03:18 +00: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.