zsh-syntax-highlighting README

The project's README from github.com/zsh-users/zsh-syntax-highlighting. As one markdown file: 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

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 works by hooking into the Zsh Line Editor (ZLE) and computing syntax highlighting for the command-line buffer as it stands at the time z-sy-h's hook is invoked.

In zsh 5.2 and older, zsh-syntax-highlighting.zsh hooks into ZLE by wrapping ZLE widgets. It must be sourced after all custom widgets have been created (i.e., after all zle -N calls and after running compinit) in order to be able to wrap all of them. Widgets created after z-sy-h is sourced will work, but will not update the syntax highlighting.

In zsh newer than 5.8 (not including 5.8 itself), zsh-syntax-highlighting uses the add-zle-hook-widget facility to install a zle-line-pre-redraw hook. Hooks are run in order of registration, therefore, z-sy-h must be sourced (and register its hook) after anything else that adds hooks that modify the command-line buffer.

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.

zsh-syntax-highlighting (zsh-users/zsh-syntax-highlighting)

Searching Database…

23K ·GitHub
Zsh-syntax-highlighting
Что это такое?Плагин для Zsh, который добавляет подсветку синтаксиса в стиле оболочки Fish в интерактивную строку терминала: команды окрашиваются по мере ввода.
Это отдельная программа или плагин для оболочки?Это плагин для Zsh: скрипт, который подключается из .zshrc и встраивается в Zsh Line Editor (ZLE), чтобы окрашивать командную строку на лету.
Как установить и включить его?Следуйте инструкциям в INSTALL.md: нужно скачать скрипт на компьютер и подключить zsh-syntax-highlighting.zsh из .zshrc.
Какая версия zsh нужна?Требуется Zsh 4.3.11 или новее; некоторые функции, например подсветка при инкрементальном поиске по истории, работают только в zsh 5.4+.
Почему важно, где подключать его в .zshrc?Подключать нужно в самом конце .zshrc, после всех пользовательских виджетов и compinit, потому что плагин работает, оборачивая существующие виджеты ZLE (или регистрируя хук в новых версиях zsh). Всё, что добавлено после него, не будет обернуто и не сможет корректно обновлять подсветку.
Работает ли это и в Linux, и в macOS?Да, это плагин уровня оболочки, который работает везде, где запускается Zsh, в том числе в Linux и macOS.
Можно ли настроить, какие части команды подсвечиваются?Да, подсветка выполняется с помощью подключаемых скриптов-хайлайтеров, а в README есть ссылка на отдельную документацию по хайлайтерам с настройками.
Как объявляются новые релизы?Отдельного канала рассылки нет, но можно подписаться на RSS-ленту релизов GitHub или посмотреть запись проекта в anitya.
Подсвечивается ли инкрементальный поиск по истории?Только в zsh 5.4 и новее; в более старых версиях вы видите лишь стандартное подчёркивание найденного текста от zsh, без дополнительной подсветки от плагина.
What are similar projects?zsh-autosuggestions, awesome-zsh-plugins, prezto, powerlevel9k, bash-it, awesome-dotfiles, spaceship-prompt, starship
Which topics is it in?zsh-theme, zsh, dotfiles, syntax-highlighting, screenshot, bsd, shell, customization, command-line, plugin, productivity, terminal
Creator
zsh-users
Size
1.5 MB
Stars
23K
Updated
CommitOct 09
Age
15y
Commits · 90 Days