feat(statusline): allow 'fixing' the statusline bg color based on a h…

…l_group. Fixes #411
folke · May 30, 2024 · 986b44d · 986b44d
1 parent 325d681
commit 986b44d
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -393,7 +393,7 @@ require("trouble").first(opts)
 ---@return trouble.View
 require("trouble").focus(opts)
 
--- Fold close 
+-- Fold close
 ---@param opts? trouble.Mode | { new? : boolean } | string
 ---@return trouble.View
 require("trouble").fold_close(opts)
@@ -423,7 +423,7 @@ require("trouble").fold_enable(opts)
 ---@return trouble.View
 require("trouble").fold_more(opts)
 
--- Fold open 
+-- Fold open
 ---@param opts? trouble.Mode | { new? : boolean } | string
 ---@return trouble.View
 require("trouble").fold_open(opts)
@@ -443,7 +443,7 @@ require("trouble").fold_open_recursive(opts)
 ---@return trouble.View
 require("trouble").fold_reduce(opts)
 
--- Fold toggle 
+-- Fold toggle
 ---@param opts? trouble.Mode | { new? : boolean } | string
 ---@return trouble.View
 require("trouble").fold_toggle(opts)
@@ -583,6 +583,9 @@ Example for [lualine.nvim](https://github.com/nvim-lualine/lualine.nvim):
       title = false,
       filter = { range = true },
       format = "{kind_icon}{symbol.name:Normal}",
+      -- The following line is needed to fix the background color
+      -- Set it to the lualine section you want to use
+      hl_group = "lualine_c_normal",
     })
     table.insert(opts.sections.lualine_c, {
       symbols.get,
@@ -600,51 +603,51 @@ The table below shows all the highlight groups defined for Trouble.
 
 <!-- colors:start -->
 
-| Highlight Group | Default Group | Description |
-| --- | --- | --- |
-| **TroubleCount** | ***TabLineSel*** |  |
-| **TroubleDirectory** | ***Directory*** |  |
-| **TroubleFileName** | ***Directory*** |  |
-| **TroubleIconArray** | ***@punctuation.bracket*** |  |
-| **TroubleIconBoolean** | ***@boolean*** |  |
-| **TroubleIconClass** | ***@type*** |  |
-| **TroubleIconConstant** | ***@constant*** |  |
-| **TroubleIconConstructor** | ***@constructor*** |  |
-| **TroubleIconDirectory** | ***Special*** |  |
-| **TroubleIconEnum** | ***@lsp.type.enum*** |  |
-| **TroubleIconEnumMember** | ***@lsp.type.enumMember*** |  |
-| **TroubleIconEvent** | ***Special*** |  |
-| **TroubleIconField** | ***@variable.member*** |  |
-| **TroubleIconFile** | ***Normal*** |  |
-| **TroubleIconFunction** | ***@function*** |  |
-| **TroubleIconInterface** | ***@lsp.type.interface*** |  |
-| **TroubleIconKey** | ***@lsp.type.keyword*** |  |
-| **TroubleIconMethod** | ***@function.method*** |  |
-| **TroubleIconModule** | ***@module*** |  |
-| **TroubleIconNamespace** | ***@module*** |  |
-| **TroubleIconNull** | ***@constant.builtin*** |  |
-| **TroubleIconNumber** | ***@number*** |  |
-| **TroubleIconObject** | ***@constant*** |  |
-| **TroubleIconOperator** | ***@operator*** |  |
-| **TroubleIconPackage** | ***@module*** |  |
-| **TroubleIconProperty** | ***@property*** |  |
-| **TroubleIconString** | ***@string*** |  |
-| **TroubleIconStruct** | ***@lsp.type.struct*** |  |
-| **TroubleIconTypeParameter** | ***@lsp.type.typeParameter*** |  |
-| **TroubleIconVariable** | ***@variable*** |  |
-| **TroubleIndent** | ***LineNr*** |  |
-| **TroubleIndentFoldClosed** | ***CursorLineNr*** |  |
-| **TroubleIndentFoldOpen** | ***TroubleIndent*** |  |
-| **TroubleIndentLast** | ***TroubleIndent*** |  |
-| **TroubleIndentMiddle** | ***TroubleIndent*** |  |
-| **TroubleIndentTop** | ***TroubleIndent*** |  |
-| **TroubleIndentWs** | ***TroubleIndent*** |  |
-| **TroubleNormal** | ***NormalFloat*** |  |
-| **TroubleNormalNC** | ***NormalFloat*** |  |
-| **TroublePos** | ***LineNr*** |  |
-| **TroublePreview** | ***Visual*** |  |
-| **TroubleSource** | ***Comment*** |  |
-| **TroubleText** | ***Normal*** |  |
+| Highlight Group              | Default Group                 | Description |
+| ---------------------------- | ----------------------------- | ----------- |
+| **TroubleCount**             | **_TabLineSel_**              |             |
+| **TroubleDirectory**         | **_Directory_**               |             |
+| **TroubleFileName**          | **_Directory_**               |             |
+| **TroubleIconArray**         | **_@punctuation.bracket_**    |             |
+| **TroubleIconBoolean**       | **_@boolean_**                |             |
+| **TroubleIconClass**         | **_@type_**                   |             |
+| **TroubleIconConstant**      | **_@constant_**               |             |
+| **TroubleIconConstructor**   | **_@constructor_**            |             |
+| **TroubleIconDirectory**     | **_Special_**                 |             |
+| **TroubleIconEnum**          | **_@lsp.type.enum_**          |             |
+| **TroubleIconEnumMember**    | **_@lsp.type.enumMember_**    |             |
+| **TroubleIconEvent**         | **_Special_**                 |             |
+| **TroubleIconField**         | **_@variable.member_**        |             |
+| **TroubleIconFile**          | **_Normal_**                  |             |
+| **TroubleIconFunction**      | **_@function_**               |             |
+| **TroubleIconInterface**     | **_@lsp.type.interface_**     |             |
+| **TroubleIconKey**           | **_@lsp.type.keyword_**       |             |
+| **TroubleIconMethod**        | **_@function.method_**        |             |
+| **TroubleIconModule**        | **_@module_**                 |             |
+| **TroubleIconNamespace**     | **_@module_**                 |             |
+| **TroubleIconNull**          | **_@constant.builtin_**       |             |
+| **TroubleIconNumber**        | **_@number_**                 |             |
+| **TroubleIconObject**        | **_@constant_**               |             |
+| **TroubleIconOperator**      | **_@operator_**               |             |
+| **TroubleIconPackage**       | **_@module_**                 |             |
+| **TroubleIconProperty**      | **_@property_**               |             |
+| **TroubleIconString**        | **_@string_**                 |             |
+| **TroubleIconStruct**        | **_@lsp.type.struct_**        |             |
+| **TroubleIconTypeParameter** | **_@lsp.type.typeParameter_** |             |
+| **TroubleIconVariable**      | **_@variable_**               |             |
+| **TroubleIndent**            | **_LineNr_**                  |             |
+| **TroubleIndentFoldClosed**  | **_CursorLineNr_**            |             |
+| **TroubleIndentFoldOpen**    | **_TroubleIndent_**           |             |
+| **TroubleIndentLast**        | **_TroubleIndent_**           |             |
+| **TroubleIndentMiddle**      | **_TroubleIndent_**           |             |
+| **TroubleIndentTop**         | **_TroubleIndent_**           |             |
+| **TroubleIndentWs**          | **_TroubleIndent_**           |             |
+| **TroubleNormal**            | **_NormalFloat_**             |             |
+| **TroubleNormalNC**          | **_NormalFloat_**             |             |
+| **TroublePos**               | **_LineNr_**                  |             |
+| **TroublePreview**           | **_Visual_**                  |             |
+| **TroubleSource**            | **_Comment_**                 |             |
+| **TroubleText**              | **_Normal_**                  |             |
 
 <!-- colors:end -->
 

diff --git a/lua/trouble/api.lua b/lua/trouble/api.lua
@@ -125,7 +125,7 @@ end
 
 -- Renders a trouble list as a statusline component.
 -- Check the docs for examples.
----@param opts? trouble.Mode|string
+---@param opts? trouble.Mode|string|{hl_group?:string}
 ---@return {get: (fun():string), has: (fun():boolean)}
 function M.statusline(opts)
   local Spec = require("trouble.spec")
@@ -166,7 +166,10 @@ function M.statusline(opts)
       end
       renderer:clear()
       renderer:sections({ section })
-      status = "%#StatusLine#" .. renderer:statusline()
+      status = renderer:statusline()
+      if opts.hl_group then
+        status = require("trouble.config.highlights").fix_statusline(status, opts.hl_group)
+      end
       return status
     end,
   }

diff --git a/lua/trouble/config/highlights.lua b/lua/trouble/config/highlights.lua
@@ -83,4 +83,22 @@ function M.source(source, links)
   M.link(links, "Trouble" .. Util.camel(source))
 end
 
+M._fixed = {} ---@type table<string, string>
+---@param sl string
+function M.fix_statusline(sl, statusline_hl)
+  local bg = vim.api.nvim_get_hl(0, { name = statusline_hl, link = false })
+  bg = bg and bg.bg or nil
+
+  return sl:gsub("%%#(.-)#", function(hl)
+    if not M._fixed[hl] then
+      local opts = vim.api.nvim_get_hl(0, { name = hl, link = false }) or {}
+      opts.bg = bg
+      local group = "TroubleStatusline" .. vim.tbl_count(M._fixed)
+      vim.api.nvim_set_hl(0, group, opts)
+      M._fixed[hl] = group
+    end
+    return "%#" .. M._fixed[hl] .. "#"
+  end)
+end
+
 return M