Fish shell like syntax highlighting for Zsh.

screenshot shell syntax-highlighting zsh zsh-syntax-highlighting

Go to file

Matthew Martin fd061b5730 tests: Test ZSH_HIGHLIGHT_STYLES keys directly Closes #287. Testing the keys directly removes the need for unused_highlight which will be removed next.		2016-05-05 12:28:39 -05:00
docs	minor: Rewrap docs for uncompiled readability.	2016-05-03 15:00:48 +00:00
highlighters	brackets: Fix bug introduced in `95d8256`	2016-05-05 09:59:26 -05:00
images	Add screenshot.	2015-10-24 10:59:20 +00:00
tests	tests: Test ZSH_HIGHLIGHT_STYLES keys directly	2016-05-05 12:28:39 -05: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	Version number bump.	2016-01-27 20:38:38 +00:00
changelog.md	changelog: Update for upcoming 0.4.1 release.	2016-01-27 20:48:56 +00:00
COPYING.md	Bump copyright years.	2016-04-30 02:11:17 +00:00
HACKING.md	dev docs: Create HACKING.md.	2016-05-05 01:20:32 +00:00
INSTALL.md	docs: Clarify oh-my-zsh installation instructions.	2016-03-12 18:36:44 +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	docs: Followup to the recent docs branch: clean up some internal cross-references.	2015-11-27 04:07:02 +00:00
release.md	release.md: Add a release checklist line item.	2016-04-05 05:49:18 +00:00
zsh-syntax-highlighting.plugin.zsh	plugin.zsh: Convert from symlink to plain file	2016-04-17 04:48:30 +00:00
zsh-syntax-highlighting.zsh	tests: Test ZSH_HIGHLIGHT_STYLES keys directly	2016-05-05 12:28:39 -05: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.

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.

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.