doc(core): Updated type definitions

Author: OXY2DEV

lua/definitions/bars.lua

@@ -1,3 +1,5 @@
+---@meta
+
 --- Primary configuration table.
 ---@class bars.config
 ---
@@ -8,8 +10,8 @@
 --- opening Neovim or new windows.
 ---@field global? boolean
 ---
----@field statusline? statusline.config Statusline configuration.
----@field statuscolumn? statuscolumn.config Statuscolumn configuration.
----@field winbar? winbar.config Winbar configuration.
+---@field statusline? boolean | statusline.config Statusline configuration.
+---@field statuscolumn? boolean | statuscolumn.config Statuscolumn configuration.
+---@field winbar? boolean | winbar.config Winbar configuration.
 ---
----@field tabline? tabline.config Tabline configuration.
+---@field tabline? boolean | tabline.config Tabline configuration.

lua/definitions/statuscolumn.lua

@@ -6,6 +6,10 @@
 --- Is the module enabled?
 ---@field enable boolean
 ---
+--- State for attached windows,
+---   true -> Enabled(should be rendered).
+---   false -> Attached but disabled.
+---
 ---@field attached_windows table<integer, boolean>
 
 -----------------------------------------------------------------------------
@@ -28,6 +32,7 @@
 --- Configuration style.
 ---@field [string] statuscolumn.style
 
+
 --- A configuration style.
 --- Must have a condition(unless `default`)
 --- and a list of parts.
@@ -38,12 +43,14 @@
 --- Parts for this style.
 ---@field parts statuscolumn_part[]
 
+
 ---@alias statuscolumn_part
 ---| statuscolumn.parts.lnum Line number.
 ---| statuscolumn.parts.folds Fold column.
 ---| statuscolumn.parts.signs Sign column.
 ---| statuscolumn.parts.empty An empty column.
 ---| statuscolumn.parts.border A statuscolumn border. 
+---| statuscolumn.parts.custom
 
 -----------------------------------------------------------------------------
 
@@ -53,7 +60,8 @@
 --- Condition for this component.
 ---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
 ---
----@field kind "lnum" What kind of part is this?
+--- What kind of part is this?
+---@field kind "lnum"
 ---
 ---@field click? boolean | fun(buffer: integer, window: integer, statuscolumn: string): boolean
 ---
@@ -105,7 +113,7 @@
 --- Condition for this component.
 ---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "border"
 ---
 --- Text to use for the border.
@@ -123,7 +131,7 @@
 --- Condition for this component.
 ---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "folds"
 ---
 --- Text to show for closed fold.
@@ -188,7 +196,7 @@
 --- Condition for this component.
 ---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "signs"
 ---
 --- Filter for signs.
@@ -200,4 +208,16 @@
 ---@field hl? string
 
 
+--- Custom part for the statuscolumn.
+---@class statuscolumn.parts.custom
+---
+--- Condition for this component.
+---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean
+---
+--- What kind of part is this?
+---@field kind "custom"
+---
+--- Text to render.
+---@field value string | fun(buffer: integer, window: integer, statuscolumn: string): string
+
 

lua/definitions/statusline.lua

@@ -7,7 +7,9 @@
 --- Should we attach to new windows?
 ---@field enable boolean
 ---
---- List of attached windows.
+--- State of attached windows.
+---   true -> Attached & rendering.
+---   false -> Attached only.
 ---@field attached_windows table<integer, boolean>
 
 -----------------------------------------------------------------------------
@@ -37,16 +39,17 @@
 ---| statusline.parts.diagnostics
 ---| statusline.parts.branch
 ---| statusline.parts.bufname
+---| statusline.parts.custom
 
 -----------------------------------------------------------------------------
 
 --- Shows current git branch.
 ---@class statusline.parts.branch
 ---
---- Optional condition for this component.
+--- Optional condition for this part.
 ---@field condition? boolean | fun(buffer: integer, window: integer): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "branch"
 ---
 --- Delay(in milliseconds) between branch
@@ -61,7 +64,7 @@
 ---@field [string] branch.opts
 
 
---- Git branch component options.
+--- Git branch part options.
 --- Drawn like so,
 ---
 ---```txt
@@ -100,10 +103,10 @@
 --- Shows buffer name.
 ---@class statusline.parts.bufname
 ---
---- Optional condition for this component.
+--- Optional condition for this part.
 ---@field condition? boolean | fun(buffer: integer, window: integer): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "bufname"
 ---
 --- Maximum name length.
@@ -116,7 +119,7 @@
 ---@field [string] bufname.opts
 
 
---- Buffer name component options.
+--- Buffer name part options.
 --- Drawn like so,
 ---
 ---```txt
@@ -161,15 +164,15 @@
 --- Shows diagnostics count.
 ---@class statusline.parts.diagnostics
 ---
---- Optional condition for this component.
+--- Optional condition for this part.
 ---@field condition? boolean | fun(buffer: integer, window: integer): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "diagnostics"
 ---
---- Should this component be automatically hidden?
+--- Should this part be automatically hidden?
 ---
---- > This component gets hidden if a buffer has
+--- > This part gets hidden if a buffer has
 --- > no client attached to it.
 ---@field auto_hide? boolean
 ---
@@ -211,48 +214,48 @@
 --- Highlight group for the separator.
 ---@field separator_hl? string
 ---
---- Left corner of the component. 
+--- Left corner of the part. 
 ---@field corner_left? string
 ---@field corner_left_hl? string
 ---
---- Left padding of the component. 
+--- Left padding of the part. 
 ---@field padding_left? string
 ---@field padding_left_hl? string
 ---
---- Right padding of the component. 
+--- Right padding of the part. 
 ---@field padding_right? string
 ---@field padding_right_hl? string
 ---
---- Right corner of the component. 
+--- Right corner of the part. 
 ---@field corner_right? string
 ---@field corner_right_hl? string
 ---
---- Primary highlight group for the component
+--- Primary highlight group for the part
 ---@field hl? string
 
 -----------------------------------------------------------------------------
 
 --- Empty space.
 ---@class statusline.parts.empty
 ---
---- Optional condition for this component.
+--- Optional condition for this part.
 ---@field condition? boolean | fun(buffer: integer, window: integer): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "empty"
 ---
---- Highlight group for this component.
+--- Highlight group for this part.
 ---@field hl? string
 
 -----------------------------------------------------------------------------
 
 --- Shows current mode.
 ---@class statusline.parts.mode
 ---
---- Optional condition for this component.
+--- Optional condition for this part.
 ---@field condition? boolean | fun(buffer: integer, window: integer): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "mode"
 ---
 --- Should we show a compact version?
@@ -262,7 +265,7 @@
 ---@field [string] mode.opts
 
 
---- Mode name component options.
+--- Mode name part options.
 --- Drawn like so,
 ---
 ---```txt
@@ -311,10 +314,10 @@
 --- └ corner_left
 ---@class statusline.parts.section
 ---
---- Condition for this component.
+--- Condition for this part.
 ---@field condition? fun(buffer: integer, window: integer): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind? "section"
 ---
 --- Reference to a click handler.
@@ -346,10 +349,10 @@
 --- Custom ruler.
 ---@class statusline.parts.ruler
 ---
---- Optional condition for this component.
+--- Optional condition for this part.
 ---@field condition? boolean | fun(buffer: integer, window: integer): boolean
 ---
---- What kind of component is this?
+--- What kind of part is this?
 ---@field kind "ruler"
 ---
 --- Should visual modes be shown
@@ -365,7 +368,7 @@
 ---@field visual ruler.opts
 
 
---- Ruler component options.
+--- Ruler part options.
 --- Drawn like so,
 ---
 ---```txt
@@ -402,3 +405,16 @@
 --- Primary highlight group.
 ---@field hl? string
 
+
+--- Custom statusline part.
+---@class statusline.parts.custom
+---
+--- Optional condition for this part.
+---@field condition? boolean | fun(buffer: integer, window: integer): boolean
+---
+--- What kind of part is this?
+---@field kind "ruler"
+---
+--- Text to show for this part.
+---@field value fun(buffer: integer, window: integer): string
+