e9ceb2017e
These tests are based on the patches contributed in those issues:
commit 9d9df4fe80c878e460b38b5d8be76926a9e02286 (upstream/pr/167)
Author: Miciah Masters <miciah.masters@gmail.com>
AuthorDate: Thu Apr 23 20:28:24 2015 -0400
Commit: Miciah Dashiel Butler Masters <mmasters@redhat.com>
CommitDate: Thu Apr 23 20:28:24 2015 -0400
Highlight comments
M highlighters/main/main-highlighter.zsh
A highlighters/main/test-data/comments.zsh
commit d94f1a037f9829792b2faaf94efe4d86300369b7 (upstream/pr/163)
Author: sonnym <michaud.sonny@gmail.com>
AuthorDate: Fri Mar 6 18:27:57 2015 -0500
Commit: sonnym <michaud.sonny@gmail.com>
CommitDate: Fri Mar 6 21:16:27 2015 -0500
highlight comments when interactive_comments is on
M highlighters/main/main-highlighter.zsh
A highlighters/main/test-data/comment-embedded.zsh
A highlighters/main/test-data/comment-leading.zsh
Patch-by: sonnym <michaud.sonny@gmail.com>
Patch-by: Miciah Masters <miciah.masters@gmail.com>
(corrected and refreshed for harness changes by me)
zsh-syntax-highlighting
Fish shell like syntax highlighting for Zsh.
Requirements: zsh 4.3.17+.
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.
How to install
Using packages
- Arch Linux: community/zsh-syntax-highlighting / AUR/zsh-syntax-highlighting-git
- Gentoo: mv overlay
- Mac OS X / Homebrew: brew install zsh-syntax-highlighting
In your ~/.zshrc
-
Clone this repository:
git clone git://github.com/zsh-users/zsh-syntax-highlighting.git(or download a snapshot)
-
Source the script at the end of
~/.zshrc:source /path/to/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh -
Source
~/.zshrcto take changes into account:source ~/.zshrc
With oh-my-zsh
-
Download the script or clone this repository in oh-my-zsh plugins directory:
git clone git://github.com/zsh-users/zsh-syntax-highlighting.git ~/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting -
Activate the plugin in
~/.zshrc:plugins=( [plugins...] zsh-syntax-highlighting) -
Source
~/.zshrcto take changes into account:source ~/.zshrc
Note that zsh-syntax-highlighting must be the last plugin sourced,
so make it the last element of the $plugins array.
System-wide installation
Either of the above methods is suitable for a single-user installation, which requires
no special privileges. If, however, you desire to install zsh-syntax-highlighting
system-wide, you may do so by running make install and directing your users to
add source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
in their .zshrcs.
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.
How are new releases announced?
There is currently no "push" announcements channel. However, the following alternatives exist:
- GitHub's RSS feed of releases: https://github.com/zsh-users/zsh-syntax-highlighting/releases.atom
- An anitya entry: https://release-monitoring.org/project/7552/
How to tweak
Syntax highlighting is done by pluggable highlighter scripts, see the highlighters directory for documentation and configuration settings.