Skip to content

Commit 226c20d

Browse files
committed
fix: rename annotation types
Signed-off-by: Guennadi Maximov C <g.maxc.fox@protonmail.com>
1 parent f398b60 commit 226c20d

3 files changed

Lines changed: 20 additions & 20 deletions

File tree

lua/boolean-toggle.lua

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ local Config = require('boolean-toggle.config')
44
local valid_chars = Util.dedup(vim.split('aeflrstuAEFLRSTU', '', { trimempty = false }))
55
local delim = vim.split([[.,'"()[]{}$#?!:;%%^%*@-_+=\\|/<>~ ]], '', { trimempty = false })
66

7-
---@enum BooleanNvim.ConvertToFalse
7+
---@enum BooleanToggle.ConvertToFalse
88
local convert_to_false = {
99
['true'] = 'false',
1010
True = 'False',
1111
TRUE = 'FALSE',
1212
}
1313

14-
---@enum BooleanNvim.ConvertToTrue
14+
---@enum BooleanToggle.ConvertToTrue
1515
local convert_to_true = {
1616
['false'] = 'true',
1717
False = 'True',
1818
FALSE = 'TRUE',
1919
}
2020

21-
---@enum BooleanNvim.Convert
21+
---@enum BooleanToggle.Convert
2222
local convert = {
2323
['true'] = 'false',
2424
['false'] = 'true',
@@ -55,10 +55,10 @@ local function get_boolean_surround(line, start_col, end_col)
5555
return line:sub(1, start_col - 1), line:sub(end_col + 1, line:len())
5656
end
5757

58-
---@class BooleanNvim
58+
---@class BooleanToggle
5959
local M = {}
6060

61-
---@param opts? BooleanNvimOpts
61+
---@param opts? BooleanToggleOpts
6262
function M.setup(opts)
6363
Util.validate({ opts = { opts, { 'table', 'nil' }, true } })
6464

lua/boolean-toggle/config.lua

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
local Util = require('boolean-toggle.util')
22

3-
---@class BooleanNvimOpts.Keymaps
3+
---@class BooleanToggleOpts.Keymaps
44
---@field to_false? string|nil
55
---@field to_true? string|nil
66
---@field toggle? string|nil
77

8-
---@class BooleanNvimDefaults.Keymaps: BooleanNvimOpts.Keymaps
8+
---@class BooleanToggleDefaults.Keymaps: BooleanToggleOpts.Keymaps
99
---@field to_false string|nil
1010
---@field to_true string|nil
1111
---@field toggle string|nil
1212

13-
---@class BooleanNvimOpts
13+
---@class BooleanToggleOpts
1414
---@field auto_write? boolean
15-
---@field keymaps? BooleanNvimOpts.Keymaps|nil
15+
---@field keymaps? BooleanToggleOpts.Keymaps|nil
1616

17-
---@class BooleanNvimDefaults: BooleanNvimOpts
17+
---@class BooleanToggleDefaults: BooleanToggleOpts
1818
---@field auto_write boolean
19-
---@field keymaps BooleanNvimDefaults.Keymaps
19+
---@field keymaps BooleanToggleDefaults.Keymaps
2020

21-
---@class BooleanNvim.Config
22-
---@field config BooleanNvimDefaults
21+
---@class BooleanToggle.Config
22+
---@field config BooleanToggleDefaults
2323
local M = {}
2424

25-
---@return BooleanNvimDefaults defaults
25+
---@return BooleanToggleDefaults defaults
2626
function M.get_defaults()
27-
return { ---@type BooleanNvimDefaults
27+
return { ---@type BooleanToggleDefaults
2828
auto_write = false,
2929
keymaps = { toggle = nil, to_false = nil, to_true = nil },
3030
}
3131
end
3232

33-
---@param opts? BooleanNvimOpts
33+
---@param opts? BooleanToggleOpts
3434
function M.setup(opts)
3535
Util.validate({ opts = { opts, { 'table', 'nil' }, true } })
3636

lua/boolean-toggle/util.lua

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---Non-legacy validation spec (>=v0.11)
2-
---@class BooleanNvim.ValidateSpec
2+
---@class BooleanToggle.ValidateSpec
33
---@field [1] any
44
---@field [2] vim.validate.Validator
55
---@field [3]? boolean
66
---@field [4]? string
77

8-
---@class BooleanNvim.Util
8+
---@class BooleanToggle.Util
99
local M = {}
1010

1111
---Checks whether nvim is running on Windows.
@@ -57,7 +57,7 @@ end
5757

5858
---Dynamic `vim.validate()` wrapper which covers both legacy and newer implementations.
5959
--- ---
60-
---@param T table<string, vim.validate.Spec|BooleanNvim.ValidateSpec>
60+
---@param T table<string, vim.validate.Spec|BooleanToggle.ValidateSpec>
6161
function M.validate(T)
6262
local max = vim.fn.has('nvim-0.11') == 1 and 4 or 3
6363
for name, spec in pairs(T) do
@@ -68,7 +68,7 @@ function M.validate(T)
6868
end
6969

7070
if max == 4 then
71-
---@cast T table<string, BooleanNvim.ValidateSpec>
71+
---@cast T table<string, BooleanToggle.ValidateSpec>
7272
vim.validate(T)
7373
return
7474
end

0 commit comments

Comments
 (0)