47d6dac133
Move tests on the highlight path until after the blacklist is checked so that blacklisted paths are not tested. This should prevent hangs on dead remote filesystems provided the path is blacklisted in X_ZSH_HIGHLIGHT_DIRS_BLACKLIST. Updated tests to 'default' highlight as the blacklist is now checked before the path is tested. Bug: https://github.com/zsh-users/zsh-syntax-highlighting/issues/528 |
||
---|---|---|
.. | ||
test-data | ||
main-highlighter.zsh | ||
README.md |
zsh-syntax-highlighting / highlighters / main
This is the main
highlighter, that highlights:
- Commands
- Options
- Arguments
- Paths
- Strings
This highlighter is active by default.
How to tweak it
This highlighter defines the following styles:
unknown-token
- unknown tokens / errorsreserved-word
- shell reserved words (if
,for
)alias
- aliasessuffix-alias
- suffix aliases (requires zsh 5.1.1 or newer)builtin
- shell builtin commands (shift
,pwd
,zstyle
)function
- function namescommand
- command namesprecommand
- precommand modifiers (e.g.,noglob
,builtin
)commandseparator
- command separation tokens (;
,&&
)hashed-command
- hashed commandspath
- existing filenamespath_pathseparator
- path separators in filenames (/
); if unset,path
is used (default)path_prefix
- prefixes of existing filenamespath_prefix_pathseparator
- path separators in prefixes of existing filenames (/
); if unset,path_prefix
is used (default)globbing
- globbing expressions (*.txt
)history-expansion
- history expansion expressions (!foo
and^foo^bar
)single-hyphen-option
- single-hyphen options (-o
)double-hyphen-option
- double-hyphen options (--option
)back-quoted-argument
- backtick command substitution (`foo`
)back-quoted-argument-unclosed
- unclosed backtick command substitution (`foo
)single-quoted-argument
- single-quoted arguments ('foo'
)single-quoted-argument-unclosed
- unclosed single-quoted arguments ('foo
)double-quoted-argument
- double-quoted arguments ("foo"
)double-quoted-argument-unclosed
- unclosed double-quoted arguments ("foo
)dollar-quoted-argument
- dollar-quoted arguments ($'foo'
)dollar-quoted-argument-unclosed
- unclosed dollar-quoted arguments ($'foo
)rc-quote
- two single quotes inside single quotes when theRC_QUOTES
option is set ('foo''bar'
)dollar-double-quoted-argument
- parameter expansion inside double quotes ($foo
inside""
)back-double-quoted-argument
- backslash escape sequences inside double-quoted arguments (\"
in"foo\"bar"
)back-dollar-quoted-argument
- backslash escape sequences inside dollar-quoted arguments (\x
in$'\x48'
)assign
- parameter assignments (x=foo
andx=( )
)redirection
- redirection operators (<
,>
, etc)comment
- comments, whensetopt INTERACTIVE_COMMENTS
is in effect (echo # foo
)arg0
- a command word other than one of those enumerated above (other than a command, precommand, alias, function, or shell builtin command).default
- everything else
To override one of those styles, change its entry in ZSH_HIGHLIGHT_STYLES
,
for example in ~/.zshrc
:
# Declare the variable
typeset -A ZSH_HIGHLIGHT_STYLES
# To differentiate aliases from other command types
ZSH_HIGHLIGHT_STYLES[alias]='fg=magenta,bold'
# To have paths colored instead of underlined
ZSH_HIGHLIGHT_STYLES[path]='fg=cyan'
# To disable highlighting of globbing expressions
ZSH_HIGHLIGHT_STYLES[globbing]='none'
The syntax for values is the same as the syntax of "types of highlighting" of
the zsh builtin $zle_highlight
array, which is documented in the zshzle(1)
manual page.
Parameters
To avoid partial path lookups on a path, add the path to the X_ZSH_HIGHLIGHT_DIRS_BLACKLIST
array.
This interface is still experimental.
X_ZSH_HIGHLIGHT_DIRS_BLACKLIST+=(/mnt/slow_share)
Useless trivia
Forward compatibility.
zsh-syntax-highlighting attempts to be forward-compatible with zsh. Specifically, we attempt to facilitate highlighting command word types that had not yet been invented when this version of zsh-syntax-highlighting was released.
A command word is something like a function name, external command name, et
cetera. (See
Simple Commands & Pipelines in zshmisc(1)
for a formal definition.)
If a new kind of command word is ever added to zsh — something conceptually
different than "function" and "alias" and "external command" — then command words
of that (new) kind will be highlighted by the style arg0_$kind
,
where $kind
is the output of type -w
on the new kind of command word. If that
style is not defined, then the style arg0
will be used instead.