From 08228462094ee1c1c51e8e99bff9e39c59247801 Mon Sep 17 00:00:00 2001 From: Iron-E Date: Mon, 13 Mar 2023 14:12:28 -0400 Subject: [PATCH] docs: class namespaces follow directories --- lua/libmodal/init.lua | 6 +++-- lua/libmodal/src/Layer.lua | 5 +--- lua/libmodal/src/Mode.lua | 12 ++++----- lua/libmodal/src/collections/ParseTable.lua | 2 +- lua/libmodal/src/collections/Stack.lua | 6 +++-- lua/libmodal/src/init.lua | 18 ------------- lua/libmodal/src/utils/Help.lua | 1 + lua/libmodal/src/utils/Popup.lua | 28 ++++++++++----------- lua/libmodal/src/utils/api.lua | 2 +- 9 files changed, 31 insertions(+), 49 deletions(-) delete mode 100644 lua/libmodal/src/init.lua diff --git a/lua/libmodal/init.lua b/lua/libmodal/init.lua index 358ae53..b4e1abb 100644 --- a/lua/libmodal/init.lua +++ b/lua/libmodal/init.lua @@ -1,5 +1,5 @@ --- TODO: remove the __index here after a period of time to let people remove `libmodal.Layer` from their configurations -return setmetatable( +--- @class libmodal +local libmodal = setmetatable( { layer = { @@ -67,3 +67,5 @@ return setmetatable( end, } ) + +return libmodal diff --git a/lua/libmodal/src/Layer.lua b/lua/libmodal/src/Layer.lua index 2ac88d9..5909c72 100644 --- a/lua/libmodal/src/Layer.lua +++ b/lua/libmodal/src/Layer.lua @@ -1,8 +1,5 @@ ---- @type libmodal.globals local globals = require 'libmodal.src.globals' - ---- @type libmodal.utils -local utils = require 'libmodal.src.utils' +local utils = require 'libmodal.src.utils' --- @type libmodal.utils --- Normalizes a `buffer = true|false|0` argument into a number. --- @param buffer boolean|number the argument to normalize diff --git a/lua/libmodal/src/Mode.lua b/lua/libmodal/src/Mode.lua index 8842b49..049d1d6 100644 --- a/lua/libmodal/src/Mode.lua +++ b/lua/libmodal/src/Mode.lua @@ -1,5 +1,5 @@ -local globals = require 'libmodal.src.globals' --- @type libmodal.globals -local ParseTable = require 'libmodal.src.collections.ParseTable' --- @type libmodal.collections.ParseTable +local globals = require 'libmodal.src.globals' +local ParseTable = require 'libmodal.src.collections.ParseTable' local utils = require 'libmodal.src.utils' --- @type libmodal.utils --- @class libmodal.Mode @@ -214,18 +214,16 @@ function Mode.new(name, instruction, supress_exit) -- determine if a default `Help` should be created. if not self.instruction[HELP_CHAR] then - --- @diagnostic disable-next-line:param-type-mismatch we checked that `instruction` is a table above - self.help = utils.Help.new(self.instruction, 'KEY MAP') + self.help = utils.Help.new(instruction, 'KEY MAP') end self.input_bytes = {} -- build the parse tree. - --- @diagnostic disable-next-line:param-type-mismatch already checked `self.instruction` != `table` - self.mappings = ParseTable.new(self.instruction) + self.mappings = ParseTable.new(instruction) -- create a table for mode-specific data. - self.popups = require('libmodal.src.collections.Stack').new() + self.src.popups = require('libmodal.collections.Stack').new() -- create a variable for whether or not timeouts are enabled. self.timeouts = utils.Vars.new('timeouts', self.name) diff --git a/lua/libmodal/src/collections/ParseTable.lua b/lua/libmodal/src/collections/ParseTable.lua index ec24fe7..0fc0338 100644 --- a/lua/libmodal/src/collections/ParseTable.lua +++ b/lua/libmodal/src/collections/ParseTable.lua @@ -4,7 +4,7 @@ local utils = require('libmodal.src.utils') --- @type libmodal.utils local CR = utils.api.replace_termcodes(''):byte() --- @class libmodal.collections.ParseTable ---- @field CR number the byte representation of `` +--- @field CR integer the byte representation of `` local ParseTable = utils.classes.new {CR = CR} --- reverse the order of elements in some `list`. diff --git a/lua/libmodal/src/collections/Stack.lua b/lua/libmodal/src/collections/Stack.lua index 0211f4b..53a9663 100644 --- a/lua/libmodal/src/collections/Stack.lua +++ b/lua/libmodal/src/collections/Stack.lua @@ -1,7 +1,9 @@ ---- @class libmodal.collections.Stack +--- @class libmodal.collections.Stack +--- @field private [number] T local Stack = require('libmodal.src.utils.classes').new() ---- @return libmodal.collections.Stack +--- @generic T +--- @return libmodal.collections.Stack function Stack.new() return setmetatable({}, Stack) end diff --git a/lua/libmodal/src/init.lua b/lua/libmodal/src/init.lua deleted file mode 100644 index a6a9058..0000000 --- a/lua/libmodal/src/init.lua +++ /dev/null @@ -1,18 +0,0 @@ ---- @class libmodal ---- @field collections libmodal.collections ---- @field globals libmodal.globals ---- @field Layer libmodal.Layer ---- @field Mode libmodal.Mode ---- @field Prompt libmodal.Prompt ---- @field utils libmodal.utils -local libmodal = -{ - collections = require 'libmodal.src.collections', - globals = require 'libmodal.src.globals', - Layer = require 'libmodal.src.Layer', - Mode = require 'libmodal.src.Mode', - Prompt = require 'libmodal.src.Prompt', - utils = require 'libmodal.src.utils', -} - -return libmodal diff --git a/lua/libmodal/src/utils/Help.lua b/lua/libmodal/src/utils/Help.lua index f3d46f5..1eca193 100644 --- a/lua/libmodal/src/utils/Help.lua +++ b/lua/libmodal/src/utils/Help.lua @@ -1,4 +1,5 @@ --- @class libmodal.utils.Help +--- @field private [integer] string[] local Help = require('libmodal.src.utils.classes').new() --- align `tbl` according to the `longest_key_len`. diff --git a/lua/libmodal/src/utils/Popup.lua b/lua/libmodal/src/utils/Popup.lua index 6cd36df..798f4a8 100644 --- a/lua/libmodal/src/utils/Popup.lua +++ b/lua/libmodal/src/utils/Popup.lua @@ -1,7 +1,7 @@ --- @class libmodal.utils.Popup ---- @field private buffer number the number of the window which this popup is rendered on. +--- @field private buffer_number integer the number of the window which this popup is rendered on. --- @field private input_chars string[] the characters input by the user. ---- @field private window number the number of the window which this popup is rendered on. +--- @field private window_number integer the number of the window which this popup is rendered on. local Popup = require('libmodal.src.utils.classes').new() --- @param window number @@ -15,22 +15,22 @@ end --- @param keep_buffer boolean `self.buffer` is passed to `nvim_buf_delete` unless `keep_buffer` is `false` --- @return nil function Popup:close(keep_buffer) - if valid(self.window) then - vim.api.nvim_win_close(self.window, false) + if valid(self.window_number) then + vim.api.nvim_win_close(self.window_number, false) end - self.window = nil + self.window_number = nil if not keep_buffer then - vim.api.nvim_buf_delete(self.buffer, {force = true}) - self.buffer = nil + vim.api.nvim_buf_delete(self.buffer_number, {force = true}) + self.buffer_number = nil self.input_chars = nil end end --- @return libmodal.utils.Popup function Popup.new(config) - local self = setmetatable({buffer = vim.api.nvim_create_buf(false, true), input_chars = {}}, Popup) + local self = setmetatable({buffer_number = vim.api.nvim_create_buf(false, true), input_chars = {}}, Popup) self:open(config) return self end @@ -52,14 +52,14 @@ function Popup:open(config) } end - if valid(self.window) then + if valid(self.window_number) then self:close(true) end - self.window = vim.api.nvim_open_win(self.buffer, false, config) + self.window_number = vim.api.nvim_open_win(self.buffer_number, false, config) -- HACK: the window always pops up with the wrong width, but this makes it work :shrug: - vim.api.nvim_win_set_width(self.window, config.width) + vim.api.nvim_win_set_width(self.window_number, config.width) end --- display `input_bytes` in `self.buffer` @@ -78,14 +78,14 @@ function Popup:refresh(input_bytes) end end - vim.api.nvim_buf_set_lines(self.buffer, 0, 1, true, {table.concat(self.input_chars)}) + vim.api.nvim_buf_set_lines(self.buffer_number, 0, 1, true, {table.concat(self.input_chars)}) -- close and reopen the window if it was not already open. - if not valid(self.window) or vim.api.nvim_win_get_tabpage(self.window) ~= vim.api.nvim_get_current_tabpage() then + if not valid(self.window_number) or vim.api.nvim_win_get_tabpage(self.window_number) ~= vim.api.nvim_get_current_tabpage() then self:open() end - vim.api.nvim_win_set_width(self.window, #self.input_chars) + vim.api.nvim_win_set_width(self.window_number, #self.input_chars) end return Popup diff --git a/lua/libmodal/src/utils/api.lua b/lua/libmodal/src/utils/api.lua index 3e504ce..6553606 100644 --- a/lua/libmodal/src/utils/api.lua +++ b/lua/libmodal/src/utils/api.lua @@ -1,4 +1,4 @@ -local globals = require 'libmodal.src.globals' --- @type libmodal.globals +local globals = require 'libmodal.src.globals' --- @class libmodal.utils.api local api = {}