Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrshmllow/document-color.nvim
🌈 LSP-based colorizer for neovim
https://github.com/mrshmllow/document-color.nvim
neovim neovim-lsp neovim-plugin tailwindcss
Last synced: 11 days ago
JSON representation
🌈 LSP-based colorizer for neovim
- Host: GitHub
- URL: https://github.com/mrshmllow/document-color.nvim
- Owner: mrshmllow
- License: mit
- Archived: true
- Created: 2022-08-14T12:10:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-22T11:36:42.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T16:36:37.888Z (about 2 months ago)
- Topics: neovim, neovim-lsp, neovim-plugin, tailwindcss
- Language: Lua
- Homepage:
- Size: 17.6 KB
- Stars: 164
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-stars - mrshmllow/document-color.nvim - 🌈 LSP-based colorizer for neovim (Lua)
- awesome-stars - mrshmllow/document-color.nvim - 🌈 LSP-based colorizer for neovim (Lua)
README
# document-color.nvim 🌈
A colorizer plugin for [tailwindcss](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#tailwindcss) and any lsp servers that support [`textDocument/documentColor`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_documentColor)!
For example [tailwindcss](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#tailwindcss), [cssls](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#cssls), and [dart](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#dartls) support documentColor!
## Installation & Usage
```lua
use { 'mrshmllow/document-color.nvim', config = function()
require("document-color").setup {
-- Default options
mode = "background", -- "background" | "foreground" | "single"
}
end
}
```
What is "single" mode?
For people who don't like large bright chunks of their buffer un-colorschemed, `single` column mode is a compromise until anti-conceal.
---
What does foreground mode look like?
---
For a typical [lspconfig](https://github.com/neovim/nvim-lspconfig) setup...
```lua
local on_attach = function(client)
...
if client.server_capabilities.colorProvider then
-- Attach document colour support
require("document-color").buf_attach(bufnr)
end
...
end
local capabilities = vim.lsp.protocol.make_client_capabilities()
-- You are now capable!
capabilities.textDocument.colorProvider = {
dynamicRegistration = true
}
-- Lsp servers that support documentColor
require("lspconfig").tailwindcss.setup({
on_attach = on_attach,
capabilities = capabilities
})
```
### Methods
```lua
-- Toggle in current buffer
require("document-color").buf_toggle()
-- Attach to the current buffer (Turn on)
require("document-color").buf_attach()
-- Detach from current buffer (Turn off)
require("document-color").buf_detach()
```
## Tips & Tricks
- Disable [nvim-colorizer.nvim](https://github.com/norcalli/nvim-colorizer.lua) in places its now redundent
```lua
-- Colorize
use { 'norcalli/nvim-colorizer.lua', config = function ()
require('colorizer').setup({
'*';
-- An example
'!css';
'!html';
'!tsx';
'!dart';
})
end }
```
## Notes
- You should probably keep your existing colorizer plugin, this plugin does not replace it in many cases
- I am only using "color" and not "colour" because thats what the lsp specs say, not because i believe in such heresy to the queen
## 🔮 A future...
When (or if) [anti-conceal](https://github.com/neovim/neovim/pull/9496) ever gets merged, it may be possible to have something like the tailwindcss vscode extension has
for now, we only have `mode = "single"`
## Credits
- [kabouzeid](https://github.com/kabouzeid) and his great dotfiles. Inspired by his reddit post, chunks of this plugin are from his dotfiles. ❤️
- https://github.com/norcalli/nvim-colorizer.lua