feat!: rplugin & telescope extension

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -29,6 +29,7 @@ It currently provides the following features:
 - Class concealing
 - Class sorting (without [prettier-plugin](https://github.com/tailwindlabs/prettier-plugin-tailwindcss))
 - Completion utilities (using [nvim-cmp](https://github.com/hrsh7th/nvim-cmp))
+- Class previewier (using [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim))
 - Class motions
 
 > [!NOTE]
@@ -39,6 +40,7 @@ It currently provides the following features:
 - Neovim v0.9 or higher (v0.10 is recommended)
 - [tailwindcss-language-server](https://github.com/tailwindlabs/tailwindcss-intellisense/tree/master/packages/tailwindcss-language-server) >= `v0.0.14` (can be installed using [Mason](https://github.com/williamboman/mason.nvim))
 - `html`, `css`, `tsx` and other language Treesitter grammars (using [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter))
+- Neovim [node-client](https://www.npmjs.com/package/neovim) (using npm)
 
 > [!TIP]
 > If you are not familiar with neovim LSP ecosystem check out [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig) to learn how to setup the LSP.
@@ -51,12 +53,14 @@ Using [lazy.nvim](https://github.com/folke/lazy.nvim):
 -- tailwind-tools.lua
 return {
   "luckasRanarison/tailwind-tools.nvim",
+  name = "tailwind-tools",
+  build = ":UpdateRemotePlugins",
   dependencies = { "nvim-treesitter/nvim-treesitter" },
   opts = {} -- your configuration
 }
 ```
 
-If you are using other package managers you need to call `setup`:
+If you are using other package managers you need register the remote plugin by running the `:UpdateRemotePlugins` command, then call `setup` to enable the lua plugin:
 
 ```lua
 require("tailwind-tools").setup({
@@ -88,6 +92,12 @@ Here is the default configuration:
       fg = "#38BDF8",
     },
   },
+  telescope = {
+    utilities = {
+      -- the function used when selecting an utility class in telescope
+      callback = function(name, class) end,
+    },
+  },
   -- see the extension section to learn more
   extension = {
     queries = {}, -- a list of filetypes having custom `class` queries
@@ -117,6 +127,8 @@ Available commands:
 
 ## Utilities
 
+### nvim-cmp
+
 Utility function for highlighting colors in [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) using [lspkind.nvim](https://github.com/onsails/lspkind.nvim):
 
 ```lua
@@ -144,6 +156,14 @@ return {
 > [!TIP]
 > You can extend it by calling the function and get the returned `vim_item`, see the nvim-cmp [wiki](https://github.com/hrsh7th/nvim-cmp/wiki/Menu-Appearance) to learn more.
 
+### telescope.nvim
+
+The plugins registers by default a telescope extension that you can call using `:Telescope tailwind <subcommand>`
+
+Available subcommands:
+
+- `utilities`: Lists all utility classes available in the current projects.
+
 ## Extension
 
 The plugin already supports many languages, but requests for additional language support and PRs are welcome. You can also extend the language support in your configuration by using Treesitter queries or Lua patterns (or both).
@@ -186,7 +206,7 @@ The `class.scm` file should contain a query used to extract the class values for
     (attribute_value) @tailwind))
 ```
 
-Note that quantified captures (using `+` or `?`) cannot be captured using `@tailwind`. Instead, you must capture the parent node using `@ŧailwind.inner`.
+Note that quantified captures (using `+` or `?`) cannot be captured using `@tailwind`. Instead, you must capture the parent node using `@tailwind.inner`.
 
 ```scheme
 (arguments

lua/tailwind-tools/cmp.lua

@@ -11,16 +11,9 @@ M.lspkind_format = function(entry, vim_item)
 
   if vim_item.kind == "Color" and doc then
     local content = type(doc) == "string" and doc or doc.value
-    local base, _, _, _r, _g, _b = 10, content:find("rgba?%((%d+), (%d+), (%d+)")
+    local r, g, b = utils.extract_color(content)
 
-    if not _r then
-      base, _, _, _r, _g, _b = 16, content:find("#(%x%x)(%x%x)(%x%x)")
-    end
-
-    if _r then
-      local r, g, b = tonumber(_r, base), tonumber(_g, base), tonumber(_b, base)
-      vim_item.kind_hl_group = utils.set_hl_from(r, g, b, "foreground")
-    end
+    if r then vim_item.kind_hl_group = utils.set_hl_from(r, g, b, "foreground") end
   end
 
   return vim_item

lua/tailwind-tools/config.lua

@@ -1,3 +1,5 @@
+---@diagnostic disable: unused-local
+
 local M = {}
 
 ---@alias TailwindTools.ColorHint "foreground" | "background" | "inline"
@@ -19,6 +21,11 @@ M.options = {
       fg = "#38BDF8",
     },
   },
+  telescope = {
+    utilities = {
+      callback = function(_name, _css) end,
+    },
+  },
   extension = {
     queries = {},
     patterns = {},

lua/tailwind-tools/init.lua

@@ -52,6 +52,9 @@ M.setup = function(options)
       if state.conceal.enabled then conceal.enable() end
     end,
   })
+
+  local has_telescope, telescope = pcall(require, "telescope")
+  if has_telescope then telescope.load_extension("tailwind") end
 end
 
 return M

lua/tailwind-tools/utils.lua

@@ -24,4 +24,15 @@ M.set_hl_from = function(red, green, blue, style)
   return group
 end
 
+---@param s string
+M.extract_color = function(s)
+  local base, _, _, _r, _g, _b = 10, s:find("rgba?%((%d+), (%d+), (%d+)")
+
+  if not _r then
+    base, _, _, _r, _g, _b = 16, s:find("#(%x%x)(%x%x)(%x%x)")
+  end
+
+  if _r then return tonumber(_r, base), tonumber(_g, base), tonumber(_b, base) end
+end
+
 return M

lua/telescope/_extensions/tailwind.lua

@@ -0,0 +1,103 @@
+local log = require("tailwind-tools.log")
+local utils = require("tailwind-tools.utils")
+local plugin_config = require("tailwind-tools.config")
+
+local actions = require("telescope.actions")
+local action_state = require("telescope.actions.state")
+local finders = require("telescope.finders")
+local pickers = require("telescope.pickers")
+local previewers = require("telescope.previewers")
+local entry_display = require("telescope.pickers.entry_display")
+local config = require("telescope.config").values
+
+---@class TailwindTools.ClassEntry
+---@field name string
+---@field value any
+
+local fg_prefixes = { "text", "border", "outline" }
+
+local function get_hl_kind(class_name)
+  for _, prefix in pairs(fg_prefixes) do
+    if vim.startswith(class_name, prefix) then return "foreground" end
+  end
+
+  return "background"
+end
+
+local function class_picker()
+  local classes = vim.fn.TailwindGetUtilities() --[[@as TailwindTools.ClassEntry[] | nil]]
+
+  if not classes then return log.error("No project found") end
+
+  local displayer = entry_display.create({
+    separator = "",
+    items = { { remaining = true } },
+  })
+
+  local finder = finders.new_table({
+    results = classes,
+    ---@param entry TailwindTools.ClassEntry
+    entry_maker = function(entry)
+      local highlight = "Normal"
+
+      if type(entry.value) == "string" then
+        local r, g, b = utils.extract_color(entry.value)
+        if r then
+          local kind = get_hl_kind(entry.name)
+          highlight = utils.set_hl_from(r, g, b, kind)
+        end
+      end
+
+      return {
+        value = entry,
+        display = function() return displayer({ { entry.name, highlight } }) end,
+        ordinal = entry.name,
+      }
+    end,
+  })
+
+  local previewer = previewers.new_buffer_previewer({
+    title = "Preview",
+    define_preview = function(self, entry)
+      local bufnr = self.state.bufnr
+      local css = vim.fn.TailwindExpandUtilities({ entry.value.name })
+
+      if type(css) == "string" then
+        vim.bo[bufnr].ft = "css"
+        vim.api.nvim_buf_set_text(bufnr, 0, -1, 0, -1, vim.split(css, "\n"))
+        entry.value.css = css
+      end
+    end,
+  })
+
+  local attach_mappings = function()
+    actions.select_default:replace(function(prompt_bufnr)
+      local selection = action_state.get_selected_entry()
+      local name = selection.value.name
+      local css = selection.value.css or ""
+
+      actions.close(prompt_bufnr)
+
+      plugin_config.options.telescope.utilities.callback(name, css)
+    end)
+
+    return true
+  end
+
+  pickers
+    .new({}, {
+      prompt_title = "Tailwind classes",
+      finder = finder,
+      sorter = config.generic_sorter(),
+      previewer = previewer,
+      attach_mappings = attach_mappings,
+    })
+    :find()
+end
+
+return require("telescope").register_extension({
+  setup = function() end,
+  exports = {
+    utilities = class_picker,
+  },
+})