Skip to content

unikitty37/zsh-syntax-highlighting

This branch is 126 commits behind zsh-users/zsh-syntax-highlighting:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f5d1be7 · Apr 12, 2020
Mar 19, 2020
Apr 8, 2020
Feb 28, 2020
Mar 20, 2020
Apr 12, 2020
Oct 19, 2015
Nov 24, 2015
Oct 19, 2015
Mar 20, 2020
Feb 28, 2020
Jan 16, 2020
Jan 13, 2019
Jan 23, 2020
Mar 15, 2020
Feb 28, 2020
Mar 21, 2020
Feb 28, 2020
Jun 10, 2016
Apr 3, 2020

Repository files navigation

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.

About

Fish shell like syntax highlighting for Zsh.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Shell 99.3%
  • Other 0.7%