Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/zsh-users/zsh-syntax-highlighting

Fish shell like syntax highlighting for Zsh.
https://github.com/zsh-users/zsh-syntax-highlighting

screenshot shell syntax-highlighting zsh zsh-syntax-highlighting

Last synced: 15 days ago
JSON representation

Fish shell like syntax highlighting for Zsh.

Host: GitHub
URL: https://github.com/zsh-users/zsh-syntax-highlighting
Owner: zsh-users
License: bsd-3-clause
Created: 2010-12-25T17:28:55.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2024-03-22T01:10:50.000Z (3 months ago)
Last Synced: 2024-05-08T16:15:03.823Z (27 days ago)
Topics: screenshot, shell, syntax-highlighting, zsh, zsh-syntax-highlighting
Language: Shell
Homepage: github.com/zsh-users/zsh-syntax-highlighting
Size: 1.48 MB
Stars: 19,132
Watchers: 132
Forks: 1,309
Open Issues: 188
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: COPYING.md

Lists

awesome-stars - zsh-syntax-highlighting - users | 15370 | (Shell)
awesome-bookmarks - **zsh-syntax-highlighting**
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
terminals-are-sexy - zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shells / ZSH)
awesome-zsh-plugins - syntax-highlighting - Add syntax highlighting to your ZSH. Make sure you load this *before* [zsh-users/zsh-history-substring-search](https://github.com/zsh-users/zsh-history-substring-search) or they will both break. (Plugins / ZSH on Windows)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
orm-awesome - zsh-syntax-highlighting
awesome-fullstack - Syntax Highlighting
awesome-fullstack - Syntax Highlighting
toolbox - zsh-syntax-highlighting - Syntax highlighting in the shell. I like that it shows the command in red when it does not exist. (Terminal)
term-awesome - `zsh-syntax-highlighting` - Fish shell liked syntax highlighting for zsh. (Customized / zsh)
awesome - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-tools - zsh-syntax-highlighting
awesome-stars - zsh-users/zsh-syntax-highlighting
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (shell)
fucking-terminals-are-sexy - zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shells / ZSH)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars-coconut - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-web-dev - zsh-syntax-highlighting
awesome-stars - zsh-syntax-highlighting - users | 15720 | (Shell)
awesome-resources - **zsh-syntax-highlighting**
awesome-stars-wjf0214 - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-syntax-highlighting - users | 19298 | (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-starts - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
recommendations-for-engineers - zsh-syntax-highlighting
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
my-awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
NERV-awesome-dotfiles - zsh-syntax-highlighting
awesome-github-star - zsh-syntax-highlighting - users | 17771 | (Shell)
awesome-stars - zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-starred-test - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-syntax-highlighting - users | 9061 | (Shell)
awesome-stars - zsh-syntax-highlighting - users | 19202 | (Shell)
awesome-shell - zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh (Zsh)
awesome-zsh-plugins - syntax-highlighting - Add syntax highlighting to your ZSH. Make sure you load this _before_ [zsh-users/zsh-history-substring-search](https://github.com/zsh-users/zsh-history-substring-search) or they will both break. (Plugins / ZSH on Windows)
my-awesome-list - zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Programming Languages / Shell)
awesome-zsh-plugins - syntax-highlighting - Add syntax highlighting to your ZSH. Make sure you load this _before_ zsh-users/zsh-history-substring-search or they will both break. (Plugins / Zinit (née zplugin))
awesome - zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
my-awesome - zsh-users/zsh-syntax-highlighting - highlighting,zsh,zsh-syntax-highlighting pushed_at:2024-05 star:19.3k fork:1.3k Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - `★19288` Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
jimsghstars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
awesome-stars - zsh-users/zsh-syntax-highlighting - Fish shell like syntax highlighting for Zsh. (Shell)
fucking-awesome-zsh-plugins - syntax-highlighting - Add syntax highlighting to your ZSH. Make sure you load this *before* <b><code>  2485⭐</code></b> <b><code>   152🍴</code></b> [zsh-users/zsh-history-substring-search](https://github.com/zsh-users/zsh-history-substring-search)) or they will both break. (Plugins / ZSH on Windows)

README

        zsh-syntax-highlighting [![Build Status][build-status-image]][build-status]

=======================

**[Fish shell][fish]-like syntax highlighting for [Zsh][zsh].**

*Requirements: zsh 4.3.11+.*

[fish]: https://fishshell.com/

[zsh]: https://www.zsh.org/

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](images/before1-smaller.png)](images/before1.png)




After:  [![Screenshot #1.2](images/after1-smaller.png)](images/after1.png)

Before: [![Screenshot #2.1](images/before2-smaller.png)](images/before2.png)




After:  [![Screenshot #2.2](images/after2-smaller.png)](images/after2.png)

Before: [![Screenshot #3.1](images/before3-smaller.png)](images/before3.png)




After:  [![Screenshot #3.2](images/after3-smaller.png)](images/after3.png)

Before: [![Screenshot #4.1](images/before4-smaller.png)](images/before4-smaller.png)




After:  [![Screenshot #4.2](images/after4-smaller.png)](images/after4-smaller.png)

How to install

--------------

See [INSTALL.md](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.

### 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][zshzle-Character-Highlighting]

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][i288] and [#415][i415] for details.

[zshzle-Character-Highlighting]: https://zsh.sourceforge.io/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting

[i288]: https://github.com/zsh-users/zsh-syntax-highlighting/pull/288

[i415]: https://github.com/zsh-users/zsh-syntax-highlighting/pull/415

### 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

[documentation on highlighters](docs/highlighters.md) for details and

configuration settings.

[build-status]: https://github.com/zsh-users/zsh-syntax-highlighting/actions

[build-status-image]: https://github.com/zsh-users/zsh-syntax-highlighting/workflows/Tests/badge.svg