2020-02-04 05:30:40 +08:00
zsh-syntax-highlighting / highlighters / files
----------------------------------------------
This is the `files` highlighter, that highlights existing files appearing on the
command line.
### Quickstart
If you are happy with your `LS_COLORS` , simply add the following line to your
`.zshrc` after sourcing `zsh-syntax-highlighting.zsh` :
```zsh
zsh_highlight_files_extract_ls_colors
```
### Configuration
2020-02-04 23:25:34 +08:00
Files are colored according to the associative array `ZSH_HIGHLIGHT_FILE_TYPES`
and the array `ZSH_HIGHLIGHT_FILE_PATTERNS` . The values of
`ZSH_HIGHLIGHT_FILE_TYPES` are color specifications as in
`ZSH_HIGHLIGHT_STYLES` , and the keys define which file types are highlighted
according to that style (following `LS_COLORS` ):
2020-02-04 05:30:40 +08:00
* `fi` - ordinary files
* `di` - directories
* `ln` - symbolic links
* `pi` - pipes
* `so` - sockets
* `bd` - block devices
* `cd` - character devices
* `or` - broken symlinks
* `ex` - executable files
* `su` - files that have the suid bit set
* `sg` - files that have the sgid bit set
* `ow` - files that are world-writable
* `tw` - files that are world-writable and sticky
2020-02-18 06:05:15 +08:00
* `lp` - if set, the path component of a filename is highlighted using this style, unless it is set to `same` , in which case the path component is highlighted the same as the file
2020-02-04 05:30:40 +08:00
If a file would be highlighted `fi` , then it can be highlighted according to the
2020-02-04 23:25:34 +08:00
filename using `ZSH_HIGHLIGHT_FILE_PATTERNS` instead. This array has the form
`(glob1 style1 glob2 style2 glob3 style3 ...)` , where the globs are arbitrary
glob patterns, and the styles are color specifications. For instance, if have
`setopt extended_glob` and you write
2020-02-04 05:30:40 +08:00
```zsh
2020-02-04 23:25:34 +08:00
ZSH_HIGHLIGHT_FILE_PATTERNS+=('(#i)*.jpe#g' red,bold)
2020-02-04 05:30:40 +08:00
```
then the files `foo.jpg` and `bar.jPeG` will be colored red and bold.
2020-02-04 23:25:34 +08:00
### Limitations
This highlighter makes no attempt to determine if a word is in command position.
Hence if you run the command `cat foo` and you happen to have a directory named
`cat` in the current directory, then the highlighter will highlight `cat`
according to `ZSH_HIGHLIGHT_FILE_TYPES[di]` and not
`ZSH_HIGHLIGHT_STYLES[command]` (assuming you load the `files` highlighter after
the `main` one). Likewise with aliases, reserved words, etc.
