https://github.com/neoclide/coc-highlight

Document highlight and document colors LSP support for coc.nvim
https://github.com/neoclide/coc-highlight

coc document-highlight highlight-symbol neovim vim

Last synced: 3 months ago
JSON representation

Document highlight and document colors LSP support for coc.nvim

• Host: GitHub
• URL: https://github.com/neoclide/coc-highlight
• Owner: neoclide
• Created: 2018-11-18T21:25:46.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-10-29T17:25:44.000Z (about 2 years ago)
• Last Synced: 2024-08-01T16:55:36.147Z (6 months ago)
• Topics: coc, document-highlight, highlight-symbol, neovim, vim
• Language: TypeScript
• Homepage:
• Size: 158 KB
• Stars: 221
• Watchers: 6
• Forks: 12
• Open Issues: 6
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# coc-highlight

Provide filetype irrelevant highlights to [coc.nvim](https://github.com/neoclide/coc.nvim),

including document highlight (highlight of current document symbol) and color

highlights.



**Important** the implementation from version 2.0.0 have changed from language

server to worker threads, and only changed lines are calculated for colors.

## Install

In your vim/neovim, run command:

```

:CocInstall coc-highlight

```

## Features

- Highlight the same word symbols of word under cursor.

- Add color highlights to buffers when enabled.

## Usage

To enable highlight current symbol on `CursorHold`, add:

```vim

autocmd CursorHold * silent call CocActionAsync('highlight')

```

to your `.vimrc` or use the [coc_current_word plugin](https://github.com/IngoMeyer441/coc_current_word) which provides

configurable delayed highlighting independently from the user's `updatetime` setting.

To add colors support for all filetypes, use:

```json

"colors.enable": true,

```

to your `settings.json`.

To pick a different color, use command:

```

:call CocAction('pickColor')

```

**Note:** only works on Mac or have python gtk module installed.

To pick a different color presentation, use command:

```

:call CocAction('colorPresentation')

```

## Options

- `highlight.trace`: Trace level for colors highlight. default: `"messages"`

  Valid options: ["off","messages","verbose"]

- `highlight.disableLanguages`: List of filetypes to ignore. default: `[]`

- `highlight.document.enable`: Set to false disable document highlight of current symbol, reload coc.nvim required on change, default: `true`

- `highlight.colors.enable`: Set to false to disable color highlight, reload coc.nvim required on change, default: `true`

- `highlight.colorNames.enable`: Set to false to disable highlight of color names, default: `true`

## F.A.Q

**Q:** Why color highlight is not shown on my vim?

**A:** For terminal vim, you have to enable 24-bit RGB color by `set termguicolors` and make sure your terminal support true colors. To make sure the

highlight is not disabled, enable verbose output by `"highlight.trace": "verbose"` in configuration file and checkout the output by `:CocCommand workspace.showOutput highlight`.

**Q:** How to change highlight of the current symbol.

**A:** All you need is overwrite the highlight group, checkout `:h coc-highlights`

## License

MIT