mirror of
https://github.com/zsh-users/zsh-syntax-highlighting.git
synced 2025-01-30 09:47:13 +08:00
c28312b9d3
* origin/master: (297 commits) driver: Follow-up to grandparent: Have all test suite entry points declare the mock $region_highlight. Use the new, unreleased zsh 'memo=' feature to remove only our own entries from $region_highlight. driver: Stop re-declaring $region_highlight. It's unneeded. docs: regexp highlighter: Fix a wrong associative array name in the example. docs: Fix obs-repository link tests: Fix a wrong value of $PREBUFFER in a test, and add checks to prevent this from recurring. test harness: Fix use of an undefined variable in an error message. 'main': Don't progress the $in_redirection staller while $in_param. tests: Add an XFail test for issue #712. 'main': Highlight the parentheses of array assignments as reserved words. CI += zsh-5.8 main: Add tests for arithmetic expansion main: Add arithmetic substitution highlighting changelog.md: Restore vertical whitespace before section headers. 'main': Fix issue #677, concerning multiline aliases. changelog: Update through HEAD. 'main': Further optimize argument parsing. 'main': Optimize a hot path. tests: Add a performance testing script, for measuring the performance of the 'main' highlighter on a large file. changelog: Update through HEAD. test harness: Print the expected-v.-actual on every failure, not just upon cardinality failures. Document ZSH_HIGHLIGHT_MAXLENGTH. 'main': Fix the last commit's bug concerning parameter elision not happening in redirects in command position. 'main': Add a test for parameter elision not happening in redirects in command position. 'main': Fix regression in zsh 5.3.1 and older: all precmd hooks later than z-sy-h would be aborted. changelog += WARN_NESTED_VAR fixes (#727, #731) 'main': Fix a regression caused by the great-grandparent commit's WARN_NESTED_VAR fix. 'main': Don't run `_zsh_highlight_main__type` on every non-command word. 'make perf': Show only a cumulative datum per highligher, rather than per test file. 'main': Don't trip WARN_NESTED_VAR. 'main': Follow-up to previous: Document the version number, and deduplicate some option letters. 'main': precommands += strace editorconfig: Fix Makefile settings Fix typo Bump copyright years. driver: Fix "_zsh_highlight:3: read-only variable: ret" warnings when POSIX_BUILTINS is set. tests: Add a test for the infinite loop fixed by each of the last two commits. 'main': Fix expansion of positional parameters in `_zsh_highlight_main_highlighter__try_expand_parameter`. 'main': Fix an infinite loop. 'main': precommands += ionice(1) (from util-linux) driver: Simplify initialization of $zsyh_user_options in the fallback codepath. driver: Make sure we don't change the return value in a called function. 'main': Make logic more robust. No functional change. 'main': Break out an anonymous function into a named function. Fix typos in comments. main: Add test for issue #713 'main': Support the 'env' precommand. test harness: Fix the pretty-printer's padding implementation. Revert "test harness: Rewrite the columnar pretty-printer without external tools." and "travis: Remove bsdmainutils since column(1) has been removed, three commits ago." changelog: Update through HEAD. 'main': Correctly highlight '&&' and '||' inside '[[ … ]]' conditions. 'main': Highlight reserved words following assignments as errors. tests: Add tests for issue #461. test harness: Output the time information to the same place the test name was printed to. test harness: Stringify values in a more readable manner. tests: Add a unit test for a path specified with mixed quoting. tests: Add a test for issue #498, which has already been fixed. tests: Test that global qualifiers and command substitutions aren't evaluated. 'main': Don't consider path_prefix in alias expansions. 'main': Add a test for aliases to AUTO_CD directories. 'main': Let AUTO_CD directories be highlighted with their own style. 'main': Add an auxiliary variable for readability. 'main': In command position, do not highlight directories (unless AUTO_CD is set) and non-executable files. 'main': Extend tests to capture the current behaviour. 'main': Add an XFail test for issue #202. 'main': Highlight errors from the EQUALS option. 'main': Let the type determination ignore global aliases when it ignores regular ones. 'main': Add a regression test for parameters that expand to global aliases. 'main': Enable the zsh/parameter codepath of global aliases highlighting. changelog: Update through HEAD. travis: Remove bsdmainutils since column(1) has been removed, three commits ago. 'main': Highlight global aliases tests: Record current behaviour on global aliases. test harness: Rewrite the columnar pretty-printer without external tools. test harness: Fix an issue with the pretty-printed $expected_region_highlight/$region_highlight diffing. 'main': Support the "close file descriptor" and "coproc" redirection syntaxes tests: Add a test for the "close file descriptor" and "coproc" redirection syntaxes tests: Fix the test added in the last commit. tests: Add a test for issue #705, concerning continuation lines. test harness: Let tests fail early by exiting non-zero or by setting a flag. test harness: Print the test name when $skip_test is set. test harness: Remove a bogus check. test harness: Fix $skip_test support, broken yesterday. travis: Install bsdmainutils to provide column(1). test harness: When the cardinality check fails, pretty-print \$expected_region_highlight and \$region_highlight. test harness: Don't leak options from test files to the test harness. test harness: Fix test failures under zsh 5.0.8 and older. 'main': Fix a bug manifesting under zsh 5.2 and older. 'main': Don't highlight arithmetic expansions as command substitutions. tests: Add a test documenting the current state, prior to introducing #704. test harness: Change cardinality check semantics test harness: No-op change to minimize the next diff. 'main': Document additional meanings of the 'S' $braces_stack flag. 'main': When the redirection operator '>&' or '<&' is followed by a positive integer, do not consider that as a filename; it's always a file descriptor. 'main': Add $last_arg for "lookbehind". noop: Clarify comment. 'main': Honour the MULTIOS option when applying the 'globbing' style. 'main': Document what $in_redirection is currently used for. 'main': The optimized cmdsubst input syntax doesn't glob. changelog: Fix markup. ...
98 lines
3.7 KiB
Markdown
98 lines
3.7 KiB
Markdown
zsh-syntax-highlighting [![Build Status][build-status-image]][build-status-travis]
|
|
=======================
|
|
|
|
**[Fish shell][fish]-like syntax highlighting for [Zsh][zsh].**
|
|
|
|
*Requirements: zsh 4.3.11+.*
|
|
|
|
[fish]: http://www.fishshell.com/
|
|
[zsh]: http://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: [](images/before1.png)
|
|
<br/>
|
|
After: [](images/after1.png)
|
|
|
|
Before: [](images/before2.png)
|
|
<br/>
|
|
After: [](images/after2.png)
|
|
|
|
Before: [](images/before3.png)
|
|
<br/>
|
|
After: [](images/after3.png)
|
|
|
|
Before: [](images/before4-smaller.png)
|
|
<br/>
|
|
After: [](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 5.3 and newer,
|
|
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 <kbd>Ctrl+R</kbd> 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]: http://zsh.sourceforge.net/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-image]: https://travis-ci.org/zsh-users/zsh-syntax-highlighting.svg?branch=master
|
|
[build-status-travis]: https://travis-ci.org/zsh-users/zsh-syntax-highlighting
|