isprogram
/
zsh-syntax-highlighting
mirror of https://github.com/zsh-users/zsh-syntax-highlighting.git
1
0
Fork 0
Code Issues 0 Projects 0 Releases 17 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1108 Commits
6 Branches
3.7 MiB
 
 
 
Tree: f564d11a41
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f564d11a41'
${ noResults }
 ZIP  TAR.GZ
Daniel Shahaf f564d11a41 make test: Re-enable syntax highlighting of TAP output in interactive runs 4 years ago
docs docs: Fix typo 4 years ago
highlighters tests: Fix the test for alias loops. 4 years ago
images Highlight redirections by default, and add that to the examples in README. 4 years ago
tests test harness: Update tests/edit-failed-tests for harness output changes in commit 2b3638a211cca4790c5b3b4f607edc0b0b2b6c73, "test harness: Tweak quiet-test output". 4 years ago
.editorconfig editorconfig += Makefile 4 years ago
.gitattributes versionstamp: Set up '.revision-hash' file. 9 years ago
.gitignore docs: Create all.md 8 years ago
.revision-hash versionstamp: Set up '.revision-hash' file. 9 years ago
.travis.yml tests: use zshusers/zsh image with tags (see zsh-users/zsh-docker#16) 5 years ago
.version Post-release version number bump. 4 years ago
COPYING.md Bump copyright years. 4 years ago
HACKING.md docs: Enable Syntax Highlighting for Code Snippits 5 years ago
INSTALL.md docs: Track FreeBSD port rename 4 years ago
Makefile make test: Re-enable syntax highlighting of TAP output in interactive runs 4 years ago
README.md Highlight redirections by default, and add that to the examples in README. 4 years ago
changelog.md changelog: Update through HEAD. 4 years ago
release.md release.md: Update with the step that was missed in 0.7.0. 4 years ago
zsh-syntax-highlighting.plugin.zsh driver: Stop requiring function_argzero. 8 years ago
zsh-syntax-highlighting.zsh driver: Be resilient to KSH_ARRAYS being set in the calling scope 4 years ago

README.md

zsh-syntax-highlighting Build Status

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: Screenshot #1.1
After:  Screenshot #1.2

Before: Screenshot #2.1
After:  Screenshot #2.2

Before: Screenshot #3.1
After:  Screenshot #3.2

Before: Screenshot #4.1
After:  Screenshot #4.2

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:

How to tweak

Syntax highlighting is done by pluggable highlighter scripts. See the documentation on highlighters for details and configuration settings.