linux/zsh-syntax-highlighting
0
0
Fork 0
mirror of https://github.com/zsh-users/zsh-syntax-highlighting.git synced 2024-09-19 05:41:15 +02:00
Code Issues Projects Releases Wiki Activity
zsh-syntax-highlighting/highlighters/main/README.md

70 lines
2.5 KiB
Markdown
Raw Normal View History

Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
zsh-syntax-highlighting / highlighters / main
docs: Move highlighter headers down one level
2015-11-17 06:44:47 +01:00
---------------------------------------------
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
docs copyedit: Restyle bold-italic to fixed-width.
2015-11-17 04:00:50 +01:00
This is the `main` highlighter, that highlights:
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
* Commands
* Options
* Arguments
* Paths
* Strings
docs: Move highlighter headers down one level
2015-11-17 06:44:47 +01:00
### How to activate it
docs copyedit: Whitespace.
2015-11-17 03:54:53 +01:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:
ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] main)
This highlighter is active by default.
docs: Move highlighter headers down one level
2015-11-17 06:44:47 +01:00
### How to tweak it
docs copyedit: Whitespace.
2015-11-17 03:54:53 +01:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
This highlighter defines the following styles:
Fix READMEs
2011-06-12 23:16:41 +02:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
* `unknown-token` - unknown tokens / errors
docs: 'main': Improve styles documentation.
2015-11-17 19:41:14 +01:00
* `reserved-word` - shell reserved words (`if`, `for`)
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
* `alias` - aliases
Support suffix aliases Fixes zsh-users/zsh-syntax-highlighting#126.
2015-09-04 20:19:26 +02:00
* `suffix-alias` - suffix aliases (requires zsh 5.1.1 or newer)
docs: 'main': Improve styles documentation.
2015-11-17 19:41:14 +01:00
* `builtin` - shell builtin commands (`shift`, `pwd`, `zstyle`)
* `function` - function names
* `command` - command names
* `precommand` - precommand modifiers (e.g., `noglob`, `builtin`)
* `commandseparator` - command separation tokens (`;`, `&&`)
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
* `hashed-command` - hashed commands
docs: 'main': Improve styles documentation.
2015-11-17 19:41:14 +01:00
* `path` - existing filenames
* `path_prefix` - prefixes of existing filenames
main highlighter docs: Give examples of styles.
2015-09-10 21:44:19 +02:00
* `globbing` - globbing expressions (`*.txt`)
* `history-expansion` - history expansion expressions (`!foo` and `^foo^bar`)
docs: 'main': Improve styles documentation.
2015-11-17 19:41:14 +01:00
* `single-hyphen-option` - single hyphen options (`-o`)
* `double-hyphen-option` - double hyphen options (`--option`)
main highlighter docs: Give examples of styles.
2015-09-10 21:44:19 +02:00
* `back-quoted-argument` - backquoted expressions (`` `foo` ``)
* `single-quoted-argument` - single quoted arguments (`` 'foo' ``)
* `double-quoted-argument` - double quoted arguments (`` "foo" ``)
Support $''-quoted strings. This does not yet highlight backslash escapes within them.
2015-09-10 21:58:02 +02:00
* `dollar-quoted-argument` - dollar quoted arguments (`` $'foo' ``)
docs: 'main': Improve styles documentation.
2015-11-17 19:41:14 +01:00
* `dollar-double-quoted-argument` - parameter expansion inside double quotes (`$foo` inside `""`)
* `back-double-quoted-argument` - back double quoted arguments (`\x` inside `""`)
* `back-dollar-quoted-argument` - back dollar quoted arguments (`\x` inside `$''`)
* `assign` - parameter assignments
Highlight redirections. Fixes zsh-users/zsh-syntax-highlighting#23.
2015-09-25 14:39:06 +02:00
* `redirection` - redirection operators (`<`, `>`, etc)
docs: 'main': Improve styles documentation.
2015-11-17 19:41:14 +01:00
* `comment` - comments, when `setopt INTERACTIVE_COMMENTS` is in effect (`echo # foo`)
* `default` - everything else
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
docs copyedit: Rewrap to 80 columns, part 2.
2015-11-17 04:02:39 +01:00
To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`,
for example in `~/.zshrc`:
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
main highlighter docs: README: Tweak.
2015-09-10 21:44:19 +02:00
# Declare the variable
typeset -A ZSH_HIGHLIGHT_STYLES
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array
2011-06-12 22:57:14 +02:00
# 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'
main highlighter docs: README: Tweak.
2015-09-10 21:44:19 +02:00
The syntax for declaring styles is documented in [the `zshzle(1)` manual
page](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#SEC135).
Reference in a new issue Copy permalink