`document-color.nvim`: Neovim 中的基于LSP的颜色高亮器

🌈 document-color.nvim: Neovim 中的基于LSP的颜色高亮器

document-color.nvim🌈 LSP-based colorizer for neovim项目地址:https://gitcode.com/gh_mirrors/do/document-color.nvim

---

项目介绍

document-color.nvim 是一个专为 Neovim 打造的插件，它利用语言服务器协议（LSP）来实现对文本文档中的颜色进行智能识别和高亮显示。特别适用于处理如 Tailwind CSS 这类框架的项目，同时也支持任何实现了 textDocument/documentColor 功能的LSP服务器，例如 CSSLS、Dart 等。该项目受到 norcalli 的 dotfiles 启发，并致力于在不完全替代现有色彩管理插件的前提下，提供更佳的色彩可视化体验。

项目快速启动

要快速启动并使用 document-color.nvim，您首先需要确保您的 Neovim 已经配置了对应的语言服务器。以下是如何通过 Vim 插件管理器（以 Plug 为例）安装此插件，并对其进行基本配置的过程：

1. 添加到你的 .vimrc 或 init.vim

   在你的配置文件末尾加入以下行来添加该插件:

   Plug 'mrshmllow/document-color.nvim'
   

2. 执行 Plugin Install

   保存配置并重启或运行 :PlugInstall 来安装插件。

3. 配置插件

   在你的配置文件中添加如下配置以启用并设置默认选项：

   require("document-color").setup({
     -- 可选模式: "background", "foreground", "single"
     mode = "background",
   })
   
   -- 若要在特定缓冲区上立即激活颜色高亮，可以使用如下命令：
   -- 注意，实际使用时需将 `<buffer_number>` 替换成实际的缓冲区编号。
   -- require("document-color").buf_attach(<buffer_number>)
   

4. 开启色彩服务

   对于 Tailwind CSS 这样的情况，确保 LSP 服务已经配置好，并且具有色彩提供能力。以下是简化的LSP配置示例：

   local capabilities = vim.lsp.protocol.make_client_capabilities()
   capabilities.textDocument.colorProvider = { dynamicRegistration = true }
   require("lspconfig").tailwindcss.setup{
     on_attach = function(client)
       if client.server_capabilities.colorProvider then
         require("document-color").buf_attach(vim.fn.bufnr("%"))
       end
     end,
     capabilities = capabilities,
   }
   

应用案例和最佳实践

• Tailwind CSS 编辑: 使用此插件可以让您在编写 Tailwind CSS 类名时直观地看到颜色如何在文档内分布，增强设计时的颜色感知和一致性检查。
• 代码审查: 开启“背景”或“前景”模式，在代码审查过程中快速辨识颜色使用，提高审查效率。
• 多语言开发环境: 不仅限于CSS，对于支持 documentColor 的所有语言，比如 Dart 或其他现代前端技术栈，都能享受到同样便利的色彩管理体验。

典型生态项目

虽然本插件自身是一个专注于色彩展示的工具，但它在 Neovim 生态系统中常与其他LSP配置、代码格式化工具（如 stylua, prettier）、以及自动化工作流工具（例如 Git 集成、自动保存触发编译等）搭配使用，共同构建高效、视觉友好的开发环境。结合如 nvim-tree、coc.nvim 等流行插件，可进一步提升 Neovim 的综合开发体验。

记得，随着 LSP 和 Neovim 社区的发展，持续更新相关的配置和插件，保持与生态系统同步，以获得最佳的开发体验。

document-color.nvim🌈 LSP-based colorizer for neovim项目地址:https://gitcode.com/gh_mirrors/do/document-color.nvim