RepoMirrors/zsh-syntax-highlighting
1
0
Fork 0
mirror of https://github.com/zsh-users/zsh-syntax-highlighting synced 2024-12-14 07:24:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
Fish shell like syntax highlighting for Zsh.
662 Commits 6 Branches 17 Tags 2.7 MiB
Shell 99.4%
Perl 0.3%
Makefile 0.3%
e15a09840e
Go to file
Daniel Shahaf e15a09840e dev tools: Automate a recurring step: Set year correctly for new tests.
2016-09-23 06:37:28 +00:00
docs driver: Rename highlighter entry points 2016-08-16 17:51:43 +00:00
highlighters 'main': Highlight first command word in named functions defined in the sh syntax when MULTI_FUNC_DEF is set. 2016-09-23 06:37:26 +00:00
images Add screenshot. 2015-10-24 10:59:20 +00:00
tests dev tools: Automate a recurring step: Set year correctly for new tests. 2016-09-23 06:37:28 +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
.version Version number bump. 2016-01-27 20:38:38 +00:00
changelog.md changelog: Update for upcoming 0.4.1 release. 2016-01-27 20:48:56 +00:00
COPYING.md Bump copyright years. 2016-04-30 02:11:17 +00:00
HACKING.md dev docs: Document a useful tab completion setting. 2016-06-03 08:46:30 +00:00
INSTALL.md docs: Honour $ZDOTDIR in code examples. 2016-05-12 13:29:10 +00:00
Makefile tests: Add a 'print failures only' mode to 'make test', called 'make quiet-test'. 2016-01-02 21:22:01 +00:00
README.md noop: Rewrap. 2016-08-16 17:09:42 +00:00
release.md release.md: Add a release checklist line item. 2016-04-05 05:49:18 +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: Warn just once when a highlighter is missing. 2016-09-22 04:10:28 +00:00

README.md

zsh-syntax-highlighting

Fish shell-like 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.

Screenshot

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 (with the history-incremental-search-backward widget, which is bound by default to Ctrl+R in zsh's emacs keymap) requires zsh 5.3 or newer.

Under zsh 5.2 and older, 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 issue #288 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.