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,074 Commits 6 Branches 17 Tags 2.7 MiB
Shell 99.4%
Perl 0.3%
Makefile 0.3%
Go to file
Daniel Shahaf e07c901dfd tests: Fix the last added test to pass when sudo(8) isn't installed. 2020-02-28 15:22:43 +00:00
docs docs: Fix typo 2020-01-28 07:44:52 +00:00
highlighters tests: Fix the last added test to pass when sudo(8) isn't installed. 2020-02-28 15:22:43 +00:00
images README: Add a third image. 2016-10-20 01:02:27 +00:00
tests test harness: Tweak quiet-test output 2020-02-22 15:12:24 +00:00
.editorconfig Add .editorconfig file. 2020-01-16 17:19:25 +00:00
.gitattributes
…
.gitignore docs: Create all.md 2015-11-24 00:22:26 -06:00
.revision-hash
…
.travis.yml tests: use zshusers/zsh image with tags (see zsh-users/zsh-docker#16) 2019-05-25 13:59:59 +02:00
.version Post-release version number bump. 2020-01-11 23:42:31 +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 #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
changelog.md changelog: Document #670 as a known issue. 2020-01-25 21:00:40 +00:00
release.md release.md: Add missing argument. 2020-01-11 23:43:23 +00:00
zsh-syntax-highlighting.plugin.zsh driver: Stop requiring function_argzero. 2016-06-10 15:18:46 +00:00
zsh-syntax-highlighting.zsh noop: Whitespace changes only. 2020-02-22 15:12:24 +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

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.