feat(status): add virtual environment component

Author: mehalter

lua/astroui/status/component.lua

@@ -332,6 +332,19 @@ function M.lsp(opts)
   ))
 end
 
+--- A function to build a set of children components for a git branch section
+---@param opts? table options for configuring git branch and the overall padding
+---@return table # The Heirline component table
+-- @usage local heirline_component = require("astroui.status").component.git_branch()
+function M.virtual_env(opts)
+  opts = extend_tbl({
+    virtual_env = { icon = { kind = "Environment", padding = { right = 1 } } },
+    surround = { separator = "right", color = "virtual_env_bg", condition = condition.has_virtual_env },
+    hl = hl.get_attributes "virtual_env",
+  }, opts)
+  return M.builder(status_utils.setup_providers(opts, { "virtual_env" }))
+end
+
 --- A function to build a set of components for a foldcolumn section in a statuscolumn
 ---@param opts? table options for configuring foldcolumn and the overall padding
 ---@return table # The Heirline component table

lua/astroui/status/condition.lua

@@ -100,6 +100,11 @@ function M.has_filetype(bufnr)
   return vim.bo[bufnr or 0].filetype and vim.bo[bufnr or 0].filetype ~= ""
 end
 
+--- A condition function if a virtual environment is activated
+---@return boolean # whether or not virtual environment is activated
+-- @usage local heirline_component = { provider = "Example Provider", condition = require("astroui.status").condition.has_virtual_env }
+function M.has_virtual_env() return vim.env.VIRTUAL_ENV ~= nil end
+
 --- A condition function if Aerial is available
 ---@return boolean # whether or not aerial plugin is installed
 -- @usage local heirline_component = { provider = "Example Provider", condition = require("astroui.status").condition.aerial_available }

lua/astroui/status/provider.lua

@@ -503,6 +503,24 @@ function M.lsp_client_names(opts)
   end
 end
 
+--- A provider function for showing the current virtual environment name
+---@param opts table options passed to the stylize function
+---@return function # the function for outputting the virtual environment
+-- @usage local heirline_component = { provider = require("astroui.status").provider.virtual_env() }
+-- @see astroui.status.utils.stylize
+function M.virtual_env(opts)
+  opts = extend_tbl({ env_names = { "env", ".env", "venv", ".venv" } }, opts)
+  return function()
+    local venv = vim.env.VIRTUAL_ENV
+    if venv then
+      local path = vim.fn.split(venv, "/")
+      local venv_name = path[#path]
+      if #path > 1 and vim.tbl_contains(opts.env_names, venv_name) then venv_name = path[#path - 1] end
+      return status_utils.stylize(opts.format and opts.format:format(venv_name) or venv_name, opts)
+    end
+  end
+end
+
 --- A provider function for showing if treesitter is connected
 ---@param opts? table options passed to the stylize function
 ---@return function # function for outputting TS if treesitter is connected