feat(plugins): replace local-highlight with mini.cursorword

Author: charliie-dev

lua/modules/configs/editor/cursorword.lua

@@ -0,0 +1,7 @@
+return function()
+	require("mini.cursorword").setup({
+		-- Delay (in ms) between when cursor moved and when highlighting appeared
+		delay = 200,
+	})
+	require("modules.utils").gen_cursorword_hl()
+end

lua/modules/configs/editor/local-highlight.lua

@@ -41,7 +41,6 @@ return function()
 			gitsigns = true,
 			grug_far = true,
 			hop = false,
-			illuminate = true,
 			indent_blankline = { enabled = true, colored_indent_levels = true },
 			lsp_saga = true,
 			lsp_trouble = true,

lua/modules/configs/ui/catppuccin.lua

@@ -36,6 +36,11 @@ editor["echasnovski/mini.align"] = {
 	event = { "CursorHold", "CursorHoldI" },
 	config = require("editor.align"),
 }
+editor["echasnovski/mini.cursorword"] = {
+	lazy = true,
+	event = { "BufReadPost", "BufAdd", "BufNewFile" },
+	config = require("editor.cursorword"),
+}
 editor["echasnovski/mini.surround"] = {
 	lazy = true,
 	event = { "CursorHold", "CursorHoldI" },
@@ -83,11 +88,6 @@ editor["romainl/vim-cool"] = {
 	lazy = true,
 	event = { "CursorMoved", "InsertEnter" },
 }
-editor["tzachar/local-highlight.nvim"] = {
-	lazy = true,
-	event = { "BufReadPost", "BufAdd", "BufNewFile" },
-	config = require("editor.local-highlight"),
-}
 editor["brenoprata10/nvim-highlight-colors"] = {
 	lazy = true,
 	event = { "CursorHold", "CursorHoldI" },

lua/modules/plugins/editor.lua

@@ -104,7 +104,7 @@ end
 -- NOTE: If the active colorscheme isn't `catppuccin`, this function won't overwrite existing definitions
 ---Sets a global highlight group.
 ---@param name string @Highlight group name, e.g. "ErrorMsg"
----@param foreground string @The foreground color
+---@param foreground? string @The foreground color
 ---@param background? string @The background color
 ---@param italic? boolean
 local function set_global_hl(name, foreground, background, italic)
@@ -134,6 +134,24 @@ function M.blend(foreground, background, alpha)
 	return string.format("#%02x%02x%02x", blend_channel(1), blend_channel(2), blend_channel(3))
 end
 
+---Darken a color by blending it with the background color.
+---@param hex string @The color in hex to darken
+---@param amount number @The amount to darken the color
+---@param bg string @The background color to blend with
+---@return string @The darkened color as a hex string
+function M.darken(hex, amount, bg)
+	return M.blend(hex, bg or "#000000", math.abs(amount))
+end
+
+---Lighten a color by blending it with the foreground color.
+---@param hex string @The color in hex to lighten
+---@param amount number @The amount to lighten the color
+---@param fg string @The foreground color to blend with
+---@return string @The lightened color as a hex string
+function M.lighten(hex, amount, fg)
+	return M.blend(hex, fg or "#FFFFFF", math.abs(amount))
+end
+
 ---Get RGB highlight by highlight group
 ---@param hl_group string @Highlight group name
 ---@param use_bg boolean @Returns background or not
@@ -170,6 +188,7 @@ function M.extend_hl(name, def)
 	local current_def = vim.api.nvim_get_hl(0, { name = name, link = false })
 	local combined_def = vim.tbl_deep_extend("force", current_def, def)
 
+	---@diagnostic disable-next-line: param-type-mismatch
 	vim.api.nvim_set_hl(0, name, combined_def)
 end
 
@@ -239,6 +258,15 @@ function M.gen_alpha_hl()
 	set_global_hl("AlphaFooter", colors.yellow)
 end
 
+-- Generate highlight groups for cursorword. Existing attributes will NOT be overwritten
+function M.gen_cursorword_hl()
+	local colors = M.get_palette()
+
+	-- Do not highlight `MiniCursorwordCurrent`
+	set_global_hl("MiniCursorword", nil, M.darken(colors.surface1, 0.7, colors.base))
+	set_global_hl("MiniCursorwordCurrent", nil)
+end
+
 ---Convert number (0/1) to boolean
 ---@param value number @The value to check
 ---@return boolean|nil @Returns nil if failed