feat(statuscolumn): Added filter support for signs

Signs can now be filtered to show only the signs you need!

doc(statuscolumn): Added missing component documentations

Author: OXY2DEV

lua/bars/components/statuscolumn.lua

@@ -302,13 +302,28 @@ scC.signs = function (buffer, _, config)
 	local _o = "  ";
 	local priority = -999;
 
+	---@type table<integer, string>
+	local ns_map = {};
+
+	for ns, id in pairs(vim.api.nvim_get_namespaces()) do
+		ns_map[id] = ns;
+	end
+
 	for _, sign in ipairs(extmarks) do
 		local sPR = sign[4].priority or 0;
+		---@diagnostic disable-next-line
+		local has_filter, pass = pcall(config.filter, buffer, ns_map, unpack(sign));
+
+		if has_filter == true and pass ~= true then
+			goto continue;
+		end
 
 		if sPR > priority and sign[4].sign_text then
 			_o = utils.set_hl(sign[4].sign_hl_group) .. utils.align("left", sign[4].sign_text, 2);
 			priority = sPR;
 		end
+
+	    ::continue::
 	end
 
 	return _o;
@@ -326,6 +341,13 @@ end
 scC.get = function (name, buffer, window, part_config, statuscolumn)
 	---|fS
 
+	--- Options that shouldn't be
+	--- evaluated.
+	---@type { [string]: string[] }
+	local eval_ignore = {
+		signs = { "filter" }
+	};
+
 	if type(name) ~= "string" then
 		--- Component doesn't exist.
 		return "";
@@ -353,6 +375,8 @@ scC.get = function (name, buffer, window, part_config, statuscolumn)
 		for key, value in pairs(static_config) do
 			if type(value) ~= "function" then
 				goto continue;
+			elseif vim.list_contains(eval_ignore[name] or {}, key) then
+				goto continue;
 			end
 
 			local s_success, s_val = pcall(value, buffer, window, statuscolumn);

lua/bars/statuscolumn.lua

@@ -16,7 +16,41 @@ statuscolumn.config = {
 			{
 				kind = "signs",
 				width = 1,
-				hl = "Normal"
+				hl = "Normal",
+
+				filter = function (buffer, namespaces, _, _, _, details)
+					---@type string
+					local mode = vim.api.nvim_get_mode().mode;
+					local name = namespaces[details.ns_id] or "";
+
+					if package.loaded["markview"] and vim.bo[buffer] == "markdown" then
+						--- On markdown files when on normal
+						--- mode only show markview signs.
+						if mode == "n" then
+							return string.match(name, "^markview");
+						else
+							return true;
+						end
+					elseif package.loaded["helpview"] and vim.bo[buffer].ft == "help" then
+						--- On help files when on normal
+						--- mode only show helpview signs.
+						if mode == "n" then
+							return string.match(name, "^helpview");
+						else
+							return true;
+						end
+					else
+						if mode == "n" then
+							--- On normal mode only show LSP signs.
+							return string.match(name, "^vim[%._]lsp") ~= nil;
+						elseif vim.list_contains({ "i", "v", "V", "" }, mode) then
+							--- On visual mode only show git signs.
+							return string.match(name, "^gitsigns") ~= nil;
+						end
+
+						return true;
+					end
+				end
 			},
 			{
 				kind = "folds",

lua/definitions/statuscolumn.lua

@@ -102,6 +102,9 @@
 --- Border for the statuscolumn.
 ---@class statuscolumn.parts.border
 ---
+--- Condition for this component.
+---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
+---
 --- What kind of component is this?
 ---@field kind "border"
 ---
@@ -117,6 +120,9 @@
 --- Fold column for the statuscolumn.
 ---@class statuscolumn.parts.folds
 ---
+--- Condition for this component.
+---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
+---
 --- What kind of component is this?
 ---@field kind "folds"
 ---
@@ -179,7 +185,18 @@
 
 ---@class statuscolumn.parts.signs
 ---
+--- Condition for this component.
+---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
+---
+--- What kind of component is this?
 ---@field kind "signs"
+---
+--- Filter for signs.
+---@field filter? fun(buffer: integer, ns_map: table<integer, string>, ns: integer, row: integer, col: integer, extmark: table): boolean
+---
+--- Highlight group for the signs.
+--- NOTE, This will overwrite the
+--- sign's original highlight group.
 ---@field hl? string