diff --git a/home/.config/nvim/lua/plugins/asciidoc.lua b/home/.config/nvim/lua/plugins/asciidoc.lua index 7e4a139d..d723b3fc 100644 --- a/home/.config/nvim/lua/plugins/asciidoc.lua +++ b/home/.config/nvim/lua/plugins/asciidoc.lua @@ -1,11 +1,13 @@ -- AsciiDoc plugins are grouped together here return { -- Vim ♥️ Asciidoctor + --- @type LazyPluginSpec { "habamax/vim-asciidoctor", ft = { "asciidoctor", "asciidoc" }, }, -- AsciiDoc preview + --- @type LazyPluginSpec { "tigion/nvim-asciidoc-preview", ft = { "asciidoctor", "asciidoc" }, diff --git a/home/.config/nvim/lua/plugins/autopairs.lua b/home/.config/nvim/lua/plugins/autopairs.lua index f9886b56..cde6d85c 100644 --- a/home/.config/nvim/lua/plugins/autopairs.lua +++ b/home/.config/nvim/lua/plugins/autopairs.lua @@ -1,4 +1,5 @@ -- Automatic brackets +--- @type LazyPluginSpec return { "windwp/nvim-autopairs", config = true diff --git a/home/.config/nvim/lua/plugins/bufferline.lua b/home/.config/nvim/lua/plugins/bufferline.lua index f6b42c4c..815f79c3 100644 --- a/home/.config/nvim/lua/plugins/bufferline.lua +++ b/home/.config/nvim/lua/plugins/bufferline.lua @@ -1,8 +1,10 @@ +-- Bufferline +--- @type LazyPluginSpec return { "akinsho/bufferline.nvim", version = "*", dependencies = { "kyazdani42/nvim-web-devicons" }, - ---@type BufferlineConfig + --- @type BufferlineConfig opts = { options = { diagnostics = "nvim_lsp", diff --git a/home/.config/nvim/lua/plugins/caddyfile.lua b/home/.config/nvim/lua/plugins/caddyfile.lua index 89db6b59..ec4c5273 100644 --- a/home/.config/nvim/lua/plugins/caddyfile.lua +++ b/home/.config/nvim/lua/plugins/caddyfile.lua @@ -1,4 +1,5 @@ -- Caddyfile syntax support +--- @type LazyPluginSpec return { "isobit/vim-caddyfile", ft = "caddyfile", diff --git a/home/.config/nvim/lua/plugins/cmp.lua b/home/.config/nvim/lua/plugins/cmp.lua index 2eaf53b5..cfa81823 100644 --- a/home/.config/nvim/lua/plugins/cmp.lua +++ b/home/.config/nvim/lua/plugins/cmp.lua @@ -1,4 +1,5 @@ -- Autoompletion +--- @type LazyPluginSpec return { "hrsh7th/nvim-cmp", dependencies = { diff --git a/home/.config/nvim/lua/plugins/confirm-quit.lua b/home/.config/nvim/lua/plugins/confirm-quit.lua index 92173333..0c6302f7 100644 --- a/home/.config/nvim/lua/plugins/confirm-quit.lua +++ b/home/.config/nvim/lua/plugins/confirm-quit.lua @@ -1,3 +1,5 @@ +-- Confirm before quit +--- @type LazyPluginSpec return { "yutkat/confirm-quit.nvim", event = "CmdlineEnter", diff --git a/home/.config/nvim/lua/plugins/copilot.lua b/home/.config/nvim/lua/plugins/copilot.lua index e933120b..c1b6a3ed 100644 --- a/home/.config/nvim/lua/plugins/copilot.lua +++ b/home/.config/nvim/lua/plugins/copilot.lua @@ -1,4 +1,5 @@ -- GitHub Copilot +--- @type LazyPluginSpec return { "zbirenbaum/copilot.lua", opts = { diff --git a/home/.config/nvim/lua/plugins/dashboard.lua b/home/.config/nvim/lua/plugins/dashboard.lua index dab56e17..5aa8583b 100644 --- a/home/.config/nvim/lua/plugins/dashboard.lua +++ b/home/.config/nvim/lua/plugins/dashboard.lua @@ -1,4 +1,5 @@ -- Startup dashboard +--- @type LazyPluginSpec return { "glepnir/dashboard-nvim", event = "VimEnter", diff --git a/home/.config/nvim/lua/plugins/dropbar.lua b/home/.config/nvim/lua/plugins/dropbar.lua index 72a95171..228a2619 100644 --- a/home/.config/nvim/lua/plugins/dropbar.lua +++ b/home/.config/nvim/lua/plugins/dropbar.lua @@ -1,3 +1,5 @@ +-- Show the current LSP context in winbar +--- @type LazyPluginSpec return { "Bekaboo/dropbar.nvim", } diff --git a/home/.config/nvim/lua/plugins/firenvim.lua b/home/.config/nvim/lua/plugins/firenvim.lua index 507031e8..dba55753 100644 --- a/home/.config/nvim/lua/plugins/firenvim.lua +++ b/home/.config/nvim/lua/plugins/firenvim.lua @@ -1,4 +1,5 @@ -- Neovim inside Firefox +--- @type LazyPluginSpec return { "glacambre/firenvim", build = function() diff --git a/home/.config/nvim/lua/plugins/fugitive.lua b/home/.config/nvim/lua/plugins/fugitive.lua index 58030d28..24d58a49 100644 --- a/home/.config/nvim/lua/plugins/fugitive.lua +++ b/home/.config/nvim/lua/plugins/fugitive.lua @@ -1,2 +1,3 @@ -- Git commands +--- @type LazyPluginSpec return { "tpope/vim-fugitive" } diff --git a/home/.config/nvim/lua/plugins/gnupg.lua b/home/.config/nvim/lua/plugins/gnupg.lua index ec6d6346..4da3d9d8 100644 --- a/home/.config/nvim/lua/plugins/gnupg.lua +++ b/home/.config/nvim/lua/plugins/gnupg.lua @@ -1,4 +1,5 @@ -- Edit GPG encrypted files transparently +--- @type LazyPluginSpec return { "jamessan/vim-gnupg", ft = { "gpg" }, diff --git a/home/.config/nvim/lua/plugins/indent-blankline.lua b/home/.config/nvim/lua/plugins/indent-blankline.lua index 9aca163f..c9c0d2ad 100644 --- a/home/.config/nvim/lua/plugins/indent-blankline.lua +++ b/home/.config/nvim/lua/plugins/indent-blankline.lua @@ -1,7 +1,8 @@ -- Indent characters +--- @type LazyPluginSpec return { "lukas-reineke/indent-blankline.nvim", - ---@type ibl.config + --- @type ibl.config opts = { exclude = { filetypes = { diff --git a/home/.config/nvim/lua/plugins/kanagawa.lua b/home/.config/nvim/lua/plugins/kanagawa.lua index cba20994..1cc595ab 100644 --- a/home/.config/nvim/lua/plugins/kanagawa.lua +++ b/home/.config/nvim/lua/plugins/kanagawa.lua @@ -1,7 +1,8 @@ -- Colorscheme +--- @type LazyPluginSpec return { "rebelot/kanagawa.nvim", - ---@type KanagawaConfig + --- @type KanagawaConfig opts = { compile = true, dimInactive = true, @@ -46,6 +47,7 @@ return { } end, }, + --- @param opts KanagawaConfig config = function(_, opts) require("kanagawa").setup(opts) vim.cmd("colorscheme kanagawa") diff --git a/home/.config/nvim/lua/plugins/lualine.lua b/home/.config/nvim/lua/plugins/lualine.lua index 735d7938..895b9e87 100644 --- a/home/.config/nvim/lua/plugins/lualine.lua +++ b/home/.config/nvim/lua/plugins/lualine.lua @@ -1,4 +1,5 @@ -- Statusline +--- @type LazyPluginSpec return { "nvim-lualine/lualine.nvim", dependencies = { "kyazdani42/nvim-web-devicons" }, diff --git a/home/.config/nvim/lua/plugins/luasnip.lua b/home/.config/nvim/lua/plugins/luasnip.lua index ad186108..ade105cd 100644 --- a/home/.config/nvim/lua/plugins/luasnip.lua +++ b/home/.config/nvim/lua/plugins/luasnip.lua @@ -1,4 +1,5 @@ -- Snippets plugin +--- @type LazyPluginSpec return { "L3MON4D3/LuaSnip", -- Snippets collection diff --git a/home/.config/nvim/lua/plugins/markdown-preview.lua b/home/.config/nvim/lua/plugins/markdown-preview.lua index 2350979d..731496ab 100644 --- a/home/.config/nvim/lua/plugins/markdown-preview.lua +++ b/home/.config/nvim/lua/plugins/markdown-preview.lua @@ -1,4 +1,5 @@ -- Markdown preview +--- @type LazyPluginSpec return { "iamcco/markdown-preview.nvim", build = "cd app && yarn install", diff --git a/home/.config/nvim/lua/plugins/mason.lua b/home/.config/nvim/lua/plugins/mason.lua index 6e1cedf2..6ab9028b 100644 --- a/home/.config/nvim/lua/plugins/mason.lua +++ b/home/.config/nvim/lua/plugins/mason.lua @@ -1,5 +1,6 @@ -- Package manager for LSP servers, DAP adapters etc. -- It also handles starting all of my LSP servers +--- @type LazyPluginSpec return { "williamboman/mason.nvim", dependencies = { @@ -13,7 +14,7 @@ return { -- Neovim setup for init.lua and plugin development with full signature help, docs and completion for the nvim lua API. { "folke/neodev.nvim", - ---@type LuaDevOptions + --- @type LuaDevOptions opts = { override = function(root_dir, library) local dotfiles_path = tostring(vim.fn.expand("~/git/dotfiles")) diff --git a/home/.config/nvim/lua/plugins/mini.lua b/home/.config/nvim/lua/plugins/mini.lua index 6484a365..7482c037 100644 --- a/home/.config/nvim/lua/plugins/mini.lua +++ b/home/.config/nvim/lua/plugins/mini.lua @@ -1,4 +1,5 @@ -- Library of 30+ independent Lua modules improving overall Neovim +--- @type LazyPluginSpec return { "echasnovski/mini.nvim", version = "*", diff --git a/home/.config/nvim/lua/plugins/neoformat.lua b/home/.config/nvim/lua/plugins/neoformat.lua index cc63e231..1bdc479a 100644 --- a/home/.config/nvim/lua/plugins/neoformat.lua +++ b/home/.config/nvim/lua/plugins/neoformat.lua @@ -1,4 +1,5 @@ -- Formatter plugin +--- @type LazyPluginSpec return { "sbdchd/neoformat", keys = { diff --git a/home/.config/nvim/lua/plugins/noice.lua b/home/.config/nvim/lua/plugins/noice.lua index cf869a84..1de8aae2 100644 --- a/home/.config/nvim/lua/plugins/noice.lua +++ b/home/.config/nvim/lua/plugins/noice.lua @@ -1,10 +1,11 @@ -- Replace much of neovim's default UI -- with a modern replacement +--- @type LazyPluginSpec return { "folke/noice.nvim", event = "VeryLazy", dependencies = { "MunifTanjim/nui.nvim", "rcarriga/nvim-notify" }, - ---@type NoiceConfig + --- @type NoiceConfig opts = { lsp = { -- override markdown rendering so that **cmp** and other plugins use **Treesitter** diff --git a/home/.config/nvim/lua/plugins/nvim-colorizer.lua b/home/.config/nvim/lua/plugins/nvim-colorizer.lua index 05ac1448..ce3131d5 100644 --- a/home/.config/nvim/lua/plugins/nvim-colorizer.lua +++ b/home/.config/nvim/lua/plugins/nvim-colorizer.lua @@ -1,4 +1,5 @@ -- High performance color highlighter +--- @type LazyPluginSpec return { "norcalli/nvim-colorizer.lua", config = true, diff --git a/home/.config/nvim/lua/plugins/nvim-dap.lua b/home/.config/nvim/lua/plugins/nvim-dap.lua index 9e2fce70..04b8ec6b 100644 --- a/home/.config/nvim/lua/plugins/nvim-dap.lua +++ b/home/.config/nvim/lua/plugins/nvim-dap.lua @@ -1,3 +1,5 @@ +-- Debug adapter for NeoVim +--- @type LazyPluginSpec return { "mfussenegger/nvim-dap", config = function() diff --git a/home/.config/nvim/lua/plugins/nvim-tree.lua b/home/.config/nvim/lua/plugins/nvim-tree.lua index 8646ec40..bacd3a97 100644 --- a/home/.config/nvim/lua/plugins/nvim-tree.lua +++ b/home/.config/nvim/lua/plugins/nvim-tree.lua @@ -1,4 +1,5 @@ -- Tree explorer +--- @type LazyPluginSpec return { "kyazdani42/nvim-tree.lua", lazy = false, diff --git a/home/.config/nvim/lua/plugins/redact_pass.lua b/home/.config/nvim/lua/plugins/redact_pass.lua index 3ac5d314..984de136 100644 --- a/home/.config/nvim/lua/plugins/redact_pass.lua +++ b/home/.config/nvim/lua/plugins/redact_pass.lua @@ -1,4 +1,5 @@ -- Make editing passwords safer +--- @type LazyPluginSpec return { "https://git.zx2c4.com/password-store", config = function(plugin) diff --git a/home/.config/nvim/lua/plugins/statuscol.lua b/home/.config/nvim/lua/plugins/statuscol.lua index 05d010c2..38a75a5a 100644 --- a/home/.config/nvim/lua/plugins/statuscol.lua +++ b/home/.config/nvim/lua/plugins/statuscol.lua @@ -1,3 +1,5 @@ +-- Customize statuscolumn +--- @type LazyPluginSpec return { "luukvbaal/statuscol.nvim", dependencies = { diff --git a/home/.config/nvim/lua/plugins/suda.lua b/home/.config/nvim/lua/plugins/suda.lua index cb7a4b50..e02bd3ae 100644 --- a/home/.config/nvim/lua/plugins/suda.lua +++ b/home/.config/nvim/lua/plugins/suda.lua @@ -1,2 +1,3 @@ -- Do stuff as sudo +--- @type LazyPluginSpec return { "lambdalisue/suda.vim" } diff --git a/home/.config/nvim/lua/plugins/telescope.lua b/home/.config/nvim/lua/plugins/telescope.lua index 70d4dd67..bb55e171 100644 --- a/home/.config/nvim/lua/plugins/telescope.lua +++ b/home/.config/nvim/lua/plugins/telescope.lua @@ -1,3 +1,4 @@ +--- @type LazyPluginSpec return { "nvim-telescope/telescope.nvim", dependencies = { diff --git a/home/.config/nvim/lua/plugins/treesitter.lua b/home/.config/nvim/lua/plugins/treesitter.lua index 71c5d00a..9ce270d6 100644 --- a/home/.config/nvim/lua/plugins/treesitter.lua +++ b/home/.config/nvim/lua/plugins/treesitter.lua @@ -1,14 +1,15 @@ return { + -- Improved syntax highlighting, text objects and more + --- @type LazyPluginSpec { "nvim-treesitter/nvim-treesitter", build = ":TSUpdate", - init = function(plugin) + init = function() require("nvim-treesitter.install").update({ with_sync = true, }) end, - ---@type TSConfig - ---@diagnostic disable-next-line: missing-fields + --- @type TSConfig opts = { highlight = { enable = true }, indent = { enable = true }, @@ -70,10 +71,10 @@ return { }, }, }, - ---@param opts TSConfig + --- @param opts TSConfig config = function(_, opts) if type(opts.ensure_installed) == "table" then - ---@type table + --- @type table local added = {} opts.ensure_installed = vim.tbl_filter(function(lang) if added[lang] then @@ -91,13 +92,15 @@ return { config = function() -- When in diff mode, we want to use the default -- vim text objects c & C instead of the treesitter ones. - local move = require("nvim-treesitter.textobjects.move") ---@type table + --- @type table + local move = require("nvim-treesitter.textobjects.move") local configs = require("nvim-treesitter.configs") for name, fn in pairs(move) do if name:find("goto") == 1 then move[name] = function(q, ...) if vim.wo.diff then - local config = configs.get_module("textobjects.move")[name] ---@type table + --- @type table + local config = configs.get_module("textobjects.move")[name] for key, query in pairs(config or {}) do if q == query and key:find("[%]%[][cC]") then vim.cmd("normal! " .. key) @@ -115,8 +118,9 @@ return { }, -- Automatically add closing tags for HTML and JSX + --- @type LazyPluginSpec { "windwp/nvim-ts-autotag", - opts = {}, + config = true, }, } diff --git a/home/.config/nvim/lua/plugins/ufo.lua b/home/.config/nvim/lua/plugins/ufo.lua index 89eab7d1..eb756c63 100644 --- a/home/.config/nvim/lua/plugins/ufo.lua +++ b/home/.config/nvim/lua/plugins/ufo.lua @@ -1,13 +1,15 @@ -- Better folds +--- @type LazyPluginSpec return { "kevinhwang91/nvim-ufo", dependencies = { "kevinhwang91/promise-async" }, - ---@type UfoConfig + --- @type UfoConfig opts = { close_fold_kinds = { "imports", }, }, + --- @param opts UfoConfig config = function(_, opts) local ufo = require("ufo") ufo.setup(opts) diff --git a/home/.config/nvim/lua/plugins/which-key.lua b/home/.config/nvim/lua/plugins/which-key.lua index 51c22265..a3a5b9f6 100644 --- a/home/.config/nvim/lua/plugins/which-key.lua +++ b/home/.config/nvim/lua/plugins/which-key.lua @@ -1,6 +1,7 @@ -- Display possible keybinds -- Here I have also defined some generic keybinds -- Plugin specific keybinds are set up in plugin configuration file +--- @type LazyPluginSpec return { "folke/which-key.nvim", config = function()