Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(lazy): add explicit types hints to all plugin spec tables #70

Merged
merged 1 commit into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lua/plugins/autopairs.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- nvim-autopairs | autopairs for neovim written by lua
-- https://github.com/windwp/nvim-autopairs

---@type LazyPluginSpec
return {
"windwp/nvim-autopairs",
event = { "InsertEnter" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/barbecue.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- barbecue.nvim | A VS Code like winbar for Neovim
-- https://github.com/utilyre/barbecue.nvim

---@type LazyPluginSpec
return {
"utilyre/barbecue.nvim",
name = "barbecue",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/cmp.lua
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ local format_source_labels = function(entry)
return source_labels[entry.source.name]
end

---@type LazyPluginSpec
return {
"hrsh7th/nvim-cmp",
event = { "InsertEnter", "CmdlineEnter" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/colorizer.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- colorizer.nvim | The fastest Neovim colorizer.
-- https://github.com/NvChad/nvim-colorizer.lua

---@type LazyPluginSpec
return {
"NvChad/nvim-colorizer.lua",
event = { "BufReadPost", "BufNewFile" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/colors/gruvbox.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Lua port of the most famous vim colorscheme
-- https://github.com/ellisonleao/gruvbox.nvim

---@type LazyPluginSpec
return {
"ellisonleao/gruvbox.nvim",
event = { "ColorSchemePre" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/colors/sakura.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Sakura.nvim | Nice color scheme for neovim
-- https://github.com/numToStr/Sakura.nvim

---@type LazyPluginSpec
return {
"numtostr/sakura.nvim",
event = { "ColorSchemePre" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/colors/tokyonight.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- tokyonight.nvim | A clean, dark Neovim theme written in Lua
-- https://github.com/folke/tokyonight.nvim

---@type LazyPluginSpec
return {
"folke/tokyonight.nvim",
event = { "ColorSchemePre" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/colors/vscode.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Neovim/Vim color scheme inspired by Dark+ and Light+
-- https://github.com/Mofiqul/vscode.nvim

---@type LazyPluginSpec
return {
"Mofiqul/vscode.nvim",
event = { "ColorSchemePre" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/comment.lua
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ local post_hook = function(ctx)
end
end

---@type LazyPluginSpec
return {
"numToStr/Comment.nvim",
event = { "BufReadPost", "BufNewFile" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/dap/init.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- nvim-dap | Debug Adapter Protocol client implementation for neovim
-- https://github.com/mfussenegger/nvim-dap

---@type LazyPluginSpec[]
return {
{ -- Debug adapter protocol client
"mfussenegger/nvim-dap",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/dashboard.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Dashboard.nvim | vim dashboard
-- https://github.com/glepnir/dashboard-nvim

---@type LazyPluginSpec
return {
"glepnir/dashboard-nvim",
event = "UIEnter",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/diffview.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Diffview.nvim | tabpage interface for easily cycling through diffs
-- https://github.com/sindrets/diffview.nvim

---@type LazyPluginSpec
return {
"sindrets/diffview.nvim",
cmd = { "DiffviewOpen", "DiffviewClose", "DiffviewToggleFiles", "DiffviewFocusFiles" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/fugitive.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- vim-fugitive | A Git wrapper so awesome, it should be illegal
-- https://github.com/tpope/vim-fugitive

---@type LazyPluginSpec
return {
"tpope/vim-fugitive",
event = "VeryLazy",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/git-conflict.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- git-conflict.nvim | Visualise and resolve merge conflicts in neovim
-- https://github.com/akinsho/git-conflict.nvim

---@type LazyPluginSpec
return {
"akinsho/git-conflict.nvim",
version = "*",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/gitsigns.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- gitsigns.nvim | Git integration for buffers
-- https://github.com/lewis6991/gitsigns.nvim

---@type LazyPluginSpec
return {
"lewis6991/gitsigns.nvim",
event = { "BufReadPost", "BufNewFile" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/guess-indent.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- guess-indent | Automatic indentation style detection for Neovim
-- https://github.com/NMAC427/guess-indent.nvim

---@type LazyPluginSpec
return {
"NMAC427/guess-indent.nvim",
event = { "BufReadPre", "BufNewFile" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/hex.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- hex.nvim | hex editing done right
-- https://github.com/RaafatTurki/hex.nvim

---@type LazyPluginSpec
return {
"RaafatTurki/hex.nvim",
cmd = { "HexAssemble", "HexDump", "HexToggle" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/hop.lua
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ local search_buffer = function()
require("hop").hint_char1({ current_line_only = false })
end

---@type LazyPluginSpec
return {
"smoka7/hop.nvim",
version = "*",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/indent_blankline.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- indent-blankline.nvim | Indent guides for Neovim
-- https://github.com/lukas-reineke/indent-blankline.nvim

---@type LazyPluginSpec
return {
"lukas-reineke/indent-blankline.nvim",
main = "ibl",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/lsp/init.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Neovim LSP Configuration (Language Server Protocol)
-- Setup native lsp using lspconfig helper plugin

---@type LazyPluginSpec[]
return {
{ -- Initialize language server configuration
"neovim/nvim-lspconfig",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/lualine.lua
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ local function client_format(client_name, spinner, series_messages)
end
end

---@type LazyPluginSpec[]
return {
{
"nvim-lualine/lualine.nvim",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/luasnip.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- LuaSnip | Snippet Engine for Neovim written in Lua.
-- https://github.com/L3MON4D3/LuaSnip

---@type LazyPluginSpec
return {
"L3MON4D3/LuaSnip",
event = "InsertCharPre",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/markdown.lua
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
-- lua/plugins/markdown.lua

---@type LazyPluginSpec[]
return {
{ -- Nice extra's for markdown documents
"SidOfc/mkdx",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/mason.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- mason.nvim | Portable package manager for Neovim
-- https://github.com/williamboman/mason.nvim

---@type LazyPluginSpec[]
return {
{
"williamboman/mason.nvim",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/neogit.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Neogit | magit for Neovim
-- https://github.com/TimUntersberger/neogit

---@type LazyPluginSpec
return {
"TimUntersberger/neogit",
cmd = "Neogit",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/neorg.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- neorg | The future of organizing your life in Neovim
-- https://github.com/nvim-neorg/neorg

---@type LazyPluginSpec
return {
"nvim-neorg/neorg",
ft = "norg",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/nvim-tree.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- nvim-tree | file browser for neovim
-- https://github.com/kyazdani42/nvim-tree.lua

---@type LazyPluginSpec
return {
"nvim-tree/nvim-tree.lua",
cmd = { "NvimTreeOpen", "NvimTreeToggle" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/project_nvim.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- project_nvim | The superior project management solution for neovim.
-- https://github.com/ahmedkhalf/project.nvim

---@type LazyPluginSpec
return {
"ahmedkhalf/project.nvim",
name = "project_nvim",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/session.lua
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ end
local delete_session = cmd_wrapper("SessionDelete")
local save_session = cmd_wrapper("SessionSave")

---@type LazyPluginSpec
return {
"rmagatti/auto-session",
event = "VimEnter",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/telescope.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Telescope config | configurations for telescope fuzzy-finder
-- https://github.com/nvim-telescope/telescope.nvim

---@type LazyPluginSpec
return {
"nvim-telescope/telescope.nvim",
cmd = "Telescope",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/todo-comments.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- todo-comments.nvim | Highlight, list and search todo comments in your projects
-- https://github.com/folke/todo-comments.nvim

---@type LazyPluginSpec
return {
"folke/todo-comments.nvim",
cmd = { "TodoTrouble", "TodoTelescope" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/toggleterm.lua
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ local initialize_terminals = function(opts)
end
end

---@type LazyPluginSpec
return {
"akinsho/toggleterm.nvim",
version = "*",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/treesitter.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- nvim-treesitter | Nvim Treesitter configurations and abstraction layer
-- https://github.com/nvim-treesitter/nvim-treesitter

---@type LazyPluginSpec
return {
"nvim-treesitter/nvim-treesitter",
build = ":TSUpdate",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/trouble.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- trouble.nvim | pretty diagnostics, references, telescope results
-- https://github.com/folke/trouble.nvim

---@type LazyPluginSpec
return {
"folke/trouble.nvim",
cmd = { "TroubleToggle", "Trouble" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/unception.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- nvim-unception | open files from terminal without nesting
-- https://github.com/samjwill/nvim-unception

---@type LazyPluginSpec
return {
"samjwill/nvim-unception",
enabled = false,
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/undotree.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- The undo history visualizer for VIM
-- https://github.com/mbbill/undotree

---@type LazyPluginSpec
return {
"mbbill/undotree",
cmd = { "UndotreeShow", "UndotreeToggle" },
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/vim-dirtytalk.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- vim-dirtytalk | Spellcheck dictionary for programmers
-- https://github.com/psliwka/vim-dirtytalk

---@type LazyPluginSpec
return {
"psliwka/vim-dirtytalk",
build = ":DirtytalkUpdate",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/which-key.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
-- Which-key | Configurations for plugin WhichKey.nvim
-- https://github.com/folke/which-key.nvim

---@type LazyPluginSpec
return {
"folke/which-key.nvim",
version = "*",
Expand Down
1 change: 1 addition & 0 deletions lua/plugins/zen-mode.lua
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ local on_open = function(win)
end
end

---@type LazyPluginSpec
return {
"folke/zen-mode.nvim",
cmd = "ZenMode",
Expand Down
Loading