feat(statusline): Added progress component

Author: OXY2DEV

lua/bars/components/statusline.lua

@@ -1,3 +1,5 @@
+---@diagnostic disable: undefined-field
+
 local slC = {};
 local utils = require("bars.utils");
 
@@ -244,6 +246,7 @@ slC.diagnostics = function (buffer, window, config)
 	config = config or {};
 
 	local diagnostics_count = vim.diagnostic.count(buffer);
+	---@diagnostic disable-next-line: deprecated
 	local clients = vim.fn.has("nvim-0.11") == 1 and vim.lsp.get_clients({ bufnr = buffer }) or vim.lsp.buf_get_clients(buffer);
 
 	if #clients == 0 and config.auto_hide == true then
@@ -490,6 +493,104 @@ slC.macro = function (_, _, config)
 	---|fE
 end
 
+--- Ruler.
+---@param buffer integer
+---@param window integer
+---@param config statusline.components.progress
+---@return string?
+slC.progress = function (buffer, window, config)
+	---|fS
+
+	---@type "start" | "progress" | "finish", "buffer" | "window"
+	local state, src;
+	local state_var = config.check or "progress_state";
+
+	if vim.w[window][state_var] then
+		state = vim.w[window][state_var];
+		src = "window";
+	elseif vim.b[buffer][state_var] then
+		state = vim.b[buffer][state_var];
+		src = "buffer";
+	else
+		return;
+	end
+
+	---@type "start" | "progress" | "finish", "buffer" | "window"
+	local last_frame = src == "buffer" and vim.b[buffer].__loader_last_frame or vim.w[window].__loader_last_frame;
+	last_frame = last_frame or 1;
+
+	---@type integer
+	local last_tick = src == "buffer" and vim.b[buffer].__loader_last_tick or vim.w[window].__loader_last_tick;
+	local now = vim.uv.hrtime() / 1e6; ---@diagnostic disable-line
+
+	--- Gets progress-bar state
+	---@param from? string[]
+	---@return string?
+	local function get_state (from)
+		---|fS
+
+		if not from or not vim.islist(from) then
+			return;
+		end
+
+		return from[last_frame] or from[#from] or "";
+
+		---|fE
+	end
+
+	--- Updates frame count.
+	---@param max integer
+	local function update_frame (max)
+		---|fS
+
+		if last_tick and now - last_tick < (config.update_delay or 250) then
+			-- Not enough time has passed.
+			return;
+		end
+
+		if src == "buffer" then
+			vim.b[buffer].__loader_last_tick = now;
+			vim.b[buffer].__loader_last_frame = last_frame + 1 > max and 1 or last_frame + 1;
+		else
+			vim.w[window].__loader_last_tick = now;
+			vim.w[window].__loader_last_frame = last_frame + 1 > max and 1 or last_frame + 1;
+		end
+
+		---|fE
+	end
+
+	local text, hl;
+
+	if state == "start" and config.start then
+		text = config.start;
+		hl = config.start_hl;
+
+		update_frame(1);
+	elseif state == "progress" then
+		text = get_state(config.progress);
+		hl = get_state(config.progress_hl);
+
+		update_frame(
+			vim.islist(config.progress) and #config.progress or 1
+		);
+	else
+		text = config.finish;
+		hl = config.finish_hl;
+
+		update_frame(1);
+	end
+
+	local output = text or "";
+
+	if type(hl) == "string" then
+		output = string.format("%%#%s#", hl) .. output;
+	end
+
+	return output;
+
+	---|fE
+end
+
 --- Custom section.
 ---@param config statusline.components.custom
 ---@return string

lua/definitions/statusline.lua

@@ -443,3 +443,26 @@
 --- Highlight group for exec icon.
 ---@field exec_hl? string
 
+-----------------------------------------------------------------------------
+
+---@class statusline.components.progress
+---
+--- Optional condition for this component.
+---@field condition? boolean | fun(buffer: integer, window: integer): boolean
+---
+--- What kind of component is this?
+---@field kind "progress"
+---
+---@field check? string The variable that holds the progress state, default is "progress_state".
+---
+---@field finish string Text used as the indicator for progress finish.
+---@field finish_hl string Highlight group for the progress finish indicator.
+---
+---@field progress string[] Text used as the indicator for progress.
+---@field progress_hl string[] Highlight group for the progress indicator.
+---
+---@field start string Text used as the indicator for progress start.
+---@field start_hl string Highlight group for the progress start indicator.
+---
+---@field update_delay? integer Delay in milliseconds between state updates.
+

plugin/bars.lua

@@ -1,3 +1,5 @@
+---@diagnostic disable: undefined-field
+
 --- Update the tab list when opening new windows.
 vim.api.nvim_create_autocmd({ "VimEnter" }, {
 	callback = function ()
@@ -180,17 +182,14 @@ vim.api.nvim_create_autocmd({ "ColorScheme" }, {
 	end
 });
 
-
--- ----------------------------------------------------------------------
+----------------------------------------------------------------------
 
 --- Custom completion for the `?` operator.
 ---@param before string
 ---@return string[]
 _G.__bars_comp = function (before)
 	---|fS
 
-	local bars = require("bars");
-
 	local tokens = vim.split(before, " ", { trimempty = true });
 	local modules = { "statusline", "statuscolumn", "tabline", "winbar" };
 	local _c = {};
@@ -318,9 +317,9 @@ end, {
 				return vim.list_contains(tokens, tostring(val)) == false and string.match(tostring(val), arg_lead) ~= nil;
 			end, vim.tbl_keys(module.state.attached_windows));
 
-			table.foreach(_c, function (key, value)
-				_c[key] = tostring(value);
-			end)
+			for k, v in pairs(_c) do
+				_c[k] = tostring(v);
+			end
 
 			table.sort(_c);
 			return _c;
@@ -330,3 +329,81 @@ end, {
 	end
 });
 
+----------------------------------------------------------------------
+
+vim.api.nvim_create_autocmd("LspProgress", {
+	callback = function (event)
+		---|fS
+
+		local kind = event.data.params.value.kind;
+		local attached = vim.lsp.get_buffers_by_client_id(event.data.client_id);
+
+		--- Sets buffer state
+		---@param state "start" | "progress" | "finish" | nil
+		local function set_state (state)
+			---|fS
+
+			for _, buf in ipairs(attached) do
+				vim.b[buf].lsp_loader_state = state;
+			end
+
+			---|fE
+		end
+
+		--- Gets the general state.
+		---@return "start" | "progress" | "finish" | nil
+		local function get_state ()
+			---|fS
+
+			local states = {};
+
+			for _, buf in ipairs(attached) do
+				table.insert(states, vim.b[buf].lsp_loader_state);
+			end
+
+			local state = states[1];
+
+			for _, item in ipairs(states) do
+				if item ~= state then
+					return nil;
+				end
+			end
+
+			return state;
+
+			---|fE
+		end
+
+		if kind == "begin" then
+			set_state("start");
+
+			local lsp_timer = vim.uv.new_timer();
+
+			lsp_timer:start(0, 200, vim.schedule_wrap(function ()
+				if get_state() == nil then
+					timer:stop();
+					return;
+				end
+
+				vim.api.nvim__redraw({ statusline = true });
+			end));
+
+			vim.api.nvim__redraw({ statusline = true });
+		elseif kind == "report" then
+			set_state("progress");
+		else
+			set_state("finish");
+
+			vim.defer_fn(function ()
+				if get_state() == "finish" then
+					set_state(nil);
+				end
+
+				vim.api.nvim__redraw({ statusline = true });
+			end, 500);
+		end
+
+		---|fE
+	end
+});
+