Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RRethy/vim-hexokinase
hexokinase.vim - (Neo)Vim plugin for asynchronously displaying the colours in the file (#rrggbb, #rgb, rgb(a)? functions, hsl(a)? functions, web colours, custom patterns)
https://github.com/RRethy/vim-hexokinase
vim vim-hexokinase vim-plugin
Last synced: 2 months ago
JSON representation
hexokinase.vim - (Neo)Vim plugin for asynchronously displaying the colours in the file (#rrggbb, #rgb, rgb(a)? functions, hsl(a)? functions, web colours, custom patterns)
- Host: GitHub
- URL: https://github.com/RRethy/vim-hexokinase
- Owner: RRethy
- Archived: true
- Created: 2019-02-17T22:19:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-31T18:53:22.000Z (almost 3 years ago)
- Last Synced: 2024-08-03T01:31:04.343Z (6 months ago)
- Topics: vim, vim-hexokinase, vim-plugin
- Language: Vim script
- Homepage:
- Size: 103 KB
- Stars: 959
- Watchers: 9
- Forks: 24
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - vim-hexokinase - (Neo)Vim plugin for asynchronously displaying the colours in the file (#rrggbb, #rgb, rgb(a)? functions, hsl(a)? functions, web colours, custom patterns) | RRethy | 751 | (Vim script)
README
# vim-hexokinase
The fastest (Neo)Vim plugin for asynchronously displaying the colours in the file (#rrggbb, #rgb, rgb(a)? functions, hsl(a)? functions, web colours, custom patterns)
> let g:Hexokinase_highlighters = ['virtual']
> let g:Hexokinase_highlighters = ['sign_column']
> set signcolumn=yes:9 " Neovim only
> let g:Hexokinase_highlighters = ['foreground']
> let g:Hexokinase_highlighters = ['foregroundfull']
> let g:Hexokinase_highlighters = ['background']
> let g:Hexokinase_highlighters = ['backgroundfull']
## Rationale
**Problem:** [Colorizer](https://github.com/chrisbra/Colorizer) and [Colorizer](https://github.com/lilydjwg/colorizer) are plugins which also display the colour of text. However, they do so by changing the background of the text which is not pleasing to look at. On top of that, they all scrape the file synchronously.
**Solution:** Have 6 different options for displaying colour, including as virtual text or in the sign column. As well, do all scraping asynchronously.
## About
This plugin can display the colour of 6 digit hex codes, 3 digit hex codes, rgb functions, rgba functions, hsl functions, hsla functions, and custom patterns.
Colour can be displayed in each of the 6 six ways shown above, or can be customized to display colour any way the user chooses.
**Note:** By default all filetypes are scraped and highlighted on `['TextChanged', 'InsertLeave', 'BufRead']`, see `:h g:Hexokinase_refreshEvents` for more info.
## Requirements
- `:h 'termguicolors'` must be turned on and your terminal must support it
- **Golang must be installed, for more information visit https://golang.org/doc/install.**
- For *virtual text*: Neovim 0.3.2
- For *sign_column*: Vim compiled with `+signs` or any Neovim version
- Currently, untested on Windows, help is welcomed.
## Installation
1. Install Golang https://golang.org/doc/install
2. Install the plugin with the plugin manager of choice and ensure `make hexokinase` is executed in the project root:
```vim
" vim-plug
Plug 'rrethy/vim-hexokinase', { 'do': 'make hexokinase' }
" minpac
call minpac#add('rrethy/vim-hexokinase', { 'do': 'make hexokinase' })
" dein
call dein#add('rrethy/vim-hexokinase', { 'build': 'make hexokinase' })
" etc.
```
3. `:set termguicolors`
## Quick Start
Choose your method of highlighting:
```vim
" Neovim default
let g:Hexokinase_highlighters = [ 'virtual' ]
" Vim default
let g:Hexokinase_highlighters = [ 'sign_column' ]
" All possible highlighters
let g:Hexokinase_highlighters = [
\ 'virtual',
\ 'sign_column',
\ 'background',
\ 'backgroundfull',
\ 'foreground',
\ 'foregroundfull'
\ ]
```
Choose which patterns are matched:
```vim
" Patterns to match for all filetypes
" Can be a comma separated string or a list of strings
" Default value:
let g:Hexokinase_optInPatterns = 'full_hex,rgb,rgba,hsl,hsla,colour_names'
" All possible values
let g:Hexokinase_optInPatterns = [
\ 'full_hex',
\ 'triple_hex',
\ 'rgb',
\ 'rgba',
\ 'hsl',
\ 'hsla',
\ 'colour_names'
\ ]
" Filetype specific patterns to match
" entry value must be comma seperated list
let g:Hexokinase_ftOptInPatterns = {
\ 'css': 'full_hex,rgb,rgba,hsl,hsla,colour_names',
\ 'html': 'full_hex,rgb,rgba,hsl,hsla,colour_names'
\ }
```
Choose which filetypes to scrape automatically (by default ALL filetypes are scraped):
```vim
" Sample value, to keep default behaviour don't define this variable
let g:Hexokinase_ftEnabled = ['css', 'html', 'javascript']
```
## Commands
| Command | Description |
|---|---|
| **HexokinaseToggle** | Toggle the colouring |
| **HexokinaseTurnOn** | Turn on colouring (refresh if already turned on) |
| **HexokinaseTurnOff** | Turn off colouring |
## Full Configuration
See `:help hexokinase.txt`
## Custom Patterns
See `:help g:Hexokinase_palettes`.
This can be used to colour specific variables.
## FAQ
> I'm seeing grey colours when I toggle vim-hexokinase
You need `termguicolors` to be turned on. Verify `:set termguicolors?` outputs `termguicolors`. For more info, see https://github.com/RRethy/vim-hexokinase/issues/10.