diff --git a/.github/workflows/stylua.yml b/.github/workflows/stylua.yml
index 75db6c33..eb60303f 100644
--- a/.github/workflows/stylua.yml
+++ b/.github/workflows/stylua.yml
@@ -9,13 +9,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
- uses: actions/checkout@v2
+ uses: actions/checkout@v6
with:
ref: ${{ github.event.pull_request.head.sha }}
- name: Stylua Check
- uses: JohnnyMorganz/stylua-action@v3
+ uses: JohnnyMorganz/stylua-action@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
version: latest
args: --check .
-
diff --git a/.gitignore b/.gitignore
index 005b535b..68486fc3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,4 +4,11 @@ test.sh
nvim
spell/
+
+# In your personal fork, you likely want to comment this, since it's recommended to track
+# lazy-lock.json in version control - see https://lazy.folke.io/usage/lockfile
+# For the official `nvim-lua/kickstart.nvim` git repository, we leave it ignored to avoid unneeded
+# merge conflicts.
lazy-lock.json
+
+.DS_Store
diff --git a/.stylua.toml b/.stylua.toml
index 139e9397..edfa5067 100644
--- a/.stylua.toml
+++ b/.stylua.toml
@@ -4,3 +4,4 @@ indent_type = "Spaces"
indent_width = 2
quote_style = "AutoPreferSingle"
call_parentheses = "None"
+collapse_simple_statement = "Always"
diff --git a/README.md b/README.md
index 41139505..093e42a6 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,14 @@ A starting point for Neovim that is:
Kickstart.nvim targets *only* the latest
['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
-If you are experiencing issues, please make sure you have the latest versions.
+If you are experiencing issues, please make sure you have at least the latest
+stable version. Most likely, you want to install neovim via a [package
+manager](https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package).
+To check your neovim version, run `nvim --version` and make sure it is not
+below the latest
+['stable'](https://github.com/neovim/neovim/releases/tag/stable) version. If
+your chosen install method only gives you an outdated version of neovim, find
+alternative [installation methods below](#alternative-neovim-installation-methods).
### Install External Dependencies
@@ -25,6 +32,7 @@ External Requirements:
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation),
[fd-find](https://github.com/sharkdp/fd#installation)
+- [tree-sitter CLI](https://github.com/tree-sitter/tree-sitter/blob/master/crates/cli/README.md#installation)
- Clipboard tool (xclip/xsel/win32yank or other depending on the platform)
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
- if you have it set `vim.g.have_nerd_font` in `init.lua` to true
@@ -154,7 +162,7 @@ examples of adding popularly requested plugins.
Below you can find OS specific install instructions for Neovim and dependencies.
-After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
+After installing all the dependencies continue with the [Install Kickstart](#install-kickstart) step.
#### Windows Installation
@@ -185,7 +193,7 @@ winget install --accept-source-agreements chocolatey.chocolatey
2. install all requirements using choco, exit the previous cmd and
open a new one so that choco path is set, and run in cmd as **admin**:
```
-choco install -y neovim git ripgrep wget fd unzip gzip mingw make
+choco install -y neovim git ripgrep wget fd unzip gzip mingw make tree-sitter
```
WSL (Windows Subsystem for Linux)
@@ -195,7 +203,7 @@ wsl --install
wsl
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
-sudo apt install make gcc ripgrep unzip git xclip neovim
+sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip neovim
```
@@ -205,14 +213,14 @@ sudo apt install make gcc ripgrep unzip git xclip neovim
```
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
-sudo apt install make gcc ripgrep unzip git xclip neovim
+sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip neovim
```
Debian Install Steps
```
sudo apt update
-sudo apt install make gcc ripgrep unzip git xclip curl
+sudo apt install make gcc ripgrep fd-find tree-sitter-cli unzip git xclip curl
# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux-x86_64.tar.gz
@@ -228,14 +236,88 @@ sudo ln -sf /opt/nvim-linux-x86_64/bin/nvim /usr/local/bin/
Fedora Install Steps
```
-sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
+sudo dnf install -y gcc make git ripgrep fd-find tree-sitter-cli unzip neovim
```
Arch Install Steps
```
-sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
+sudo pacman -S --noconfirm --needed gcc make git ripgrep fd tree-sitter-cli unzip neovim
```
+### Alternative neovim installation methods
+
+For some systems it is not unexpected that the [package manager installation
+method](https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-package)
+recommended by neovim is significantly behind. If that is the case for you,
+pick one of the following methods that are known to deliver fresh neovim versions very quickly.
+They have been picked for their popularity and because they make installing and updating
+neovim to the latest versions easy. You can also find more detail about the
+available methods being discussed
+[here](https://github.com/nvim-lua/kickstart.nvim/issues/1583).
+
+
+Bob
+
+[Bob](https://github.com/MordechaiHadad/bob) is a Neovim version manager for
+all platforms. Simply install
+[rustup](https://rust-lang.github.io/rustup/installation/other.html),
+and run the following commands:
+
+```bash
+rustup default stable
+rustup update stable
+cargo install bob-nvim
+bob use stable
+```
+
+
+
+Homebrew
+
+[Homebrew](https://brew.sh) is a package manager popular on Mac and Linux.
+Simply install using [`brew install`](https://formulae.brew.sh/formula/neovim).
+
+
+
+Flatpak
+
+Flatpak is a package manager for applications that allows developers to package their applications
+just once to make it available on all Linux systems. Simply [install flatpak](https://flatpak.org/setup/)
+and setup [flathub](https://flathub.org/setup) to [install neovim](https://flathub.org/apps/io.neovim.nvim).
+
+
+
+asdf and mise-en-place
+
+[asdf](https://asdf-vm.com/) and [mise](https://mise.jdx.dev/) are tool version managers,
+mostly aimed towards project-specific tool versioning. However both support managing tools
+globally in the user-space as well:
+
+mise
+
+[Install mise](https://mise.jdx.dev/getting-started.html), then run:
+
+```bash
+mise plugins install neovim
+mise use neovim@stable
+```
+
+
+
+asdf
+
+[Install asdf](https://asdf-vm.com/guide/getting-started.html), then run:
+
+```bash
+asdf plugin add neovim
+asdf install neovim stable
+asdf set neovim stable --home
+asdf reshim neovim
+```
+
+
+
+
diff --git a/init.lua b/init.lua
index d151afa6..8804a07b 100644
--- a/init.lua
+++ b/init.lua
@@ -114,14 +114,12 @@ vim.o.showmode = false
-- Schedule the setting after `UiEnter` because it can increase startup-time.
-- Remove this option if you want your OS clipboard to remain independent.
-- See `:help 'clipboard'`
-vim.schedule(function()
- vim.o.clipboard = 'unnamedplus'
-end)
+vim.schedule(function() vim.o.clipboard = 'unnamedplus' end)
-- Enable break indent
vim.o.breakindent = true
--- Save undo history
+-- Enable undo/redo changes even after closing and reopening a file
vim.o.undofile = true
-- Case-insensitive searching UNLESS \C or one or more capital letters in the search term
@@ -148,7 +146,7 @@ vim.o.splitbelow = true
-- Notice listchars is set using `vim.opt` instead of `vim.o`.
-- It is very similar to `vim.o` but offers an interface for conveniently interacting with tables.
-- See `:help lua-options`
--- and `:help lua-options-guide`
+-- and `:help lua-guide-options`
vim.o.list = true
vim.opt.listchars = { tab = '» ', trail = '·', nbsp = '␣' }
@@ -176,7 +174,22 @@ vim.o.relativenumber = true
-- See `:help hlsearch`
vim.keymap.set('n', '', 'nohlsearch')
--- Diagnostic keymaps
+-- Diagnostic Config & Keymaps
+-- See :help vim.diagnostic.Opts
+vim.diagnostic.config {
+ update_in_insert = false,
+ severity_sort = true,
+ float = { border = 'rounded', source = 'if_many' },
+ underline = { severity = { min = vim.diagnostic.severity.WARN } },
+
+ -- Can switch between these as you prefer
+ virtual_text = true, -- Text shows up at the end of the line
+ virtual_lines = false, -- Text shows up underneath the line, with virtual lines
+
+ -- Auto open the float, so you can easily read the errors when jumping with `[d` and `]d`
+ jump = { float = true },
+}
+
vim.keymap.set('n', 'q', vim.diagnostic.setloclist, { desc = 'Open diagnostic [Q]uickfix list' })
-- Exit terminal mode in the builtin terminal with a shortcut that is a bit easier
@@ -217,9 +230,7 @@ vim.keymap.set('n', '', '', { desc = 'Move focus to the upper win
vim.api.nvim_create_autocmd('TextYankPost', {
desc = 'Highlight when yanking (copying) text',
group = vim.api.nvim_create_augroup('kickstart-highlight-yank', { clear = true }),
- callback = function()
- vim.hl.on_yank()
- end,
+ callback = function() vim.hl.on_yank() end,
})
-- [[ Install `lazy.nvim` plugin manager ]]
@@ -228,9 +239,7 @@ local lazypath = vim.fn.stdpath 'data' .. '/lazy/lazy.nvim'
if not (vim.uv or vim.loop).fs_stat(lazypath) then
local lazyrepo = 'https://github.com/folke/lazy.nvim.git'
local out = vim.fn.system { 'git', 'clone', '--filter=blob:none', '--branch=stable', lazyrepo, lazypath }
- if vim.v.shell_error ~= 0 then
- error('Error cloning lazy.nvim:\n' .. out)
- end
+ if vim.v.shell_error ~= 0 then error('Error cloning lazy.nvim:\n' .. out) end
end
---@type vim.Option
@@ -249,15 +258,8 @@ rtp:prepend(lazypath)
--
-- NOTE: Here is where you install your plugins.
require('lazy').setup({
- -- NOTE: Plugins can be added with a link (or for a github repo: 'owner/repo' link).
- 'NMAC427/guess-indent.nvim', -- Detect tabstop and shiftwidth automatically
-
- -- NOTE: Plugins can also be added by using a table,
- -- with the first argument being the link and the following
- -- keys can be used to configure plugin behavior/loading/etc.
- --
- -- Use `opts = {}` to automatically pass options to a plugin's `setup()` function, forcing the plugin to be loaded.
- --
+ -- NOTE: Plugins can be added via a link or github org/name. To run setup automatically, use `opts = {}`
+ { 'NMAC427/guess-indent.nvim', opts = {} },
-- Alternatively, use `config = function() ... end` for full control over the configuration.
-- If you prefer to call `setup` explicitly, use:
@@ -276,13 +278,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,53 +308,21 @@ require('lazy').setup({
{ -- Useful plugin to show you pending keybinds.
'folke/which-key.nvim',
- event = 'VimEnter', -- Sets the loading event to 'VimEnter'
+ 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)
- -- this setting is independent of vim.o.timeoutlen
delay = 0,
- icons = {
- -- set icon mappings to true if you have a Nerd Font
- mappings = vim.g.have_nerd_font,
- -- If you are using a Nerd Font: set icons.keys to an empty table which will use the
- -- default which-key.nvim defined Nerd Font icons, otherwise define a string table
- keys = vim.g.have_nerd_font and {} or {
- Up = ' ',
- Down = ' ',
- Left = ' ',
- Right = ' ',
- C = ' ',
- M = ' ',
- D = ' ',
- S = ' ',
- CR = ' ',
- Esc = ' ',
- ScrollWheelDown = ' ',
- ScrollWheelUp = ' ',
- NL = ' ',
- BS = ' ',
- Space = ' ',
- Tab = ' ',
- F1 = '',
- F2 = '',
- F3 = '',
- F4 = '',
- F5 = '',
- F6 = '',
- F7 = '',
- F8 = '',
- F9 = '',
- F10 = '',
- F11 = '',
- F12 = '',
- },
- },
+ icons = { mappings = vim.g.have_nerd_font },
-- Document existing key chains
spec = {
- { 's', group = '[S]earch' },
+ { 's', group = '[S]earch', mode = { 'n', 'v' } },
{ 't', group = '[T]oggle' },
- { 'h', group = 'Git [H]unk', mode = { 'n', 'v' } },
+ { 'h', group = 'Git [H]unk', mode = { 'n', 'v' } }, -- Enable gitsigns recommended keymaps first
+ { 'gr', group = 'LSP Actions', mode = { 'n' } },
},
},
},
@@ -363,6 +336,16 @@ require('lazy').setup({
{ -- Fuzzy Finder (files, lsp, etc)
'nvim-telescope/telescope.nvim',
+ -- By default, Telescope is included and acts as your picker for everything.
+
+ -- If you would like to switch to a different picker (like snacks, or fzf-lua)
+ -- you can disable the Telescope plugin by setting enabled to false and enable
+ -- your replacement picker by requiring it explicitly (e.g. 'custom.plugins.snacks')
+
+ -- Note: If you customize your config for yourself,
+ -- it’s best to remove the Telescope plugin config entirely
+ -- instead of just disabling it here, to keep your config clean.
+ enabled = true,
event = 'VimEnter',
dependencies = {
'nvim-lua/plenary.nvim',
@@ -375,9 +358,7 @@ require('lazy').setup({
-- `cond` is a condition used to determine whether this plugin should be
-- installed and loaded.
- cond = function()
- return vim.fn.executable 'make' == 1
- end,
+ cond = function() return vim.fn.executable 'make' == 1 end,
},
{ 'nvim-telescope/telescope-ui-select.nvim' },
@@ -417,9 +398,7 @@ require('lazy').setup({
-- },
-- pickers = {}
extensions = {
- ['ui-select'] = {
- require('telescope.themes').get_dropdown(),
- },
+ ['ui-select'] = { require('telescope.themes').get_dropdown() },
},
}
@@ -433,14 +412,49 @@ require('lazy').setup({
vim.keymap.set('n', 'sk', builtin.keymaps, { desc = '[S]earch [K]eymaps' })
vim.keymap.set('n', 'sf', builtin.find_files, { desc = '[S]earch [F]iles' })
vim.keymap.set('n', 'ss', builtin.builtin, { desc = '[S]earch [S]elect Telescope' })
- vim.keymap.set('n', 'sw', builtin.grep_string, { desc = '[S]earch current [W]ord' })
+ vim.keymap.set({ 'n', 'v' }, 'sw', builtin.grep_string, { desc = '[S]earch current [W]ord' })
vim.keymap.set('n', 'sg', builtin.live_grep, { desc = '[S]earch by [G]rep' })
vim.keymap.set('n', 'sd', builtin.diagnostics, { desc = '[S]earch [D]iagnostics' })
vim.keymap.set('n', 'sr', builtin.resume, { desc = '[S]earch [R]esume' })
vim.keymap.set('n', 's.', builtin.oldfiles, { desc = '[S]earch Recent Files ("." for repeat)' })
+ vim.keymap.set('n', 'sc', builtin.commands, { desc = '[S]earch [C]ommands' })
vim.keymap.set('n', '', builtin.buffers, { desc = '[ ] Find existing buffers' })
- -- Slightly advanced example of overriding default behavior and theme
+ -- This runs on LSP attach per buffer (see main LSP attach function in 'neovim/nvim-lspconfig' config for more info,
+ -- it is better explained there). This allows easily switching between pickers if you prefer using something else!
+ vim.api.nvim_create_autocmd('LspAttach', {
+ group = vim.api.nvim_create_augroup('telescope-lsp-attach', { clear = true }),
+ callback = function(event)
+ local buf = event.buf
+
+ -- Find references for the word under your cursor.
+ vim.keymap.set('n', 'grr', builtin.lsp_references, { buffer = buf, desc = '[G]oto [R]eferences' })
+
+ -- Jump to the implementation of the word under your cursor.
+ -- Useful when your language has ways of declaring types without an actual implementation.
+ vim.keymap.set('n', 'gri', builtin.lsp_implementations, { buffer = buf, desc = '[G]oto [I]mplementation' })
+
+ -- Jump to the definition of the word under your cursor.
+ -- This is where a variable was first declared, or where a function is defined, etc.
+ -- To jump back, press .
+ vim.keymap.set('n', 'grd', builtin.lsp_definitions, { buffer = buf, desc = '[G]oto [D]efinition' })
+
+ -- Fuzzy find all the symbols in your current document.
+ -- Symbols are things like variables, functions, types, etc.
+ vim.keymap.set('n', 'gO', builtin.lsp_document_symbols, { buffer = buf, desc = 'Open Document Symbols' })
+
+ -- Fuzzy find all the symbols in your current workspace.
+ -- Similar to document symbols, except searches over your entire project.
+ vim.keymap.set('n', 'gW', builtin.lsp_dynamic_workspace_symbols, { buffer = buf, desc = 'Open Workspace Symbols' })
+
+ -- Jump to the type of the word under your cursor.
+ -- Useful when you're not sure what type a variable is and you want to see
+ -- the definition of its *type*, not where it was *defined*.
+ vim.keymap.set('n', 'grt', builtin.lsp_type_definitions, { buffer = buf, desc = '[G]oto [T]ype Definition' })
+ end,
+ })
+
+ -- Override default behavior and theme when searching
vim.keymap.set('n', '/', function()
-- You can pass additional configuration to Telescope to change the theme, layout, etc.
builtin.current_buffer_fuzzy_find(require('telescope.themes').get_dropdown {
@@ -451,33 +465,24 @@ require('lazy').setup({
-- It's also possible to pass additional configuration options.
-- See `:help telescope.builtin.live_grep()` for information about particular keys
- vim.keymap.set('n', 's/', function()
- builtin.live_grep {
- grep_open_files = true,
- prompt_title = 'Live Grep in Open Files',
- }
- end, { desc = '[S]earch [/] in Open Files' })
+ vim.keymap.set(
+ 'n',
+ 's/',
+ function()
+ builtin.live_grep {
+ grep_open_files = true,
+ prompt_title = 'Live Grep in Open Files',
+ }
+ end,
+ { desc = '[S]earch [/] in Open Files' }
+ )
-- Shortcut for searching your Neovim configuration files
- vim.keymap.set('n', 'sn', function()
- builtin.find_files { cwd = vim.fn.stdpath 'config' }
- end, { desc = '[S]earch [N]eovim files' })
+ vim.keymap.set('n', 'sn', function() builtin.find_files { cwd = vim.fn.stdpath 'config' } end, { desc = '[S]earch [N]eovim files' })
end,
},
-- LSP Plugins
- {
- -- `lazydev` configures Lua LSP for your Neovim config, runtime and plugins
- -- used for completion, annotations and signatures of Neovim apis
- 'folke/lazydev.nvim',
- ft = 'lua',
- opts = {
- library = {
- -- Load luvit types when the `vim.uv` word is found
- { path = '${3rd}/luv/library', words = { 'vim%.uv' } },
- },
- },
- },
{
-- Main LSP Configuration
'neovim/nvim-lspconfig',
@@ -485,15 +490,19 @@ 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',
-- Useful status updates for LSP.
{ 'j-hui/fidget.nvim', opts = {} },
-
- -- Allows extra capabilities provided by blink.cmp
- 'saghen/blink.cmp',
},
config = function()
-- Brief aside: **What is LSP?**
@@ -546,18 +555,6 @@ require('lazy').setup({
-- or a suggestion from your LSP for this to activate.
map('gra', vim.lsp.buf.code_action, '[G]oto Code [A]ction', { 'n', 'x' })
- -- Find references for the word under your cursor.
- map('grr', require('telescope.builtin').lsp_references, '[G]oto [R]eferences')
-
- -- Jump to the implementation of the word under your cursor.
- -- Useful when your language has ways of declaring types without an actual implementation.
- map('gri', require('telescope.builtin').lsp_implementations, '[G]oto [I]mplementation')
-
- -- Jump to the definition of the word under your cursor.
- -- This is where a variable was first declared, or where a function is defined, etc.
- -- To jump back, press .
- map('grd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')
-
-- WARN: This is not Goto Definition, this is Goto Declaration.
-- For example, in C this would take you to the header.
map('grD', vim.lsp.buf.declaration, '[G]oto [D]eclaration')
@@ -597,7 +594,7 @@ require('lazy').setup({
--
-- When you move your cursor, the highlights will be cleared (the second autocommand).
local client = vim.lsp.get_client_by_id(event.data.client_id)
- if client and client_supports_method(client, vim.lsp.protocol.Methods.textDocument_documentHighlight, event.buf) then
+ if client and client:supports_method('textDocument/documentHighlight', event.buf) then
local highlight_augroup = vim.api.nvim_create_augroup('kickstart-lsp-highlight', { clear = false })
vim.api.nvim_create_autocmd({ 'CursorHold', 'CursorHoldI' }, {
buffer = event.buf,
@@ -624,10 +621,8 @@ require('lazy').setup({
-- code, if the language server you are using supports them
--
-- This may be unwanted, since they displace some of your code
- if client and client_supports_method(client, vim.lsp.protocol.Methods.textDocument_inlayHint, event.buf) then
- map('th', function()
- vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled { bufnr = event.buf })
- end, '[T]oggle Inlay [H]ints')
+ if client and client:supports_method('textDocument/inlayHint', event.buf) then
+ map('th', function() vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled { bufnr = event.buf }) end, '[T]oggle Inlay [H]ints')
end
end,
})
@@ -700,38 +695,52 @@ require('lazy').setup({
-- Enable the following language servers
-- Feel free to add/remove any LSPs that you want here. They will automatically be installed.
- --
- -- Add any additional override configuration in the following tables. Available keys are:
- -- - cmd (table): Override the default command used to start the server
- -- - filetypes (table): Override the default list of associated filetypes for the server
- -- - capabilities (table): Override fields in capabilities. Can be used to disable certain LSP features.
- -- - settings (table): Override the default settings passed when initializing the server.
- -- For example, to see the options for `lua_ls`, you could go to: https://luals.github.io/wiki/settings/
+ -- See `:help lsp-config` for information about keys and how to configure
+ ---@type table
local servers = {
-- clangd = {},
-- gopls = {},
-- pyright = {},
-- rust_analyzer = {},
- -- ... etc. See `:help lspconfig-all` for a list of all the pre-configured LSPs
--
-- Some languages (like typescript) have entire language plugins that can be useful:
-- https://github.com/pmizio/typescript-tools.nvim
--
-- But for many setups, the LSP (`ts_ls`) will work just fine
-- ts_ls = {},
- --
+ stylua = {}, -- Used to format Lua code
+
+ -- Special Lua Config, as recommended by neovim help docs
lua_ls = {
- -- cmd = { ... },
- -- filetypes = { ... },
- -- capabilities = {},
+ on_init = function(client)
+ client.server_capabilities.documentFormattingProvider = false -- Disable formatting (formatting is done by stylua)
+
+ if client.workspace_folders then
+ local path = client.workspace_folders[1].name
+ if path ~= vim.fn.stdpath 'config' and (vim.uv.fs_stat(path .. '/.luarc.json') or vim.uv.fs_stat(path .. '/.luarc.jsonc')) then return end
+ end
+
+ client.config.settings.Lua = vim.tbl_deep_extend('force', client.config.settings.Lua, {
+ runtime = {
+ version = 'LuaJIT',
+ path = { 'lua/?.lua', 'lua/?/init.lua' },
+ },
+ workspace = {
+ checkThirdParty = false,
+ -- NOTE: this is a lot slower and will cause issues when working on your own configuration.
+ -- See https://github.com/neovim/nvim-lspconfig/issues/3189
+ library = vim.tbl_extend('force', vim.api.nvim_get_runtime_file('', true), {
+ '${3rd}/luv/library',
+ '${3rd}/busted/library',
+ }),
+ },
+ })
+ end,
+ ---@type lspconfig.settings.lua_ls
settings = {
Lua = {
- completion = {
- callSnippet = 'Replace',
- },
- -- You can toggle below to ignore Lua_LS's noisy `missing-fields` warnings
- -- diagnostics = { disable = { 'missing-fields' } },
+ format = { enable = false }, -- Disable formatting (formatting is done by stylua)
},
},
},
@@ -744,12 +753,6 @@ require('lazy').setup({
-- :Mason
--
-- You can press `g?` for help in this menu.
- --
- -- `mason` had to be setup earlier: to configure its options see the
- -- `dependencies` table for `nvim-lspconfig` above.
- --
- -- You can add other tools here that you want Mason to install
- -- for you, so that they are available from within Neovim.
local ensure_installed = vim.tbl_keys(servers or {})
vim.list_extend(ensure_installed, {
@@ -760,20 +763,10 @@ require('lazy').setup({
require('mason-tool-installer').setup { ensure_installed = ensure_installed }
- require('mason-lspconfig').setup {
- ensure_installed = {}, -- explicitly set to an empty table (Kickstart populates installs via mason-tool-installer)
- automatic_installation = true,
- handlers = {
- function(server_name)
- local server = servers[server_name] or {}
- -- This handles overriding only values explicitly passed
- -- by the server configuration above. Useful when disabling
- -- certain features of an LSP (for example, turning off formatting for ts_ls)
- server.capabilities = vim.tbl_deep_extend('force', {}, capabilities, server.capabilities or {})
- require('lspconfig')[server_name].setup(server)
- end,
- },
- }
+ for name, server in pairs(servers) do
+ vim.lsp.config(name, server)
+ vim.lsp.enable(name)
+ end
end,
},
@@ -784,31 +777,33 @@ require('lazy').setup({
keys = {
{
'f',
- function()
- require('conform').format { async = true, lsp_format = 'fallback' }
- end,
+ function() require('conform').format { async = true } end,
mode = '',
desc = '[F]ormat buffer',
},
},
+ ---@module 'conform'
+ ---@type conform.setupOpts
opts = {
notify_on_error = false,
format_on_save = function(bufnr)
- -- Disable "format_on_save lsp_fallback" for languages that don't
- -- have a well standardized coding style. You can add additional
- -- languages here or re-enable it for the disabled ones.
- local disable_filetypes = { c = true, cpp = true }
- if disable_filetypes[vim.bo[bufnr].filetype] then
- return nil
+ -- You can specify filetypes to autoformat on save here:
+ local enabled_filetypes = {
+ -- lua = true,
+ -- python = true,
+ }
+ if enabled_filetypes[vim.bo[bufnr].filetype] then
+ return { timeout_ms = 500 }
else
- return {
- timeout_ms = 500,
- lsp_format = 'fallback',
- }
+ return nil
end
end,
+ default_format_opts = {
+ lsp_format = 'fallback', -- Use external formatters if configured below, otherwise use LSP formatting. Set to `false` to disable LSP formatting entirely.
+ },
+ -- You can also specify external formatters in here.
formatters_by_ft = {
- lua = { 'stylua' },
+ -- rust = { 'rustfmt' },
-- Conform can also run multiple formatters sequentially
-- python = { "isort", "black" },
--
@@ -833,9 +828,7 @@ require('lazy').setup({
-- Build Step is needed for regex support in snippets.
-- This step is not supported in many windows environments.
-- Remove the below condition to re-enable on windows.
- if vim.fn.has 'win32' == 1 or vim.fn.executable 'make' == 0 then
- return
- end
+ if vim.fn.has 'win32' == 1 or vim.fn.executable 'make' == 0 then return end
return 'make install_jsregexp'
end)(),
dependencies = {
@@ -851,10 +844,9 @@ require('lazy').setup({
},
opts = {},
},
- 'folke/lazydev.nvim',
},
- --- @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
@@ -949,18 +941,33 @@ 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
- 'echasnovski/mini.nvim',
+ 'nvim-mini/mini.nvim',
config = function()
-- Better Around/Inside textobjects
--
-- Examples:
-- - va) - [V]isually select [A]round [)]paren
- -- - yinq - [Y]ank [I]nside [N]ext [Q]uote
+ -- - yiiq - [Y]ank [I]nside [I]+1 [Q]uote
-- - ci' - [C]hange [I]nside [']quote
- require('mini.ai').setup { n_lines = 500 }
+ require('mini.ai').setup {
+ -- NOTE: Avoid conflicts with the built-in incremental selection mappings on Neovim>=0.12 (see `:help treesitter-incremental-selection`)
+ mappings = {
+ around_next = 'aa',
+ inside_next = 'ii',
+ },
+ n_lines = 500,
+ }
-- Add/delete/replace surroundings (brackets, quotes, etc.)
--
@@ -980,38 +987,68 @@ require('lazy').setup({
-- default behavior. For example, here we set the section for
-- cursor location to LINE:COLUMN
---@diagnostic disable-next-line: duplicate-set-field
- statusline.section_location = function()
- return '%2l:%-2v'
- end
+ statusline.section_location = function() return '%2l:%-2v' end
-- ... and there is more!
- -- Check out: https://github.com/echasnovski/mini.nvim
+ -- Check out: https://github.com/nvim-mini/mini.nvim
end,
},
+
{ -- Highlight, edit, and navigate code
'nvim-treesitter/nvim-treesitter',
+ lazy = false,
build = ':TSUpdate',
- main = 'nvim-treesitter.configs', -- Sets main module to use for opts
- -- [[ Configure Treesitter ]] See `:help nvim-treesitter`
- opts = {
- ensure_installed = { 'bash', 'c', 'diff', 'html', 'lua', 'luadoc', 'markdown', 'markdown_inline', 'query', 'vim', 'vimdoc', 'php', 'javascript', 'vue' },
- -- Autoinstall languages that are not installed
- auto_install = true,
- highlight = {
- enable = true,
- -- Some languages depend on vim's regex highlighting system (such as Ruby) for indent rules.
- -- If you are experiencing weird indenting issues, add the language to
- -- the list of additional_vim_regex_highlighting and disabled languages for indent.
- additional_vim_regex_highlighting = { 'ruby' },
- },
- indent = { enable = true, disable = { 'ruby' } },
- },
- -- There are additional nvim-treesitter modules that you can use to interact
- -- with nvim-treesitter. You should go explore a few and see what interests you:
- --
- -- - Incremental selection: Included, see `:help nvim-treesitter-incremental-selection-mod`
- -- - Show your current context: https://github.com/nvim-treesitter/nvim-treesitter-context
- -- - Treesitter + textobjects: https://github.com/nvim-treesitter/nvim-treesitter-textobjects
+ branch = 'main',
+ -- [[ Configure Treesitter ]] See `:help nvim-treesitter-intro`
+ config = function()
+ -- ensure basic parser are installed
+ local parsers = { 'bash', 'c', 'diff', 'html', 'lua', 'luadoc', 'markdown', 'markdown_inline', 'query', 'vim', 'vimdoc' }
+ require('nvim-treesitter').install(parsers)
+
+ ---@param buf integer
+ ---@param language string
+ local function treesitter_try_attach(buf, language)
+ -- check if parser exists and load it
+ if not vim.treesitter.language.add(language) then return end
+ -- enables syntax highlighting and other treesitter features
+ vim.treesitter.start(buf, language)
+
+ -- enables treesitter based folds
+ -- for more info on folds see `:help folds`
+ -- vim.wo.foldexpr = 'v:lua.vim.treesitter.foldexpr()'
+ -- vim.wo.foldmethod = 'expr'
+
+ -- check if treesitter indentation is available for this language, and if so enable it
+ -- in case there is no indent query, the indentexpr will fallback to the vim's built in one
+ local has_indent_query = vim.treesitter.query.get(language, 'indents') ~= nil
+
+ -- enables treesitter based indentation
+ if has_indent_query then vim.bo.indentexpr = "v:lua.require'nvim-treesitter'.indentexpr()" end
+ end
+
+ local available_parsers = require('nvim-treesitter').get_available()
+ vim.api.nvim_create_autocmd('FileType', {
+ callback = function(args)
+ local buf, filetype = args.buf, args.match
+
+ local language = vim.treesitter.language.get_lang(filetype)
+ if not language then return end
+
+ local installed_parsers = require('nvim-treesitter').get_installed 'parsers'
+
+ if vim.tbl_contains(installed_parsers, language) then
+ -- enable the parser if it is installed
+ treesitter_try_attach(buf, language)
+ elseif vim.tbl_contains(available_parsers, language) then
+ -- if a parser is available in `nvim-treesitter` auto install it, and enable it after the installation is done
+ require('nvim-treesitter').install(language):await(function() treesitter_try_attach(buf, language) end)
+ else
+ -- try to enable treesitter features in case the parser exists but is not available from `nvim-treesitter`
+ treesitter_try_attach(buf, language)
+ end
+ end,
+ })
+ end,
},
-- The following comments only work if you have downloaded the kickstart repo, not just copy pasted the
@@ -1040,7 +1077,7 @@ require('lazy').setup({
-- Or use telescope!
-- In normal mode type `sh` then write `lazy.nvim-plugin`
-- you can continue same window with `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
diff --git a/lua/custom/plugins/init.lua b/lua/custom/plugins/init.lua
index be0eb9d8..b3ddcfdd 100644
--- a/lua/custom/plugins/init.lua
+++ b/lua/custom/plugins/init.lua
@@ -2,4 +2,7 @@
-- I promise not to create any merge conflicts in this directory :)
--
-- See the kickstart.nvim README for more information
+
+---@module 'lazy'
+---@type LazySpec
return {}
diff --git a/lua/kickstart/health.lua b/lua/kickstart/health.lua
index b59d0864..ca684516 100644
--- a/lua/kickstart/health.lua
+++ b/lua/kickstart/health.lua
@@ -12,7 +12,7 @@ local check_version = function()
return
end
- if vim.version.ge(vim.version(), '0.10-dev') then
+ if vim.version.ge(vim.version(), '0.11') then
vim.health.ok(string.format("Neovim version is: '%s'", verstr))
else
vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", verstr))
diff --git a/lua/kickstart/plugins/autopairs.lua b/lua/kickstart/plugins/autopairs.lua
index 386d392e..351dad86 100644
--- a/lua/kickstart/plugins/autopairs.lua
+++ b/lua/kickstart/plugins/autopairs.lua
@@ -1,6 +1,8 @@
-- autopairs
-- https://github.com/windwp/nvim-autopairs
+---@module 'lazy'
+---@type LazySpec
return {
'windwp/nvim-autopairs',
event = 'InsertEnter',
diff --git a/lua/kickstart/plugins/debug.lua b/lua/kickstart/plugins/debug.lua
index 8e332bf2..7e58905e 100644
--- a/lua/kickstart/plugins/debug.lua
+++ b/lua/kickstart/plugins/debug.lua
@@ -6,6 +6,8 @@
-- be extended to other languages as well. That's why it's called
-- kickstart.nvim and not kitchen-sink.nvim ;)
+---@module 'lazy'
+---@type LazySpec
return {
-- NOTE: Yes, you can install new plugins here!
'mfussenegger/nvim-dap',
@@ -26,56 +28,14 @@ return {
},
keys = {
-- Basic debugging keymaps, feel free to change to your liking!
- {
- '',
- function()
- require('dap').continue()
- end,
- desc = 'Debug: Start/Continue',
- },
- {
- '',
- function()
- require('dap').step_into()
- end,
- desc = 'Debug: Step Into',
- },
- {
- '',
- function()
- require('dap').step_over()
- end,
- desc = 'Debug: Step Over',
- },
- {
- '',
- function()
- require('dap').step_out()
- end,
- desc = 'Debug: Step Out',
- },
- {
- 'b',
- function()
- require('dap').toggle_breakpoint()
- end,
- desc = 'Debug: Toggle Breakpoint',
- },
- {
- 'B',
- function()
- require('dap').set_breakpoint(vim.fn.input 'Breakpoint condition: ')
- end,
- desc = 'Debug: Set Breakpoint',
- },
+ { '', function() require('dap').continue() end, desc = 'Debug: Start/Continue' },
+ { '', function() require('dap').step_into() end, desc = 'Debug: Step Into' },
+ { '', function() require('dap').step_over() end, desc = 'Debug: Step Over' },
+ { '', function() require('dap').step_out() end, desc = 'Debug: Step Out' },
+ { 'b', function() require('dap').toggle_breakpoint() end, desc = 'Debug: Toggle Breakpoint' },
+ { 'B', function() require('dap').set_breakpoint(vim.fn.input 'Breakpoint condition: ') end, desc = 'Debug: Set Breakpoint' },
-- Toggle to see last session result. Without this, you can't see session output in case of unhandled exception.
- {
- '',
- function()
- require('dapui').toggle()
- end,
- desc = 'Debug: See last session result.',
- },
+ { '', function() require('dapui').toggle() end, desc = 'Debug: See last session result.' },
},
config = function()
local dap = require 'dap'
@@ -100,11 +60,13 @@ return {
-- Dap UI setup
-- For more information, see |:help nvim-dap-ui|
+ ---@diagnostic disable-next-line: missing-fields
dapui.setup {
-- Set icons to characters that are more likely to work in every terminal.
-- Feel free to remove or use ones that you like more! :)
-- Don't feel like these are good choices.
icons = { expanded = '▾', collapsed = '▸', current_frame = '*' },
+ ---@diagnostic disable-next-line: missing-fields
controls = {
icons = {
pause = '⏸',
diff --git a/lua/kickstart/plugins/gitsigns.lua b/lua/kickstart/plugins/gitsigns.lua
index cbbd22d2..500ea6c4 100644
--- a/lua/kickstart/plugins/gitsigns.lua
+++ b/lua/kickstart/plugins/gitsigns.lua
@@ -2,60 +2,62 @@
-- NOTE: gitsigns is already included in init.lua but contains only the base
-- config. This will add also the recommended keymaps.
+---@module 'lazy'
+---@type LazySpec
return {
- {
- 'lewis6991/gitsigns.nvim',
- opts = {
- on_attach = function(bufnr)
- local gitsigns = require 'gitsigns'
+ 'lewis6991/gitsigns.nvim',
+ ---@module 'gitsigns'
+ ---@type Gitsigns.Config
+ ---@diagnostic disable-next-line: missing-fields
+ opts = {
+ on_attach = function(bufnr)
+ local gitsigns = require 'gitsigns'
- local function map(mode, l, r, opts)
- opts = opts or {}
- opts.buffer = bufnr
- vim.keymap.set(mode, l, r, opts)
+ local function map(mode, l, r, opts)
+ opts = opts or {}
+ opts.buffer = bufnr
+ vim.keymap.set(mode, l, r, opts)
+ end
+
+ -- Navigation
+ map('n', ']c', function()
+ if vim.wo.diff then
+ vim.cmd.normal { ']c', bang = true }
+ else
+ gitsigns.nav_hunk 'next'
end
+ end, { desc = 'Jump to next git [c]hange' })
- -- Navigation
- map('n', ']c', function()
- if vim.wo.diff then
- vim.cmd.normal { ']c', bang = true }
- else
- gitsigns.nav_hunk 'next'
- end
- end, { desc = 'Jump to next git [c]hange' })
+ map('n', '[c', function()
+ if vim.wo.diff then
+ vim.cmd.normal { '[c', bang = true }
+ else
+ gitsigns.nav_hunk 'prev'
+ end
+ end, { desc = 'Jump to previous git [c]hange' })
- map('n', '[c', function()
- if vim.wo.diff then
- vim.cmd.normal { '[c', bang = true }
- else
- gitsigns.nav_hunk 'prev'
- end
- end, { desc = 'Jump to previous git [c]hange' })
+ -- Actions
+ -- visual mode
+ map('v', 'hs', function() gitsigns.stage_hunk { vim.fn.line '.', vim.fn.line 'v' } end, { desc = 'git [s]tage hunk' })
+ map('v', 'hr', function() gitsigns.reset_hunk { vim.fn.line '.', vim.fn.line 'v' } end, { desc = 'git [r]eset hunk' })
+ -- normal mode
+ map('n', 'hs', gitsigns.stage_hunk, { desc = 'git [s]tage hunk' })
+ map('n', 'hr', gitsigns.reset_hunk, { desc = 'git [r]eset hunk' })
+ map('n', 'hS', gitsigns.stage_buffer, { desc = 'git [S]tage buffer' })
+ map('n', 'hR', gitsigns.reset_buffer, { desc = 'git [R]eset buffer' })
+ map('n', 'hp', gitsigns.preview_hunk, { desc = 'git [p]review hunk' })
+ map('n', 'hi', gitsigns.preview_hunk_inline, { desc = 'git preview hunk [i]nline' })
+ map('n', 'hb', function() gitsigns.blame_line { full = true } end, { desc = 'git [b]lame line' })
+ map('n', 'hd', gitsigns.diffthis, { desc = 'git [d]iff against index' })
+ map('n', 'hD', function() gitsigns.diffthis '@' end, { desc = 'git [D]iff against last commit' })
+ map('n', 'hQ', function() gitsigns.setqflist 'all' end, { desc = 'git hunk [Q]uickfix list (all files in repo)' })
+ map('n', 'hq', gitsigns.setqflist, { desc = 'git hunk [q]uickfix list (all changes in this file)' })
+ -- Toggles
+ map('n', 'tb', gitsigns.toggle_current_line_blame, { desc = '[T]oggle git show [b]lame line' })
+ map('n', 'tw', gitsigns.toggle_word_diff, { desc = '[T]oggle git intra-line [w]ord diff' })
- -- Actions
- -- visual mode
- map('v', 'hs', function()
- gitsigns.stage_hunk { vim.fn.line '.', vim.fn.line 'v' }
- end, { desc = 'git [s]tage hunk' })
- map('v', 'hr', function()
- gitsigns.reset_hunk { vim.fn.line '.', vim.fn.line 'v' }
- end, { desc = 'git [r]eset hunk' })
- -- normal mode
- map('n', 'hs', gitsigns.stage_hunk, { desc = 'git [s]tage hunk' })
- map('n', 'hr', gitsigns.reset_hunk, { desc = 'git [r]eset hunk' })
- map('n', 'hS', gitsigns.stage_buffer, { desc = 'git [S]tage buffer' })
- map('n', 'hu', gitsigns.stage_hunk, { desc = 'git [u]ndo stage hunk' })
- map('n', 'hR', gitsigns.reset_buffer, { desc = 'git [R]eset buffer' })
- map('n', 'hp', gitsigns.preview_hunk, { desc = 'git [p]review hunk' })
- map('n', 'hb', gitsigns.blame_line, { desc = 'git [b]lame line' })
- map('n', 'hd', gitsigns.diffthis, { desc = 'git [d]iff against index' })
- map('n', 'hD', function()
- gitsigns.diffthis '@'
- end, { desc = 'git [D]iff against last commit' })
- -- Toggles
- map('n', 'tb', gitsigns.toggle_current_line_blame, { desc = '[T]oggle git show [b]lame line' })
- map('n', 'tD', gitsigns.preview_hunk_inline, { desc = '[T]oggle git show [D]eleted' })
- end,
- },
+ -- Text object
+ map({ 'o', 'x' }, 'ih', gitsigns.select_hunk)
+ end,
},
}
diff --git a/lua/kickstart/plugins/indent_line.lua b/lua/kickstart/plugins/indent_line.lua
index ed7f2693..946ac793 100644
--- a/lua/kickstart/plugins/indent_line.lua
+++ b/lua/kickstart/plugins/indent_line.lua
@@ -1,9 +1,13 @@
+-- Add indentation guides even on blank lines
+
+---@module 'lazy'
+---@type LazySpec
return {
- { -- Add indentation guides even on blank lines
- 'lukas-reineke/indent-blankline.nvim',
- -- Enable `lukas-reineke/indent-blankline.nvim`
- -- See `:help ibl`
- main = 'ibl',
- opts = {},
- },
+ 'lukas-reineke/indent-blankline.nvim',
+ -- Enable `lukas-reineke/indent-blankline.nvim`
+ -- See `:help ibl`
+ main = 'ibl',
+ ---@module 'ibl'
+ ---@type ibl.config
+ opts = {},
}
diff --git a/lua/kickstart/plugins/lint.lua b/lua/kickstart/plugins/lint.lua
index dec42f09..556f3178 100644
--- a/lua/kickstart/plugins/lint.lua
+++ b/lua/kickstart/plugins/lint.lua
@@ -1,60 +1,59 @@
+-- Linting
+
+---@module 'lazy'
+---@type LazySpec
return {
+ 'mfussenegger/nvim-lint',
+ event = { 'BufReadPre', 'BufNewFile' },
+ config = function()
+ local lint = require 'lint'
+ lint.linters_by_ft = {
+ markdown = { 'markdownlint' }, -- Make sure to install `markdownlint` via mason / npm
+ }
- { -- Linting
- 'mfussenegger/nvim-lint',
- event = { 'BufReadPre', 'BufNewFile' },
- config = function()
- local lint = require 'lint'
- lint.linters_by_ft = {
- markdown = { 'markdownlint' },
- }
+ -- To allow other plugins to add linters to require('lint').linters_by_ft,
+ -- instead set linters_by_ft like this:
+ -- lint.linters_by_ft = lint.linters_by_ft or {}
+ -- lint.linters_by_ft['markdown'] = { 'markdownlint' }
+ --
+ -- However, note that this will enable a set of default linters,
+ -- which will cause errors unless these tools are available:
+ -- {
+ -- clojure = { "clj-kondo" },
+ -- dockerfile = { "hadolint" },
+ -- inko = { "inko" },
+ -- janet = { "janet" },
+ -- json = { "jsonlint" },
+ -- markdown = { "vale" },
+ -- rst = { "vale" },
+ -- ruby = { "ruby" },
+ -- terraform = { "tflint" },
+ -- text = { "vale" }
+ -- }
+ --
+ -- You can disable the default linters by setting their filetypes to nil:
+ -- lint.linters_by_ft['clojure'] = nil
+ -- lint.linters_by_ft['dockerfile'] = nil
+ -- lint.linters_by_ft['inko'] = nil
+ -- lint.linters_by_ft['janet'] = nil
+ -- lint.linters_by_ft['json'] = nil
+ -- lint.linters_by_ft['markdown'] = nil
+ -- lint.linters_by_ft['rst'] = nil
+ -- lint.linters_by_ft['ruby'] = nil
+ -- lint.linters_by_ft['terraform'] = nil
+ -- lint.linters_by_ft['text'] = nil
- -- To allow other plugins to add linters to require('lint').linters_by_ft,
- -- instead set linters_by_ft like this:
- -- lint.linters_by_ft = lint.linters_by_ft or {}
- -- lint.linters_by_ft['markdown'] = { 'markdownlint' }
- --
- -- However, note that this will enable a set of default linters,
- -- which will cause errors unless these tools are available:
- -- {
- -- clojure = { "clj-kondo" },
- -- dockerfile = { "hadolint" },
- -- inko = { "inko" },
- -- janet = { "janet" },
- -- json = { "jsonlint" },
- -- markdown = { "vale" },
- -- rst = { "vale" },
- -- ruby = { "ruby" },
- -- terraform = { "tflint" },
- -- text = { "vale" }
- -- }
- --
- -- You can disable the default linters by setting their filetypes to nil:
- -- lint.linters_by_ft['clojure'] = nil
- -- lint.linters_by_ft['dockerfile'] = nil
- -- lint.linters_by_ft['inko'] = nil
- -- lint.linters_by_ft['janet'] = nil
- -- lint.linters_by_ft['json'] = nil
- -- lint.linters_by_ft['markdown'] = nil
- -- lint.linters_by_ft['rst'] = nil
- -- lint.linters_by_ft['ruby'] = nil
- -- lint.linters_by_ft['terraform'] = nil
- -- lint.linters_by_ft['text'] = nil
-
- -- Create autocommand which carries out the actual linting
- -- on the specified events.
- local lint_augroup = vim.api.nvim_create_augroup('lint', { clear = true })
- vim.api.nvim_create_autocmd({ 'BufEnter', 'BufWritePost', 'InsertLeave' }, {
- group = lint_augroup,
- callback = function()
- -- Only run the linter in buffers that you can modify in order to
- -- avoid superfluous noise, notably within the handy LSP pop-ups that
- -- describe the hovered symbol using Markdown.
- if vim.bo.modifiable then
- lint.try_lint()
- end
- end,
- })
- end,
- },
+ -- Create autocommand which carries out the actual linting
+ -- on the specified events.
+ local lint_augroup = vim.api.nvim_create_augroup('lint', { clear = true })
+ vim.api.nvim_create_autocmd({ 'BufEnter', 'BufWritePost', 'InsertLeave' }, {
+ group = lint_augroup,
+ callback = function()
+ -- Only run the linter in buffers that you can modify in order to
+ -- avoid superfluous noise, notably within the handy LSP pop-ups that
+ -- describe the hovered symbol using Markdown.
+ if vim.bo.modifiable then lint.try_lint() end
+ end,
+ })
+ end,
}
diff --git a/lua/kickstart/plugins/neo-tree.lua b/lua/kickstart/plugins/neo-tree.lua
index 690cec41..ab35be60 100644
--- a/lua/kickstart/plugins/neo-tree.lua
+++ b/lua/kickstart/plugins/neo-tree.lua
@@ -1,6 +1,8 @@
-- Neo-tree is a Neovim plugin to browse the file system
-- https://github.com/nvim-neo-tree/neo-tree.nvim
+---@module 'lazy'
+---@type LazySpec
return {
'nvim-neo-tree/neo-tree.nvim',
version = '*',
@@ -13,6 +15,8 @@ return {
keys = {
{ '', ':Neotree toggle', desc = 'NeoTree toggle', silent = true },
},
+ ---@module 'neo-tree'
+ ---@type neotree.Config
opts = {
filesystem = {
window = {