refactor: separate core type definitions by module

Author: kibi2

lua/tirenvi/core/attr.lua

@@ -9,10 +9,19 @@ local log = require("tirenvi.util.log") -- Util
 
 -- =============================================================================
 
+---@class Attr
+---@field range Range|nil
+---@field wrap_mode WrapMode|nil
+---@field fit_span integer
+---@field columns Attr_column[]
+---@field prefix string|nil
 local M = {}
 M.plain = {}
 M.grid = {}
 
+---@class Attr_column
+---@field width integer                 display width (logical column width)
+
 -- =============================================================================
 --#region Private
 

lua/tirenvi/core/block.lua

@@ -10,8 +10,25 @@ local log = require("tirenvi.util.log")
 
 -- =============================================================================
 
+---@alias Block
+---| Block_plain
+---| Block_grid
 local M = {}
+
+---@alias Block_kind
+---| "plain"
+---| "grid"
+
+---@class Block_plain
+---@field kind "plain"
+---@field attr Attr
+---@field records Record_plain[]
 M.plain = {}
+
+---@class Block_grid
+---@field kind "grid"
+---@field attr Attr
+---@field records Record_grid[]
 M.grid = {}
 
 -- =============================================================================

lua/tirenvi/core/blocks.lua

@@ -12,6 +12,7 @@ local log = require("tirenvi.util.log")
 
 -- =============================================================================
 
+---@alias Blocks Block[]
 local M = {}
 
 -- =============================================================================

lua/tirenvi/core/cell.lua

@@ -7,6 +7,7 @@ local log = require("tirenvi.util.log")
 
 -- =============================================================================
 
+---@alias Cell string
 local M = {}
 
 M.MIN_WIDTH = 2

lua/tirenvi/core/document.lua

@@ -17,59 +17,9 @@ local log = require("tirenvi.util.log")
 ---@field blocks Blocks
 local M = {}
 
----@alias Blocks Block[]
-
----@alias Block
----| Block_plain
----| Block_grid
-
----@alias Block_kind
----| "plain"
----| "grid"
-
----@class Block_plain
----@field kind "plain"
----@field attr Attr
----@field records Record_plain[]
-
----@class Block_grid
----@field kind "grid"
----@field attr Attr
----@field records Record_grid[]
-
----@class Attr_file
----@field kind "attr_file"
----@field version string
-
 ---@class Attr_doc
 ---@field allow_plain boolean
 
----@class Attr
----@field range Range|nil
----@field wrap_mode WrapMode|nil
----@field fit_span integer
----@field columns Attr_column[]
----@field prefix string|nil
-
----@class Attr_column
----@field width integer                 display width (logical column width)
-
----@alias Record Record_plain|Record_grid
-
----@class Record_plain
----@field kind "plain"
----@field line string
-
----@class Record_grid
----@field kind "grid"
----@field prefix string|nil
----@field row Cell[]
----@field _has_continuation? boolean    true if this record continues to the next row
-
----@alias Cell string
-
----@alias Ndjson Attr_file|Record
-
 -- =============================================================================
 --#region Private
 

lua/tirenvi/core/record.lua

@@ -6,8 +6,19 @@ local log = require("tirenvi.util.log") -- Util
 
 -- =============================================================================
 
+---@alias Record Record_plain|Record_grid
 local M = {}
+
+---@class Record_plain
+---@field kind "plain"
+---@field line string
 M.plain = {}
+
+---@class Record_grid
+---@field kind "grid"
+---@field prefix string|nil
+---@field row Cell[]
+---@field _has_continuation? boolean    true if this record continues to the next row
 M.grid = {}
 
 -- =============================================================================

lua/tirenvi/types.lua

@@ -13,3 +13,9 @@
 ---| "wrap_fit"
 ---| "wrap_width"
 ---| "plain"
+
+---@class Attr_file
+---@field kind "attr_file"
+---@field version string
+
+---@alias Ndjson Attr_file|Record