RepoMirrors/zsh-syntax-highlighting
1
0
Fork 0
mirror of https://github.com/zsh-users/zsh-syntax-highlighting synced 2024-12-13 23:14:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
Fish shell like syntax highlighting for Zsh.
814 Commits 6 Branches 17 Tags 2.7 MiB
Shell 99.4%
Perl 0.3%
Makefile 0.3%
f064b17d25
Go to file
Daniel Shahaf f064b17d25 'main': Add an explicit test for escaped single quotes within single quotes, «'foo'\''bar'».
2018-01-13 15:45:41 +00:00
docs docs: main: Clarify back-quoted-argument, back-double-quoted-argument, back-dollar-quoted-argument, and assign. 2018-01-13 14:43:37 +00:00
highlighters 'main': Add an explicit test for escaped single quotes within single quotes, «'foo'\''bar'». 2018-01-13 15:45:41 +00:00
images README: Add a third image. 2016-10-20 01:02:27 +00:00
tests tests: Include the filename in error messages. 2018-01-12 14:28:08 +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: customize IRC notifcation message 2017-09-28 19:07:24 +02:00
.version Post-release version number bump. 2017-08-29 06:05:57 +00:00
changelog.md Tag version 0.6.0-rc1. 2017-07-31 17:31:25 +00:00
COPYING.md 'main': Add a regression test for issue #474. 2018-01-01 05:05:10 +00:00
HACKING.md Add regexp highlighter 2017-12-09 16:17:22 -06:00
INSTALL.md docs: Fix links; thanks @dukex for noticing 2017-12-19 16:05:02 -06:00
Makefile #440: Identify the output. 2017-08-09 18:42:35 +00:00
README.md Typo 2017-11-29 17:53:23 +01:00
release.md release.md: Make a little more copy-pasteable. 2017-08-30 07:32:56 +00:00
zsh-syntax-highlighting.plugin.zsh driver: Stop requiring function_argzero. 2016-06-10 15:18:46 +00:00
zsh-syntax-highlighting.zsh driver: Run under emulate -L zsh and add zsyh_user_options 2017-12-16 09:33:51 -06:00

README.md

zsh-syntax-highlighting Build Status

Fish shell-like syntax highlighting for Zsh.

Requirements: zsh 4.3.11+.

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.

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.