RepoMirrors
/
zsh-syntax-highlighting
mirror of https://github.com/zsh-users/zsh-syntax-highlighting
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Fish shell like syntax highlighting for Zsh.
1,246 Commits 6 Branches 17 Tags 2.5 MiB
Shell 99.4%
Perl 0.3%
Makefile 0.3%
Go to file
Daniel Shahaf 2d60a47cc4 Post-release version number bump. 2020-07-14 21:33:52 +00:00
docs docs: regexp highlighter: Fix a wrong associative array name in the example. 2020-07-01 12:55:43 +00:00
highlighters brackets: Optimize the character iteration 2020-07-14 20:19:40 +00:00
images Highlight redirections by default, and add that to the examples in README. 2020-02-28 22:49:02 +00:00
tests driver: Follow-up to grandparent: Have all test suite entry points declare the mock $region_highlight. 2020-07-14 01:57:02 +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 CI += zsh-5.8 2020-05-26 17:52:17 +00:00
.version Post-release version number bump. 2020-07-14 21:33:52 +00:00
COPYING.md Bump copyright years. 2020-01-16 17:19:25 +00:00
HACKING.md Use the new, unreleased zsh 'memo=' feature to remove only our own entries from $region_highlight. 2020-07-14 00:32:36 +00:00
INSTALL.md docs: Fix obs-repository link 2020-06-15 00:23:05 -05: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 Post-release version number bump. 2020-07-14 21:33:52 +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 Revert "driver: Move the initialization of $zsh_highlight__memo_feature out of the entry point function." 2020-07-14 02:29:46 +00:00

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.