mirror of
https://github.com/nvim-lua/kickstart.nvim.git
synced 2026-04-01 15:52:12 -07:00
Add type hints to plugin options where possible
This could help beginners to get autocompletion, catch mistakes earlier, and allow them to skip the docs for simple configs. This is not perfect because a lot of the plugins type all of their keys as required, even though they have defaults, but this is good enough.
This commit is contained in:
42
init.lua
42
init.lua
@@ -275,13 +275,16 @@ require('lazy').setup({
|
||||
-- See `:help gitsigns` to understand what the configuration keys do
|
||||
{ -- Adds git related signs to the gutter, as well as utilities for managing changes
|
||||
'lewis6991/gitsigns.nvim',
|
||||
---@module 'gitsigns'
|
||||
---@type Gitsigns.Config
|
||||
---@diagnostic disable-next-line: missing-fields
|
||||
opts = {
|
||||
signs = {
|
||||
add = { text = '+' },
|
||||
change = { text = '~' },
|
||||
delete = { text = '_' },
|
||||
topdelete = { text = '‾' },
|
||||
changedelete = { text = '~' },
|
||||
add = { text = '+' }, ---@diagnostic disable-line: missing-fields
|
||||
change = { text = '~' }, ---@diagnostic disable-line: missing-fields
|
||||
delete = { text = '_' }, ---@diagnostic disable-line: missing-fields
|
||||
topdelete = { text = '‾' }, ---@diagnostic disable-line: missing-fields
|
||||
changedelete = { text = '~' }, ---@diagnostic disable-line: missing-fields
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -303,6 +306,9 @@ require('lazy').setup({
|
||||
{ -- Useful plugin to show you pending keybinds.
|
||||
'folke/which-key.nvim',
|
||||
event = 'VimEnter',
|
||||
---@module 'which-key'
|
||||
---@type wk.Opts
|
||||
---@diagnostic disable-next-line: missing-fields
|
||||
opts = {
|
||||
-- delay between pressing a key and opening which-key (milliseconds)
|
||||
delay = 0,
|
||||
@@ -480,7 +486,13 @@ require('lazy').setup({
|
||||
-- Automatically install LSPs and related tools to stdpath for Neovim
|
||||
-- Mason must be loaded before its dependents so we need to set it up here.
|
||||
-- NOTE: `opts = {}` is the same as calling `require('mason').setup({})`
|
||||
{ 'mason-org/mason.nvim', opts = {} },
|
||||
{
|
||||
'mason-org/mason.nvim',
|
||||
---@module 'mason.settings'
|
||||
---@type MasonSettings
|
||||
---@diagnostic disable-next-line: missing-fields
|
||||
opts = {},
|
||||
},
|
||||
-- Maps LSP server names between nvim-lspconfig and Mason package names.
|
||||
'mason-org/mason-lspconfig.nvim',
|
||||
'WhoIsSethDaniel/mason-tool-installer.nvim',
|
||||
@@ -673,6 +685,8 @@ require('lazy').setup({
|
||||
desc = '[F]ormat buffer',
|
||||
},
|
||||
},
|
||||
---@module 'conform'
|
||||
---@type conform.setupOpts
|
||||
opts = {
|
||||
notify_on_error = false,
|
||||
format_on_save = function(bufnr)
|
||||
@@ -730,8 +744,8 @@ require('lazy').setup({
|
||||
opts = {},
|
||||
},
|
||||
},
|
||||
--- @module 'blink.cmp'
|
||||
--- @type blink.cmp.Config
|
||||
---@module 'blink.cmp'
|
||||
---@type blink.cmp.Config
|
||||
opts = {
|
||||
keymap = {
|
||||
-- 'default' (recommended) for mappings similar to built-in completions
|
||||
@@ -816,7 +830,15 @@ require('lazy').setup({
|
||||
},
|
||||
|
||||
-- Highlight todo, notes, etc in comments
|
||||
{ 'folke/todo-comments.nvim', event = 'VimEnter', dependencies = { 'nvim-lua/plenary.nvim' }, opts = { signs = false } },
|
||||
{
|
||||
'folke/todo-comments.nvim',
|
||||
event = 'VimEnter',
|
||||
dependencies = { 'nvim-lua/plenary.nvim' },
|
||||
---@module 'todo-comments'
|
||||
---@type TodoOptions
|
||||
---@diagnostic disable-next-line: missing-fields
|
||||
opts = { signs = false },
|
||||
},
|
||||
|
||||
{ -- Collection of various small independent plugins/modules
|
||||
'nvim-mini/mini.nvim',
|
||||
@@ -892,7 +914,7 @@ require('lazy').setup({
|
||||
-- Or use telescope!
|
||||
-- In normal mode type `<space>sh` then write `lazy.nvim-plugin`
|
||||
-- you can continue same window with `<space>sr` which resumes last telescope search
|
||||
}, {
|
||||
}, { ---@diagnostic disable-line: missing-fields
|
||||
ui = {
|
||||
-- If you are using a Nerd Font: set icons to an empty table which will use the
|
||||
-- default lazy.nvim defined Nerd Font icons, otherwise define a unicode icons table
|
||||
|
||||
Reference in New Issue
Block a user