From cd7adee3cebd9cc915bbe69db5472b7da479e001 Mon Sep 17 00:00:00 2001 From: orip Date: Mon, 20 Apr 2026 00:45:20 +0300 Subject: [PATCH 01/11] Refactor and update some of the comments --- init.lua | 69 ++++++++++++++++++++++++++++++++------------------------ 1 file changed, 39 insertions(+), 30 deletions(-) diff --git a/init.lua b/init.lua index 8d1f19a10d4..80a1488d1c5 100644 --- a/init.lua +++ b/init.lua @@ -94,7 +94,7 @@ vim.g.maplocalleader = ' ' vim.g.have_nerd_font = false -- [[ Setting options ]] --- See `:help vim.o` +-- See `:help vim.o` -- NOTE: You can change these options as you wish! -- For more options, you can see `:help option-list` @@ -172,7 +172,7 @@ vim.o.confirm = true vim.keymap.set('n', '', 'nohlsearch') -- Diagnostic Config & Keymaps --- See :help vim.diagnostic.Opts +-- See `:help vim.diagnostic.Opts` vim.diagnostic.config { update_in_insert = false, severity_sort = true, @@ -272,8 +272,9 @@ require('lazy').setup({ -- Here is a more advanced example where we pass configuration -- options to `gitsigns.nvim`. -- - -- See `:help gitsigns` to understand what the configuration keys do - { -- Adds git related signs to the gutter, as well as utilities for managing changes + -- See `:help gitsigns` to understand what each configuration keys does. + -- Adds git related signs to the gutter, as well as utilities for managing changes + { 'lewis6991/gitsigns.nvim', ---@module 'gitsigns' ---@type Gitsigns.Config @@ -302,15 +303,16 @@ require('lazy').setup({ -- -- Then, because we use the `opts` key (recommended), the configuration runs -- after the plugin has been loaded as `require(MODULE).setup(opts)`. - - { -- Useful plugin to show you pending keybinds. + -- + -- 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 between pressing a key and opening which-key (milliseconds) delay = 0, icons = { mappings = vim.g.have_nerd_font }, @@ -330,8 +332,9 @@ require('lazy').setup({ -- you do for a plugin at the top level, you can do for a dependency. -- -- Use the `dependencies` key to specify the dependencies of a particular plugin - - { -- Fuzzy Finder (files, lsp, etc) + -- + -- Fuzzy Finder (files, lsp, etc) + { 'nvim-telescope/telescope.nvim', -- By default, Telescope is included and acts as your picker for everything. @@ -346,7 +349,8 @@ require('lazy').setup({ event = 'VimEnter', dependencies = { 'nvim-lua/plenary.nvim', - { -- If encountering errors, see telescope-fzf-native README for installation instructions + -- If encountering errors, see telescope-fzf-native README for installation instructions + { 'nvim-telescope/telescope-fzf-native.nvim', -- `build` is used to run some command when the plugin is installed/updated. @@ -417,8 +421,8 @@ require('lazy').setup({ vim.keymap.set('n', 'sc', builtin.commands, { desc = '[S]earch [C]ommands' }) vim.keymap.set('n', '', builtin.buffers, { desc = '[ ] Find existing buffers' }) - -- 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! + -- Add Telescope-based LSP pickers when an LSP attaches to a buffer. + -- If you later switch picker plugins, this is where to update these mappings. vim.api.nvim_create_autocmd('LspAttach', { group = vim.api.nvim_create_augroup('telescope-lsp-attach', { clear = true }), callback = function(event) @@ -669,7 +673,8 @@ require('lazy').setup({ end, }, - { -- Autoformat + -- Autoformat + { 'stevearc/conform.nvim', event = { 'BufWritePre' }, cmd = { 'ConformInfo' }, @@ -712,7 +717,8 @@ require('lazy').setup({ }, }, - { -- Autocompletion + -- Autocompletion + { 'saghen/blink.cmp', event = 'VimEnter', version = '1.*', @@ -766,7 +772,7 @@ require('lazy').setup({ -- : Hide menu -- : Toggle signature help -- - -- See :h blink-cmp-config-keymap for defining your own keymap + -- See `:help blink-cmp-config-keymap` for defining your own keymap preset = 'default', -- For more advanced Luasnip keymaps (e.g. selecting choice nodes, expansion) see: @@ -797,7 +803,7 @@ require('lazy').setup({ -- By default, we use the Lua implementation instead, but you may enable -- the rust implementation via `'prefer_rust_with_warning'` -- - -- See :h blink-cmp-config-fuzzy for more information + -- See `:help blink-cmp-config-fuzzy` for more information fuzzy = { implementation = 'lua' }, -- Shows a signature help window while you type arguments for a function @@ -805,7 +811,8 @@ require('lazy').setup({ }, }, - { -- You can easily change to a different colorscheme. + { + -- You can easily change to a different colorscheme. -- Change the name of the colorscheme plugin below, and then -- change the command in the config to whatever the name of that colorscheme is. -- @@ -838,7 +845,8 @@ require('lazy').setup({ opts = { signs = false }, }, - { -- Collection of various small independent plugins/modules + -- Collection of various small independent plugins/modules + { 'nvim-mini/mini.nvim', config = function() -- Better Around/Inside textobjects @@ -867,7 +875,7 @@ require('lazy').setup({ -- You could remove this setup call if you don't like it, -- and try some other statusline plugin local statusline = require 'mini.statusline' - -- set use_icons to true if you have a Nerd Font + -- Set `use_icons` to true if you have a Nerd Font statusline.setup { use_icons = vim.g.have_nerd_font } -- You can configure sections in the statusline by overriding their @@ -881,35 +889,36 @@ require('lazy').setup({ end, }, - { -- Highlight, edit, and navigate code + -- Used to highlight, edit, and navigate code + { 'nvim-treesitter/nvim-treesitter', lazy = false, build = ':TSUpdate', branch = 'main', -- [[ Configure Treesitter ]] See `:help nvim-treesitter-intro` config = function() - -- ensure basic parser are installed + -- Ensure basic parsers 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 + -- Check if a parser exists and load it if not vim.treesitter.language.add(language) then return end - -- enables syntax highlighting and other treesitter features + -- Enable syntax highlighting and other treesitter features vim.treesitter.start(buf, language) - -- enables treesitter based folds - -- for more info on folds see `:help folds` + -- Enable 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 + -- 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 + -- Enable treesitter based indentation if has_indent_query then vim.bo.indentexpr = "v:lua.require'nvim-treesitter'.indentexpr()" end end @@ -924,13 +933,13 @@ require('lazy').setup({ local installed_parsers = require('nvim-treesitter').get_installed 'parsers' if vim.tbl_contains(installed_parsers, language) then - -- enable the parser if it is installed + -- Enable the parser if it is already 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 + -- 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` + -- Try to enable treesitter features in case the parser exists but is not available from `nvim-treesitter` treesitter_try_attach(buf, language) end end, From c4605421e52ae77f04fcf2f56d3bbb7a174e7142 Mon Sep 17 00:00:00 2001 From: orip Date: Mon, 20 Apr 2026 01:26:12 +0300 Subject: [PATCH 02/11] Migrate to vim.pack --- .gitignore | 4 +- README.md | 14 +- init.lua | 1316 +++++++++++-------------- lua/custom/plugins/init.lua | 11 +- lua/kickstart/health.lua | 2 +- lua/kickstart/plugins/autopairs.lua | 9 +- lua/kickstart/plugins/debug.lua | 169 ++-- lua/kickstart/plugins/gitsigns.lua | 100 +- lua/kickstart/plugins/indent_line.lua | 15 +- lua/kickstart/plugins/lint.lua | 102 +- lua/kickstart/plugins/neo-tree.lua | 41 +- 11 files changed, 814 insertions(+), 969 deletions(-) diff --git a/.gitignore b/.gitignore index 68486fc3d35..a52bd495579 100644 --- a/.gitignore +++ b/.gitignore @@ -6,9 +6,9 @@ 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 +# nvim-pack-lock.json in version control - see :help vim.pack-lockfile # For the official `nvim-lua/kickstart.nvim` git repository, we leave it ignored to avoid unneeded # merge conflicts. -lazy-lock.json +nvim-pack-lock.json .DS_Store diff --git a/README.md b/README.md index 093e42a6dd9..b3ce45e2416 100644 --- a/README.md +++ b/README.md @@ -69,9 +69,9 @@ fork to your machine using one of the commands below, depending on your OS. > Your fork's URL will be something like this: > `https://github.com//kickstart.nvim.git` -You likely want to remove `lazy-lock.json` from your fork's `.gitignore` file -too - it's ignored in the kickstart repo to make maintenance easier, but it's -[recommended to track it in version control](https://lazy.folke.io/usage/lockfile). +You likely want to remove `nvim-pack-lock.json` from your fork's `.gitignore` +file too - it's ignored in the kickstart repo to make maintenance easier, but +it's recommended to track it in version control (see `:help vim.pack-lockfile`). #### Clone kickstart.nvim @@ -111,8 +111,9 @@ Start Neovim nvim ``` -That's it! Lazy will install all the plugins you have. Use `:Lazy` to view -the current plugin status. Hit `q` to close the window. +That's it! `vim.pack` will install all the plugins from your config. Use +`:lua vim.pack.update(nil, { offline = true })` to inspect plugin state and +`:lua vim.pack.update()` to fetch updates. #### Read The Friendly Documentation @@ -146,7 +147,8 @@ examples of adding popularly requested plugins. `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out. * What if I want to "uninstall" this configuration: - * See [lazy.nvim uninstall](https://lazy.folke.io/usage#-uninstalling) information + * Remove your config directory and local data directory (for example, + `~/.config/nvim` and `~/.local/share/nvim`). * Why is the kickstart `init.lua` a single file? Wouldn't it make sense to split it into multiple files? * The main purpose of kickstart is to serve as a teaching tool and a reference configuration that someone can easily use to `git clone` as a basis for their own. diff --git a/init.lua b/init.lua index 80a1488d1c5..f9ee55a01c7 100644 --- a/init.lua +++ b/init.lua @@ -230,770 +230,650 @@ vim.api.nvim_create_autocmd('TextYankPost', { callback = function() vim.hl.on_yank() end, }) --- [[ Install `lazy.nvim` plugin manager ]] --- See `:help lazy.nvim.txt` or https://github.com/folke/lazy.nvim for more info -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 +-- [[ Configure and install plugins with `vim.pack` ]] +-- +-- To inspect plugin state and pending updates, run +-- :lua vim.pack.update(nil, { offline = true }) +-- +-- To update plugins, run +-- :lua vim.pack.update() +-- +-- NOTE: Here is where you install your plugins. +local gh = function(repo) return 'https://github.com/' .. repo end + +local run_build = function(name, cmd, cwd) + local result = vim.system(cmd, { cwd = cwd }):wait() + if result.code ~= 0 then + local stderr = result.stderr or '' + local stdout = result.stdout or '' + local output = stderr ~= '' and stderr or stdout + if output == '' then output = 'No output from build command.' end + vim.notify(('Build failed for %s:\n%s'):format(name, output), vim.log.levels.ERROR) + end end ----@type vim.Option -local rtp = vim.opt.rtp -rtp:prepend(lazypath) +vim.api.nvim_create_autocmd('PackChanged', { + callback = function(ev) + local name = ev.data.spec.name + local kind = ev.data.kind + if kind ~= 'install' and kind ~= 'update' then return end + + if name == 'telescope-fzf-native.nvim' and vim.fn.executable 'make' == 1 then + run_build(name, { 'make' }, ev.data.path) + return + end + + if name == 'LuaSnip' then + if vim.fn.has 'win32' ~= 1 and vim.fn.executable 'make' == 1 then run_build(name, { 'make', 'install_jsregexp' }, ev.data.path) end + return + end + + if name == 'nvim-treesitter' then + if not ev.data.active then vim.cmd.packadd 'nvim-treesitter' end + vim.cmd 'TSUpdate' + return + end + end, +}) + +---@type (string|vim.pack.Spec)[] +local plugins = { + gh 'NMAC427/guess-indent.nvim', + gh 'lewis6991/gitsigns.nvim', + gh 'folke/which-key.nvim', + gh 'nvim-lua/plenary.nvim', + gh 'nvim-telescope/telescope.nvim', + gh 'nvim-telescope/telescope-ui-select.nvim', + gh 'neovim/nvim-lspconfig', + gh 'mason-org/mason.nvim', + gh 'mason-org/mason-lspconfig.nvim', + gh 'WhoIsSethDaniel/mason-tool-installer.nvim', + gh 'j-hui/fidget.nvim', + gh 'stevearc/conform.nvim', + { src = gh 'saghen/blink.cmp', version = vim.version.range '1.*' }, + { src = gh 'L3MON4D3/LuaSnip', version = vim.version.range '2.*' }, + gh 'folke/tokyonight.nvim', + gh 'folke/todo-comments.nvim', + gh 'nvim-mini/mini.nvim', + { src = gh 'nvim-treesitter/nvim-treesitter', version = 'main' }, +} + +if vim.fn.executable 'make' == 1 then table.insert(plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') end + +-- Useful for getting pretty icons, but requires a Nerd Font. +if vim.g.have_nerd_font then table.insert(plugins, gh 'nvim-tree/nvim-web-devicons') end + +vim.pack.add(plugins) + +require('guess-indent').setup {} + +-- Here is a more advanced example that passes configuration options to `gitsigns.nvim` +-- +-- See `:help gitsigns` to understand what each configuration key does. +-- Adds git related signs to the gutter, as well as utilities for managing changes +require('gitsigns').setup { + signs = { + 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 + }, +} + +-- Useful plugin to show you pending keybinds. +require('which-key').setup { + -- Delay between pressing a key and opening which-key (milliseconds) + delay = 0, + icons = { mappings = vim.g.have_nerd_font }, + -- Document existing key chains + spec = { + { 's', group = '[S]earch', mode = { 'n', 'v' } }, + { 't', group = '[T]oggle' }, + { 'h', group = 'Git [H]unk', mode = { 'n', 'v' } }, -- Enable gitsigns recommended keymaps first + { 'gr', group = 'LSP Actions', mode = { 'n' } }, + }, +} +-- Fuzzy Finder (files, lsp, etc) +-- +-- By default, Telescope is included and acts as your picker for everything. + +-- # TODO: Rework this docstring +-- +-- 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') --- [[ Configure and install plugins ]] +-- 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. -- --- To check the current status of your plugins, run --- :Lazy +-- Telescope is a fuzzy finder that comes with a lot of different things that +-- it can fuzzy find! It's more than just a "file finder", it can search +-- many different aspects of Neovim, your workspace, LSP, and more! -- --- You can press `?` in this menu for help. Use `:q` to close the window +-- The easiest way to use Telescope, is to start by doing something like: +-- :Telescope help_tags -- --- To update plugins you can run --- :Lazy update +-- After running this command, a window will open up and you're able to +-- type in the prompt window. You'll see a list of `help_tags` options and +-- a corresponding preview of the help. -- --- NOTE: Here is where you install your plugins. -require('lazy').setup({ - -- 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: - -- { - -- 'lewis6991/gitsigns.nvim', - -- config = function() - -- require('gitsigns').setup({ - -- -- Your gitsigns configuration here - -- }) - -- end, - -- } - -- - -- Here is a more advanced example where we pass configuration - -- options to `gitsigns.nvim`. +-- Two important keymaps to use while in Telescope are: +-- - Insert mode: +-- - Normal mode: ? +-- +-- This opens a window that shows you all of the keymaps for the current +-- Telescope picker. This is really useful to discover what Telescope can +-- do as well as how to actually do it! + +-- [[ Configure Telescope ]] +-- See `:help telescope` and `:help telescope.setup()` +require('telescope').setup { + -- You can put your default mappings / updates / etc. in here + -- All the info you're looking for is in `:help telescope.setup()` -- - -- See `:help gitsigns` to understand what each configuration keys does. - -- 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 = '+' }, ---@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 - }, - }, + -- defaults = { + -- mappings = { + -- i = { [''] = 'to_fuzzy_refine' }, + -- }, + -- }, + -- pickers = {} + extensions = { + ['ui-select'] = { require('telescope.themes').get_dropdown() }, }, +} - -- NOTE: Plugins can also be configured to run Lua code when they are loaded. - -- - -- This is often very useful to both group configuration, as well as handle - -- lazy loading plugins that don't need to be loaded immediately at startup. - -- - -- For example, in the following configuration, we use: - -- event = 'VimEnter' - -- - -- which loads which-key before all the UI elements are loaded. Events can be - -- normal autocommands events (`:help autocmd-events`). - -- - -- Then, because we use the `opts` key (recommended), the configuration runs - -- after the plugin has been loaded as `require(MODULE).setup(opts)`. - -- - -- 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, - icons = { mappings = vim.g.have_nerd_font }, - - -- Document existing key chains - spec = { - { 's', group = '[S]earch', mode = { 'n', 'v' } }, - { 't', group = '[T]oggle' }, - { 'h', group = 'Git [H]unk', mode = { 'n', 'v' } }, -- Enable gitsigns recommended keymaps first - { 'gr', group = 'LSP Actions', mode = { 'n' } }, - }, - }, - }, +-- Enable Telescope extensions if they are installed +pcall(require('telescope').load_extension, 'fzf') +pcall(require('telescope').load_extension, 'ui-select') + +-- See `:help telescope.builtin` +local builtin = require 'telescope.builtin' +vim.keymap.set('n', 'sh', builtin.help_tags, { desc = '[S]earch [H]elp' }) +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', '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' }) + +-- Add Telescope-based LSP pickers when an LSP attaches to a buffer. +-- If you later switch picker plugins, this is where to update these mappings. +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, +}) - -- NOTE: Plugins can specify dependencies. - -- - -- The dependencies are proper plugin specifications as well - anything - -- you do for a plugin at the top level, you can do for a dependency. - -- - -- Use the `dependencies` key to specify the dependencies of a particular plugin - -- - -- 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', - -- If encountering errors, see telescope-fzf-native README for installation instructions - { - 'nvim-telescope/telescope-fzf-native.nvim', - - -- `build` is used to run some command when the plugin is installed/updated. - -- This is only run then, not every time Neovim starts up. - build = 'make', - - -- `cond` is a condition used to determine whether this plugin should be - -- installed and loaded. - cond = function() return vim.fn.executable 'make' == 1 end, - }, - { 'nvim-telescope/telescope-ui-select.nvim' }, +-- 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 { + winblend = 10, + previewer = false, + }) +end, { desc = '[/] Fuzzily search in current buffer' }) + +-- 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' } +) + +-- 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' }) + +-- LSP Plugins + +-- 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. +require('mason').setup {} + +-- Useful status updates for LSP. +require('fidget').setup {} + +-- Brief aside: **What is LSP?** +-- +-- LSP is an initialism you've probably heard, but might not understand what it is. +-- +-- LSP stands for Language Server Protocol. It's a protocol that helps editors +-- and language tooling communicate in a standardized fashion. +-- +-- In general, you have a "server" which is some tool built to understand a particular +-- language (such as `gopls`, `lua_ls`, `rust_analyzer`, etc.). These Language Servers +-- (sometimes called LSP servers, but that's kind of like ATM Machine) are standalone +-- processes that communicate with some "client" - in this case, Neovim! +-- +-- LSP provides Neovim with features like: +-- - Go to definition +-- - Find references +-- - Autocompletion +-- - Symbol Search +-- - and more! +-- +-- Thus, Language Servers are external tools that must be installed separately from +-- Neovim. This is where `mason` and related plugins come into play. +-- +-- If you're wondering about lsp vs treesitter, you can check out the wonderfully +-- and elegantly composed help section, `:help lsp-vs-treesitter` + +-- This function gets run when an LSP attaches to a particular buffer. +-- That is to say, every time a new file is opened that is associated with +-- an lsp (for example, opening `main.rs` is associated with `rust_analyzer`) this +-- function will be executed to configure the current buffer +vim.api.nvim_create_autocmd('LspAttach', { + group = vim.api.nvim_create_augroup('kickstart-lsp-attach', { clear = true }), + callback = function(event) + -- NOTE: Remember that Lua is a real programming language, and as such it is possible + -- to define small helper and utility functions so you don't have to repeat yourself. + -- + -- In this case, we create a function that lets us more easily define mappings specific + -- for LSP related items. It sets the mode, buffer and description for us each time. + local map = function(keys, func, desc, mode) + mode = mode or 'n' + vim.keymap.set(mode, keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc }) + end + + -- Rename the variable under your cursor. + -- Most Language Servers support renaming across files, etc. + map('grn', vim.lsp.buf.rename, '[R]e[n]ame') + + -- Execute a code action, usually your cursor needs to be on top of an error + -- or a suggestion from your LSP for this to activate. + map('gra', vim.lsp.buf.code_action, '[G]oto Code [A]ction', { 'n', 'x' }) + + -- 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') + + -- The following two autocommands are used to highlight references of the + -- word under your cursor when your cursor rests there for a little while. + -- See `:help CursorHold` for information about when this is executed + -- + -- 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('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, + group = highlight_augroup, + callback = vim.lsp.buf.document_highlight, + }) - -- Useful for getting pretty icons, but requires a Nerd Font. - { 'nvim-tree/nvim-web-devicons', enabled = vim.g.have_nerd_font }, - }, - config = function() - -- Telescope is a fuzzy finder that comes with a lot of different things that - -- it can fuzzy find! It's more than just a "file finder", it can search - -- many different aspects of Neovim, your workspace, LSP, and more! - -- - -- The easiest way to use Telescope, is to start by doing something like: - -- :Telescope help_tags - -- - -- After running this command, a window will open up and you're able to - -- type in the prompt window. You'll see a list of `help_tags` options and - -- a corresponding preview of the help. - -- - -- Two important keymaps to use while in Telescope are: - -- - Insert mode: - -- - Normal mode: ? - -- - -- This opens a window that shows you all of the keymaps for the current - -- Telescope picker. This is really useful to discover what Telescope can - -- do as well as how to actually do it! - - -- [[ Configure Telescope ]] - -- See `:help telescope` and `:help telescope.setup()` - require('telescope').setup { - -- You can put your default mappings / updates / etc. in here - -- All the info you're looking for is in `:help telescope.setup()` - -- - -- defaults = { - -- mappings = { - -- i = { [''] = 'to_fuzzy_refine' }, - -- }, - -- }, - -- pickers = {} - extensions = { - ['ui-select'] = { require('telescope.themes').get_dropdown() }, - }, - } - - -- Enable Telescope extensions if they are installed - pcall(require('telescope').load_extension, 'fzf') - pcall(require('telescope').load_extension, 'ui-select') - - -- See `:help telescope.builtin` - local builtin = require 'telescope.builtin' - vim.keymap.set('n', 'sh', builtin.help_tags, { desc = '[S]earch [H]elp' }) - 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', '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' }) - - -- Add Telescope-based LSP pickers when an LSP attaches to a buffer. - -- If you later switch picker plugins, this is where to update these mappings. - 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, + vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, { + buffer = event.buf, + group = highlight_augroup, + callback = vim.lsp.buf.clear_references, }) - -- 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 { - winblend = 10, - previewer = false, - }) - end, { desc = '[/] Fuzzily search in current buffer' }) - - -- 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', - } + vim.api.nvim_create_autocmd('LspDetach', { + group = vim.api.nvim_create_augroup('kickstart-lsp-detach', { clear = true }), + callback = function(event2) + vim.lsp.buf.clear_references() + vim.api.nvim_clear_autocmds { group = 'kickstart-lsp-highlight', buffer = event2.buf } 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' }) - end, - }, + }) + end - -- LSP Plugins - { - -- Main LSP Configuration - 'neovim/nvim-lspconfig', - dependencies = { - -- 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', - ---@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', + -- The following code creates a keymap to toggle inlay hints in your + -- 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('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, +}) - -- Useful status updates for LSP. - { 'j-hui/fidget.nvim', opts = {} }, - }, - config = function() - -- Brief aside: **What is LSP?** - -- - -- LSP is an initialism you've probably heard, but might not understand what it is. - -- - -- LSP stands for Language Server Protocol. It's a protocol that helps editors - -- and language tooling communicate in a standardized fashion. - -- - -- In general, you have a "server" which is some tool built to understand a particular - -- language (such as `gopls`, `lua_ls`, `rust_analyzer`, etc.). These Language Servers - -- (sometimes called LSP servers, but that's kind of like ATM Machine) are standalone - -- processes that communicate with some "client" - in this case, Neovim! - -- - -- LSP provides Neovim with features like: - -- - Go to definition - -- - Find references - -- - Autocompletion - -- - Symbol Search - -- - and more! - -- - -- Thus, Language Servers are external tools that must be installed separately from - -- Neovim. This is where `mason` and related plugins come into play. - -- - -- If you're wondering about lsp vs treesitter, you can check out the wonderfully - -- and elegantly composed help section, `:help lsp-vs-treesitter` - - -- This function gets run when an LSP attaches to a particular buffer. - -- That is to say, every time a new file is opened that is associated with - -- an lsp (for example, opening `main.rs` is associated with `rust_analyzer`) this - -- function will be executed to configure the current buffer - vim.api.nvim_create_autocmd('LspAttach', { - group = vim.api.nvim_create_augroup('kickstart-lsp-attach', { clear = true }), - callback = function(event) - -- NOTE: Remember that Lua is a real programming language, and as such it is possible - -- to define small helper and utility functions so you don't have to repeat yourself. - -- - -- In this case, we create a function that lets us more easily define mappings specific - -- for LSP related items. It sets the mode, buffer and description for us each time. - local map = function(keys, func, desc, mode) - mode = mode or 'n' - vim.keymap.set(mode, keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc }) - end - - -- Rename the variable under your cursor. - -- Most Language Servers support renaming across files, etc. - map('grn', vim.lsp.buf.rename, '[R]e[n]ame') - - -- Execute a code action, usually your cursor needs to be on top of an error - -- or a suggestion from your LSP for this to activate. - map('gra', vim.lsp.buf.code_action, '[G]oto Code [A]ction', { 'n', 'x' }) - - -- 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') - - -- The following two autocommands are used to highlight references of the - -- word under your cursor when your cursor rests there for a little while. - -- See `:help CursorHold` for information about when this is executed - -- - -- 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('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, - group = highlight_augroup, - callback = vim.lsp.buf.document_highlight, - }) - - vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, { - buffer = event.buf, - group = highlight_augroup, - callback = vim.lsp.buf.clear_references, - }) - - vim.api.nvim_create_autocmd('LspDetach', { - group = vim.api.nvim_create_augroup('kickstart-lsp-detach', { clear = true }), - callback = function(event2) - vim.lsp.buf.clear_references() - vim.api.nvim_clear_autocmds { group = 'kickstart-lsp-highlight', buffer = event2.buf } - end, - }) - end - - -- The following code creates a keymap to toggle inlay hints in your - -- 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('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, - }) +-- Enable the following language servers +-- Feel free to add/remove any LSPs that you want here. They will automatically be installed. +-- See `:help lsp-config` for information about keys and how to configure +---@type table +local servers = { + -- clangd = {}, + -- gopls = {}, + -- pyright = {}, + -- rust_analyzer = {}, + -- + -- 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 = {}, - -- Enable the following language servers - -- Feel free to add/remove any LSPs that you want here. They will automatically be installed. - -- See `:help lsp-config` for information about keys and how to configure - ---@type table - local servers = { - -- clangd = {}, - -- gopls = {}, - -- pyright = {}, - -- rust_analyzer = {}, - -- - -- 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 = { - 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 = { - format = { enable = false }, -- Disable formatting (formatting is done by stylua) - }, - }, - }, - } - - -- Ensure the servers and tools above are installed - -- - -- To check the current status of installed tools and/or manually install - -- other tools, you can run - -- :Mason - -- - -- You can press `g?` for help in this menu. - local ensure_installed = vim.tbl_keys(servers or {}) - vim.list_extend(ensure_installed, { - -- You can add other tools here that you want Mason to install - }) + stylua = {}, -- Used to format Lua code - require('mason-tool-installer').setup { ensure_installed = ensure_installed } + -- Special Lua Config, as recommended by neovim help docs + lua_ls = { + on_init = function(client) + client.server_capabilities.documentFormattingProvider = false -- Disable formatting (formatting is done by stylua) - for name, server in pairs(servers) do - vim.lsp.config(name, server) - vim.lsp.enable(name) + 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 - end, - }, - -- Autoformat - { - 'stevearc/conform.nvim', - event = { 'BufWritePre' }, - cmd = { 'ConformInfo' }, - keys = { - { - 'f', - 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) - -- 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 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 = { - -- rust = { 'rustfmt' }, - -- Conform can also run multiple formatters sequentially - -- python = { "isort", "black" }, - -- - -- You can use 'stop_after_first' to run the first available formatter from the list - -- javascript = { "prettierd", "prettier", stop_after_first = true }, - }, - }, - }, - - -- Autocompletion - { - 'saghen/blink.cmp', - event = 'VimEnter', - version = '1.*', - dependencies = { - -- Snippet Engine - { - 'L3MON4D3/LuaSnip', - version = '2.*', - build = (function() - -- 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 - return 'make install_jsregexp' - end)(), - dependencies = { - -- `friendly-snippets` contains a variety of premade snippets. - -- See the README about individual language/framework/plugin snippets: - -- https://github.com/rafamadriz/friendly-snippets - -- { - -- 'rafamadriz/friendly-snippets', - -- config = function() - -- require('luasnip.loaders.from_vscode').lazy_load() - -- end, - -- }, + client.config.settings.Lua = vim.tbl_deep_extend('force', client.config.settings.Lua, { + runtime = { + version = 'LuaJIT', + path = { 'lua/?.lua', 'lua/?/init.lua' }, }, - opts = {}, + 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 = { + format = { enable = false }, -- Disable formatting (formatting is done by stylua) }, }, - ---@module 'blink.cmp' - ---@type blink.cmp.Config - opts = { - keymap = { - -- 'default' (recommended) for mappings similar to built-in completions - -- to accept ([y]es) the completion. - -- This will auto-import if your LSP supports it. - -- This will expand snippets if the LSP sent a snippet. - -- 'super-tab' for tab to accept - -- 'enter' for enter to accept - -- 'none' for no mappings - -- - -- For an understanding of why the 'default' preset is recommended, - -- you will need to read `:help ins-completion` - -- - -- No, but seriously. Please read `:help ins-completion`, it is really good! - -- - -- All presets have the following mappings: - -- /: move to right/left of your snippet expansion - -- : Open menu or open docs if already open - -- / or /: Select next/previous item - -- : Hide menu - -- : Toggle signature help - -- - -- See `:help blink-cmp-config-keymap` for defining your own keymap - preset = 'default', - - -- For more advanced Luasnip keymaps (e.g. selecting choice nodes, expansion) see: - -- https://github.com/L3MON4D3/LuaSnip?tab=readme-ov-file#keymaps - }, - - appearance = { - -- 'mono' (default) for 'Nerd Font Mono' or 'normal' for 'Nerd Font' - -- Adjusts spacing to ensure icons are aligned - nerd_font_variant = 'mono', - }, - - completion = { - -- By default, you may press `` to show the documentation. - -- Optionally, set `auto_show = true` to show the documentation after a delay. - documentation = { auto_show = false, auto_show_delay_ms = 500 }, - }, + }, +} - sources = { - default = { 'lsp', 'path', 'snippets' }, - }, +-- Ensure the servers and tools above are installed +-- +-- To check the current status of installed tools and/or manually install +-- other tools, you can run +-- :Mason +-- +-- You can press `g?` for help in this menu. +local ensure_installed = vim.tbl_keys(servers or {}) +vim.list_extend(ensure_installed, { + -- You can add other tools here that you want Mason to install +}) - snippets = { preset = 'luasnip' }, +require('mason-tool-installer').setup { ensure_installed = ensure_installed } - -- Blink.cmp includes an optional, recommended rust fuzzy matcher, - -- which automatically downloads a prebuilt binary when enabled. - -- - -- By default, we use the Lua implementation instead, but you may enable - -- the rust implementation via `'prefer_rust_with_warning'` - -- - -- See `:help blink-cmp-config-fuzzy` for more information - fuzzy = { implementation = 'lua' }, +for name, server in pairs(servers) do + vim.lsp.config(name, server) + vim.lsp.enable(name) +end - -- Shows a signature help window while you type arguments for a function - signature = { enabled = true }, - }, +-- Autoformat +require('conform').setup { + notify_on_error = false, + format_on_save = function(bufnr) + -- 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 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 = { + -- rust = { 'rustfmt' }, + -- Conform can also run multiple formatters sequentially + -- python = { "isort", "black" }, + -- + -- You can use 'stop_after_first' to run the first available formatter from the list + -- javascript = { "prettierd", "prettier", stop_after_first = true }, }, +} - { - -- You can easily change to a different colorscheme. - -- Change the name of the colorscheme plugin below, and then - -- change the command in the config to whatever the name of that colorscheme is. +vim.keymap.set({ 'n', 'v' }, 'f', function() require('conform').format { async = true } end, { desc = '[F]ormat buffer' }) + +-- Snippet Engine +-- +-- `friendly-snippets` contains a variety of premade snippets. +-- See the README about individual language/framework/plugin snippets: +-- https://github.com/rafamadriz/friendly-snippets +-- +-- vim.pack.add { gh 'rafamadriz/friendly-snippets' } +-- require('luasnip.loaders.from_vscode').lazy_load() +require('luasnip').setup {} + +-- Autocompletion +require('blink.cmp').setup { + keymap = { + -- 'default' (recommended) for mappings similar to built-in completions + -- to accept ([y]es) the completion. + -- This will auto-import if your LSP supports it. + -- This will expand snippets if the LSP sent a snippet. + -- 'super-tab' for tab to accept + -- 'enter' for enter to accept + -- 'none' for no mappings -- - -- If you want to see what colorschemes are already installed, you can use `:Telescope colorscheme`. - 'folke/tokyonight.nvim', - priority = 1000, -- Make sure to load this before all the other start plugins. - config = function() - ---@diagnostic disable-next-line: missing-fields - require('tokyonight').setup { - styles = { - comments = { italic = false }, -- Disable italics in comments - }, - } + -- For an understanding of why the 'default' preset is recommended, + -- you will need to read `:help ins-completion` + -- + -- No, but seriously. Please read `:help ins-completion`, it is really good! + -- + -- All presets have the following mappings: + -- /: move to right/left of your snippet expansion + -- : Open menu or open docs if already open + -- / or /: Select next/previous item + -- : Hide menu + -- : Toggle signature help + -- + -- See `:help blink-cmp-config-keymap` for defining your own keymap + preset = 'default', - -- Load the colorscheme here. - -- Like many other themes, this one has different styles, and you could load - -- any other, such as 'tokyonight-storm', 'tokyonight-moon', or 'tokyonight-day'. - vim.cmd.colorscheme 'tokyonight-night' - end, + -- For more advanced Luasnip keymaps (e.g. selecting choice nodes, expansion) see: + -- https://github.com/L3MON4D3/LuaSnip?tab=readme-ov-file#keymaps }, - -- Highlight todo, notes, etc in comments - { - '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 }, + appearance = { + -- 'mono' (default) for 'Nerd Font Mono' or 'normal' for 'Nerd Font' + -- Adjusts spacing to ensure icons are aligned + nerd_font_variant = 'mono', }, - -- Collection of various small independent plugins/modules - { - 'nvim-mini/mini.nvim', - config = function() - -- Better Around/Inside textobjects - -- - -- Examples: - -- - va) - [V]isually select [A]round [)]paren - -- - yiiq - [Y]ank [I]nside [I]+1 [Q]uote - -- - ci' - [C]hange [I]nside [']quote - 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.) - -- - -- - saiw) - [S]urround [A]dd [I]nner [W]ord [)]Paren - -- - sd' - [S]urround [D]elete [']quotes - -- - sr)' - [S]urround [R]eplace [)] ['] - require('mini.surround').setup() - - -- Simple and easy statusline. - -- You could remove this setup call if you don't like it, - -- and try some other statusline plugin - local statusline = require 'mini.statusline' - -- Set `use_icons` to true if you have a Nerd Font - statusline.setup { use_icons = vim.g.have_nerd_font } - - -- You can configure sections in the statusline by overriding their - -- 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 - - -- ... and there is more! - -- Check out: https://github.com/nvim-mini/mini.nvim - end, + completion = { + -- By default, you may press `` to show the documentation. + -- Optionally, set `auto_show = true` to show the documentation after a delay. + documentation = { auto_show = false, auto_show_delay_ms = 500 }, }, - -- Used to highlight, edit, and navigate code - { - 'nvim-treesitter/nvim-treesitter', - lazy = false, - build = ':TSUpdate', - branch = 'main', - -- [[ Configure Treesitter ]] See `:help nvim-treesitter-intro` - config = function() - -- Ensure basic parsers 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 a parser exists and load it - if not vim.treesitter.language.add(language) then return end - -- Enable syntax highlighting and other treesitter features - vim.treesitter.start(buf, language) - - -- Enable 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 - - -- Enable 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 already 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, + sources = { + default = { 'lsp', 'path', 'snippets' }, }, - -- The following comments only work if you have downloaded the kickstart repo, not just copy pasted the - -- init.lua. If you want these files, they are in the repository, so you can just download them and - -- place them in the correct locations. + snippets = { preset = 'luasnip' }, - -- NOTE: Next step on your Neovim journey: Add/Configure additional plugins for Kickstart - -- - -- Here are some example plugins that I've included in the Kickstart repository. - -- Uncomment any of the lines below to enable them (you will need to restart nvim). - -- - -- require 'kickstart.plugins.debug', - -- require 'kickstart.plugins.indent_line', - -- require 'kickstart.plugins.lint', - -- require 'kickstart.plugins.autopairs', - -- require 'kickstart.plugins.neo-tree', - -- require 'kickstart.plugins.gitsigns', -- adds gitsigns recommended keymaps - - -- NOTE: The import below can automatically add your own plugins, configuration, etc from `lua/custom/plugins/*.lua` - -- This is the easiest way to modularize your config. + -- Blink.cmp includes an optional, recommended rust fuzzy matcher, + -- which automatically downloads a prebuilt binary when enabled. -- - -- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going. - -- { import = 'custom.plugins' }, + -- By default, we use the Lua implementation instead, but you may enable + -- the rust implementation via `'prefer_rust_with_warning'` -- - -- For additional information with loading, sourcing and examples see `:help lazy.nvim-🔌-plugin-spec` - -- 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 - icons = vim.g.have_nerd_font and {} or { - cmd = '⌘', - config = '🛠', - event = '📅', - ft = '📂', - init = '⚙', - keys = '🗝', - plugin = '🔌', - runtime = '💻', - require = '🌙', - source = '📄', - start = '🚀', - task = '📌', - lazy = '💤 ', - }, + -- See `:help blink-cmp-config-fuzzy` for more information + fuzzy = { implementation = 'lua' }, + + -- Shows a signature help window while you type arguments for a function + signature = { enabled = true }, +} + +-- You can easily change to a different colorscheme. +-- Change the name of the colorscheme plugin below, and then +-- change the command in the config to whatever the name of that colorscheme is. +-- +-- If you want to see what colorschemes are already installed, you can use `:Telescope colorscheme`. +---@diagnostic disable-next-line: missing-fields +require('tokyonight').setup { + styles = { + comments = { italic = false }, -- Disable italics in comments }, +} + +-- Load the colorscheme here. +-- Like many other themes, this one has different styles, and you could load +-- any other, such as 'tokyonight-storm', 'tokyonight-moon', or 'tokyonight-day'. +vim.cmd.colorscheme 'tokyonight-night' + +-- Highlight todo, notes, etc in comments +require('todo-comments').setup { signs = false } + +-- Collection of various small independent plugins/modules + +-- Better Around/Inside textobjects +-- +-- Examples: +-- - va) - [V]isually select [A]round [)]paren +-- - yiiq - [Y]ank [I]nside [I]+1 [Q]uote +-- - ci' - [C]hange [I]nside [']quote +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.) +-- +-- - saiw) - [S]urround [A]dd [I]nner [W]ord [)]Paren +-- - sd' - [S]urround [D]elete [']quotes +-- - sr)' - [S]urround [R]eplace [)] ['] +require('mini.surround').setup() + +-- Simple and easy statusline. +-- You could remove this setup call if you don't like it, +-- and try some other statusline plugin +local statusline = require 'mini.statusline' +-- Set `use_icons` to true if you have a Nerd Font +statusline.setup { use_icons = vim.g.have_nerd_font } + +-- You can configure sections in the statusline by overriding their +-- 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 + +-- ... and there is more! +-- Check out: https://github.com/nvim-mini/mini.nvim + +-- [[ Configure Treesitter ]] +-- Used to highlight, edit, and navigate code +-- +-- See `:help nvim-treesitter-intro` + +-- Ensure basic parsers 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 a parser exists and load it + if not vim.treesitter.language.add(language) then return end + -- Enable syntax highlighting and other treesitter features + vim.treesitter.start(buf, language) + + -- Enable 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 + + -- Enable 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 already 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, }) +-- The following comments only work if you have downloaded the kickstart repo, not just copy pasted the +-- init.lua. If you want these files, they are in the repository, so you can just download them and +-- place them in the correct locations. + +-- NOTE: Next step on your Neovim journey: Add/Configure additional plugins for Kickstart +-- +-- Here are some example plugins that I've included in the Kickstart repository. +-- Uncomment any of the lines below to enable them (you will need to restart nvim). +-- +-- require 'kickstart.plugins.debug' +-- require 'kickstart.plugins.indent_line' +-- require 'kickstart.plugins.lint' +-- require 'kickstart.plugins.autopairs' +-- require 'kickstart.plugins.neo-tree' +-- require 'kickstart.plugins.gitsigns' -- adds gitsigns recommended keymaps + +-- NOTE: You can add your own plugins, configuration, etc from `lua/custom/plugins/*.lua` +-- +-- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going. +-- require 'custom.plugins' +-- +-- For additional information with loading, sourcing and examples see `:help vim.pack` +-- and `:help vim.pack-examples` + -- The line beneath this is called `modeline`. See `:help modeline` -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/custom/plugins/init.lua b/lua/custom/plugins/init.lua index b3ddcfdd3aa..c05db465ea5 100644 --- a/lua/custom/plugins/init.lua +++ b/lua/custom/plugins/init.lua @@ -3,6 +3,11 @@ -- -- See the kickstart.nvim README for more information ----@module 'lazy' ----@type LazySpec -return {} +-- Iterate over all Lua files in the plugins directory and load them +local plugins_dir = vim.fs.joinpath(vim.fn.stdpath 'config', 'lua', 'custom', 'plugins') +for file_name, type in vim.fs.dir(plugins_dir) do + if type == 'file' and file_name:match '%.lua$' and file_name ~= 'init.lua' then + local module = file_name:gsub('%.lua$', '') + require('custom.plugins.' .. module) + end +end diff --git a/lua/kickstart/health.lua b/lua/kickstart/health.lua index ca684516003..9910238148f 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.11') then + if vim.version.ge(vim.version(), '0.12') 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 351dad86cd5..1d2cdab098d 100644 --- a/lua/kickstart/plugins/autopairs.lua +++ b/lua/kickstart/plugins/autopairs.lua @@ -1,10 +1,5 @@ -- autopairs -- https://github.com/windwp/nvim-autopairs ----@module 'lazy' ----@type LazySpec -return { - 'windwp/nvim-autopairs', - event = 'InsertEnter', - opts = {}, -} +vim.pack.add { 'https://github.com/windwp/nvim-autopairs' } +require('nvim-autopairs').setup {} diff --git a/lua/kickstart/plugins/debug.lua b/lua/kickstart/plugins/debug.lua index 7e58905e830..db5448c2cfc 100644 --- a/lua/kickstart/plugins/debug.lua +++ b/lua/kickstart/plugins/debug.lua @@ -6,105 +6,90 @@ -- 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', - -- NOTE: And you can specify dependencies as well - dependencies = { - -- Creates a beautiful debugger UI - 'rcarriga/nvim-dap-ui', +vim.pack.add { + 'https://github.com/mfussenegger/nvim-dap', + 'https://github.com/rcarriga/nvim-dap-ui', + 'https://github.com/nvim-neotest/nvim-nio', + 'https://github.com/mason-org/mason.nvim', + 'https://github.com/jay-babu/mason-nvim-dap.nvim', + 'https://github.com/leoluz/nvim-dap-go', +} - -- Required dependency for nvim-dap-ui - 'nvim-neotest/nvim-nio', +-- Basic debugging keymaps, feel free to change to your liking! +vim.keymap.set('n', '', function() require('dap').continue() end, { desc = 'Debug: Start/Continue' }) +vim.keymap.set('n', '', function() require('dap').step_into() end, { desc = 'Debug: Step Into' }) +vim.keymap.set('n', '', function() require('dap').step_over() end, { desc = 'Debug: Step Over' }) +vim.keymap.set('n', '', function() require('dap').step_out() end, { desc = 'Debug: Step Out' }) +vim.keymap.set('n', 'b', function() require('dap').toggle_breakpoint() end, { desc = 'Debug: Toggle Breakpoint' }) +vim.keymap.set('n', '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. +vim.keymap.set('n', '', function() require('dapui').toggle() end, { desc = 'Debug: See last session result.' }) - -- Installs the debug adapters for you - 'mason-org/mason.nvim', - 'jay-babu/mason-nvim-dap.nvim', +local dap = require 'dap' +local dapui = require 'dapui' - -- Add your own debuggers here - 'leoluz/nvim-dap-go', - }, - 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' }, - -- 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.' }, - }, - config = function() - local dap = require 'dap' - local dapui = require 'dapui' +require('mason-nvim-dap').setup { + -- Makes a best effort to setup the various debuggers with + -- reasonable debug configurations + automatic_installation = true, - require('mason-nvim-dap').setup { - -- Makes a best effort to setup the various debuggers with - -- reasonable debug configurations - automatic_installation = true, + -- You can provide additional configuration to the handlers, + -- see mason-nvim-dap README for more information + handlers = {}, - -- You can provide additional configuration to the handlers, - -- see mason-nvim-dap README for more information - handlers = {}, - - -- You'll need to check that you have the required things installed - -- online, please don't ask me how to install them :) - ensure_installed = { - -- Update this to ensure that you have the debuggers for the langs you want - 'delve', - }, - } + -- You'll need to check that you have the required things installed + -- online, please don't ask me how to install them :) + ensure_installed = { + -- Update this to ensure that you have the debuggers for the langs you want + 'delve', + }, +} - -- 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 = '⏸', - play = '▶', - step_into = '⏎', - step_over = '⏭', - step_out = '⏮', - step_back = 'b', - run_last = '▶▶', - terminate = '⏹', - disconnect = '⏏', - }, - }, - } +-- 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 = '⏸', + play = '▶', + step_into = '⏎', + step_over = '⏭', + step_out = '⏮', + step_back = 'b', + run_last = '▶▶', + terminate = '⏹', + disconnect = '⏏', + }, + }, +} - -- Change breakpoint icons - -- vim.api.nvim_set_hl(0, 'DapBreak', { fg = '#e51400' }) - -- vim.api.nvim_set_hl(0, 'DapStop', { fg = '#ffcc00' }) - -- local breakpoint_icons = vim.g.have_nerd_font - -- and { Breakpoint = '', BreakpointCondition = '', BreakpointRejected = '', LogPoint = '', Stopped = '' } - -- or { Breakpoint = '●', BreakpointCondition = '⊜', BreakpointRejected = '⊘', LogPoint = '◆', Stopped = '⭔' } - -- for type, icon in pairs(breakpoint_icons) do - -- local tp = 'Dap' .. type - -- local hl = (type == 'Stopped') and 'DapStop' or 'DapBreak' - -- vim.fn.sign_define(tp, { text = icon, texthl = hl, numhl = hl }) - -- end +-- Change breakpoint icons +-- vim.api.nvim_set_hl(0, 'DapBreak', { fg = '#e51400' }) +-- vim.api.nvim_set_hl(0, 'DapStop', { fg = '#ffcc00' }) +-- local breakpoint_icons = vim.g.have_nerd_font +-- and { Breakpoint = '', BreakpointCondition = '', BreakpointRejected = '', LogPoint = '', Stopped = '' } +-- or { Breakpoint = '●', BreakpointCondition = '⊜', BreakpointRejected = '⊘', LogPoint = '◆', Stopped = '⭔' } +-- for type, icon in pairs(breakpoint_icons) do +-- local tp = 'Dap' .. type +-- local hl = (type == 'Stopped') and 'DapStop' or 'DapBreak' +-- vim.fn.sign_define(tp, { text = icon, texthl = hl, numhl = hl }) +-- end - dap.listeners.after.event_initialized['dapui_config'] = dapui.open - dap.listeners.before.event_terminated['dapui_config'] = dapui.close - dap.listeners.before.event_exited['dapui_config'] = dapui.close +dap.listeners.after.event_initialized['dapui_config'] = dapui.open +dap.listeners.before.event_terminated['dapui_config'] = dapui.close +dap.listeners.before.event_exited['dapui_config'] = dapui.close - -- Install golang specific config - require('dap-go').setup { - delve = { - -- On Windows delve must be run attached or it crashes. - -- See https://github.com/leoluz/nvim-dap-go/blob/main/README.md#configuring - detached = vim.fn.has 'win32' == 0, - }, - } - end, +-- Install golang specific config +require('dap-go').setup { + delve = { + -- On Windows delve must be run attached or it crashes. + -- See https://github.com/leoluz/nvim-dap-go/blob/main/README.md#configuring + detached = vim.fn.has 'win32' == 0, + }, } diff --git a/lua/kickstart/plugins/gitsigns.lua b/lua/kickstart/plugins/gitsigns.lua index 500ea6c4085..b7e40a87cfc 100644 --- a/lua/kickstart/plugins/gitsigns.lua +++ b/lua/kickstart/plugins/gitsigns.lua @@ -2,62 +2,56 @@ -- 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', - ---@module 'gitsigns' - ---@type Gitsigns.Config - ---@diagnostic disable-next-line: missing-fields - opts = { - on_attach = function(bufnr) - local gitsigns = require 'gitsigns' +vim.pack.add { 'https://github.com/lewis6991/gitsigns.nvim' } - local function map(mode, l, r, opts) - opts = opts or {} - opts.buffer = bufnr - vim.keymap.set(mode, l, r, opts) - end +require('gitsigns').setup { + 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) + 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', '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' }) - -- Text object - map({ 'o', 'x' }, 'ih', gitsigns.select_hunk) - 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 946ac7932ab..7187365656e 100644 --- a/lua/kickstart/plugins/indent_line.lua +++ b/lua/kickstart/plugins/indent_line.lua @@ -1,13 +1,6 @@ -- Add indentation guides even on blank lines ----@module 'lazy' ----@type LazySpec -return { - 'lukas-reineke/indent-blankline.nvim', - -- Enable `lukas-reineke/indent-blankline.nvim` - -- See `:help ibl` - main = 'ibl', - ---@module 'ibl' - ---@type ibl.config - opts = {}, -} +-- Enable `lukas-reineke/indent-blankline.nvim` +-- See `:help ibl` +vim.pack.add { 'https://github.com/lukas-reineke/indent-blankline.nvim' } +require('ibl').setup {} diff --git a/lua/kickstart/plugins/lint.lua b/lua/kickstart/plugins/lint.lua index 556f3178811..d63054452fd 100644 --- a/lua/kickstart/plugins/lint.lua +++ b/lua/kickstart/plugins/lint.lua @@ -1,59 +1,53 @@ -- 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 - } +vim.pack.add { 'https://github.com/mfussenegger/nvim-lint' } - -- 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 +local lint = require 'lint' +lint.linters_by_ft = { + markdown = { 'markdownlint' }, -- Make sure to install `markdownlint` via mason / npm +} + +-- 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, - }) +-- 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, -} +}) diff --git a/lua/kickstart/plugins/neo-tree.lua b/lua/kickstart/plugins/neo-tree.lua index af8d4495650..d9d699315e7 100644 --- a/lua/kickstart/plugins/neo-tree.lua +++ b/lua/kickstart/plugins/neo-tree.lua @@ -1,28 +1,25 @@ -- 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 = '*', - dependencies = { - 'nvim-lua/plenary.nvim', - 'nvim-tree/nvim-web-devicons', -- not strictly required, but recommended - 'MunifTanjim/nui.nvim', - }, - lazy = false, - keys = { - { '\\', ':Neotree reveal', desc = 'NeoTree reveal', silent = true }, - }, - ---@module 'neo-tree' - ---@type neotree.Config - opts = { - filesystem = { - window = { - mappings = { - ['\\'] = 'close_window', - }, +local plugins = { + { src = 'https://github.com/nvim-neo-tree/neo-tree.nvim', version = vim.version.range '*' }, + 'https://github.com/nvim-lua/plenary.nvim', + 'https://github.com/MunifTanjim/nui.nvim', +} + +if vim.g.have_nerd_font then + table.insert(plugins, 'https://github.com/nvim-tree/nvim-web-devicons') -- not strictly required, but recommended +end + +vim.pack.add(plugins) + +vim.keymap.set('n', '\\', 'Neotree reveal', { desc = 'NeoTree reveal', silent = true }) + +require('neo-tree').setup { + filesystem = { + window = { + mappings = { + ['\\'] = 'close_window', }, }, }, From 716d7465c0a071217c2cff871e44e19b9d02bb65 Mon Sep 17 00:00:00 2001 From: orip Date: Tue, 21 Apr 2026 13:10:16 +0300 Subject: [PATCH 03/11] Enable vim.loader for faster loading time --- init.lua | 3 +++ 1 file changed, 3 insertions(+) diff --git a/init.lua b/init.lua index f9ee55a01c7..83dae557cdb 100644 --- a/init.lua +++ b/init.lua @@ -84,6 +84,9 @@ I hope you enjoy your Neovim journey, P.S. You can delete this when you're done too. It's your config now! :) --]] +-- Enable faster startup by caching compiled Lua modules +vim.loader.enable() + -- Set as the leader key -- See `:help mapleader` -- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used) From a42ed30a091bb50bb046e82ee89cefc75e2cef68 Mon Sep 17 00:00:00 2001 From: orip Date: Tue, 21 Apr 2026 15:27:07 +0300 Subject: [PATCH 04/11] Update the explanations and docs --- README.md | 32 ++++++++++++++++++----- init.lua | 78 ++++++++++++++++++++++++++++++------------------------- 2 files changed, 68 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index b3ce45e2416..7c62e907134 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,8 @@ nvim That's it! `vim.pack` will install all the plugins from your config. Use `:lua vim.pack.update(nil, { offline = true })` to inspect plugin state and -`:lua vim.pack.update()` to fetch updates. +`:lua vim.pack.update()` to fetch updates (`:write` applies updates, `:quit` +cancels them). #### Read The Friendly Documentation @@ -169,17 +170,36 @@ After installing all the dependencies continue with the [Install Kickstart](#ins #### Windows Installation
Windows with Microsoft C++ Build Tools and CMake -Installation may require installing build tools and updating the run command for `telescope-fzf-native` +Kickstart's default config is make-only for `telescope-fzf-native.nvim`. +If `make` is unavailable, the plugin is skipped. -See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation) +Recommended: install `make` (see the chocolatey section below). -This requires: +If you want a CMake-only setup, customize `init.lua` in two places: -- Install CMake and the Microsoft C++ Build Tools on Windows +1. Include `telescope-fzf-native.nvim` when `cmake` is available: ```lua -{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' } +if vim.fn.executable 'make' == 1 or vim.fn.executable 'cmake' == 1 then + table.insert(plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') +end ``` + +2. In the `PackChanged` hook, use CMake when `make` is unavailable: + +```lua +if name == 'telescope-fzf-native.nvim' then + if vim.fn.executable 'make' == 1 then + run_build(name, { 'make' }, ev.data.path) + elseif vim.fn.executable 'cmake' == 1 then + run_build(name, { 'cmake', '-S.', '-Bbuild', '-DCMAKE_BUILD_TYPE=Release' }, ev.data.path) + run_build(name, { 'cmake', '--build', 'build', '--config', 'Release', '--target', 'install' }, ev.data.path) + end + return +end +``` + +See `telescope-fzf-native` documentation for [build details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation).
Windows with gcc/make using chocolatey Alternatively, one can install gcc and make which don't require changing the config, diff --git a/init.lua b/init.lua index 83dae557cdb..565a5066b21 100644 --- a/init.lua +++ b/init.lua @@ -233,18 +233,18 @@ vim.api.nvim_create_autocmd('TextYankPost', { callback = function() vim.hl.on_yank() end, }) --- [[ Configure and install plugins with `vim.pack` ]] +-- [[ Install plugins with `vim.pack` ]] +-- See `:help vim.pack`, `:help vim.pack-examples` or the +-- excellent blog post from the creator of vim.pack and mini.nvim: +-- https://echasnovski.com/blog/2026-03-13-a-guide-to-vim-pack -- -- To inspect plugin state and pending updates, run -- :lua vim.pack.update(nil, { offline = true }) -- -- To update plugins, run -- :lua vim.pack.update() --- --- NOTE: Here is where you install your plugins. -local gh = function(repo) return 'https://github.com/' .. repo end -local run_build = function(name, cmd, cwd) +local function run_build(name, cmd, cwd) local result = vim.system(cmd, { cwd = cwd }):wait() if result.code ~= 0 then local stderr = result.stderr or '' @@ -255,6 +255,10 @@ local run_build = function(name, cmd, cwd) end end +-- This autocommand runs after a plugin is installed or updated and +-- runs the appropriate build command for that plugin if necessary. +-- +-- See `:help vim.pack-events` vim.api.nvim_create_autocmd('PackChanged', { callback = function(ev) local name = ev.data.spec.name @@ -279,8 +283,11 @@ vim.api.nvim_create_autocmd('PackChanged', { end, }) +local gh = function(repo) return 'https://github.com/' .. repo end + ---@type (string|vim.pack.Spec)[] local plugins = { + -- You can specify plugins with a git URL. `vim.pack` then uses the default branch (usually `main` or `master`) gh 'NMAC427/guess-indent.nvim', gh 'lewis6991/gitsigns.nvim', gh 'folke/which-key.nvim', @@ -293,11 +300,14 @@ local plugins = { gh 'WhoIsSethDaniel/mason-tool-installer.nvim', gh 'j-hui/fidget.nvim', gh 'stevearc/conform.nvim', + -- You can also specify plugins with a version range for semver git tags + -- See `:help vim.version.range()` for more info { src = gh 'saghen/blink.cmp', version = vim.version.range '1.*' }, { src = gh 'L3MON4D3/LuaSnip', version = vim.version.range '2.*' }, gh 'folke/tokyonight.nvim', gh 'folke/todo-comments.nvim', gh 'nvim-mini/mini.nvim', + -- You can also specify a branch or a specific commit { src = gh 'nvim-treesitter/nvim-treesitter', version = 'main' }, } @@ -306,8 +316,14 @@ if vim.fn.executable 'make' == 1 then table.insert(plugins, gh 'nvim-telescope/t -- Useful for getting pretty icons, but requires a Nerd Font. if vim.g.have_nerd_font then table.insert(plugins, gh 'nvim-tree/nvim-web-devicons') end +-- NOTE: Here is where the plugins are actually installed and added to the path vim.pack.add(plugins) +-- [[ Configure plugins ]] +-- For most plugins you need to call their `.setup()` to start them +-- +-- For example, here is the simplest possible setup for `guess-indent.nvim`, +-- which will automatically detect and set your indentation settings based on the current file. require('guess-indent').setup {} -- Here is a more advanced example that passes configuration options to `gitsigns.nvim` @@ -337,24 +353,16 @@ require('which-key').setup { { 'gr', group = 'LSP Actions', mode = { 'n' } }, }, } --- Fuzzy Finder (files, lsp, etc) --- --- By default, Telescope is included and acts as your picker for everything. --- # TODO: Rework this docstring --- --- 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. +-- [[ Fuzzy Finder (files, lsp, etc) ]] -- -- Telescope is a fuzzy finder that comes with a lot of different things that -- it can fuzzy find! It's more than just a "file finder", it can search -- many different aspects of Neovim, your workspace, LSP, and more! -- +-- There are lots of other alternative pickers (like snacks.picker, or fzf-lua) +-- so feel free to experiment and see what you like! +-- -- The easiest way to use Telescope, is to start by doing something like: -- :Telescope help_tags -- @@ -370,7 +378,6 @@ require('which-key').setup { -- Telescope picker. This is really useful to discover what Telescope can -- do as well as how to actually do it! --- [[ Configure Telescope ]] -- See `:help telescope` and `:help telescope.setup()` require('telescope').setup { -- You can put your default mappings / updates / etc. in here @@ -465,15 +472,7 @@ vim.keymap.set( -- 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' }) --- LSP Plugins - --- 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. -require('mason').setup {} - --- Useful status updates for LSP. -require('fidget').setup {} - +-- [[ LSP Configuration ]] -- Brief aside: **What is LSP?** -- -- LSP is an initialism you've probably heard, but might not understand what it is. @@ -499,6 +498,9 @@ require('fidget').setup {} -- If you're wondering about lsp vs treesitter, you can check out the wonderfully -- and elegantly composed help section, `:help lsp-vs-treesitter` +-- Useful status updates for LSP. +require('fidget').setup {} + -- This function gets run when an LSP attaches to a particular buffer. -- That is to say, every time a new file is opened that is associated with -- an lsp (for example, opening `main.rs` is associated with `rust_analyzer`) this @@ -620,6 +622,9 @@ local servers = { }, } +-- Automatically install LSPs and related tools to stdpath for Neovim +require('mason').setup {} + -- Ensure the servers and tools above are installed -- -- To check the current status of installed tools and/or manually install @@ -639,7 +644,7 @@ for name, server in pairs(servers) do vim.lsp.enable(name) end --- Autoformat +-- [[ Formatting ]] require('conform').setup { notify_on_error = false, format_on_save = function(bufnr) @@ -670,17 +675,19 @@ require('conform').setup { vim.keymap.set({ 'n', 'v' }, 'f', function() require('conform').format { async = true } end, { desc = '[F]ormat buffer' }) +-- [[ Autocompletion Configuration ]] + -- Snippet Engine --- +require('luasnip').setup {} + -- `friendly-snippets` contains a variety of premade snippets. -- See the README about individual language/framework/plugin snippets: -- https://github.com/rafamadriz/friendly-snippets -- -- vim.pack.add { gh 'rafamadriz/friendly-snippets' } -- require('luasnip.loaders.from_vscode').lazy_load() -require('luasnip').setup {} --- Autocompletion +-- The autocomplete engine require('blink.cmp').setup { keymap = { -- 'default' (recommended) for mappings similar to built-in completions @@ -741,9 +748,10 @@ require('blink.cmp').setup { signature = { enabled = true }, } +-- [[ Colorscheme ]] -- You can easily change to a different colorscheme. -- Change the name of the colorscheme plugin below, and then --- change the command in the config to whatever the name of that colorscheme is. +-- change the command under that to load whatever the name of that colorscheme is. -- -- If you want to see what colorschemes are already installed, you can use `:Telescope colorscheme`. ---@diagnostic disable-next-line: missing-fields @@ -761,7 +769,8 @@ vim.cmd.colorscheme 'tokyonight-night' -- Highlight todo, notes, etc in comments require('todo-comments').setup { signs = false } --- Collection of various small independent plugins/modules +-- [[ mini.nvim ]] +-- A collection of various small independent plugins/modules -- Better Around/Inside textobjects -- @@ -874,9 +883,6 @@ vim.api.nvim_create_autocmd('FileType', { -- -- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going. -- require 'custom.plugins' --- --- For additional information with loading, sourcing and examples see `:help vim.pack` --- and `:help vim.pack-examples` -- The line beneath this is called `modeline`. See `:help modeline` -- vim: ts=2 sts=2 sw=2 et From 2e8d5b17cb51513ae6f1e54a65d7fac96b1b23e3 Mon Sep 17 00:00:00 2001 From: orip Date: Thu, 23 Apr 2026 21:01:25 +0300 Subject: [PATCH 05/11] Split into sections --- init.lua | 1584 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 818 insertions(+), 766 deletions(-) diff --git a/init.lua b/init.lua index 565a5066b21..27bb539710c 100644 --- a/init.lua +++ b/init.lua @@ -84,805 +84,857 @@ I hope you enjoy your Neovim journey, P.S. You can delete this when you're done too. It's your config now! :) --]] --- Enable faster startup by caching compiled Lua modules -vim.loader.enable() - --- Set as the leader key --- See `:help mapleader` --- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used) -vim.g.mapleader = ' ' -vim.g.maplocalleader = ' ' - --- Set to true if you have a Nerd Font installed and selected in the terminal -vim.g.have_nerd_font = false - --- [[ Setting options ]] --- See `:help vim.o` --- NOTE: You can change these options as you wish! --- For more options, you can see `:help option-list` - --- Make line numbers default -vim.o.number = true --- You can also add relative line numbers, to help with jumping. --- Experiment for yourself to see if you like it! --- vim.o.relativenumber = true - --- Enable mouse mode, can be useful for resizing splits for example! -vim.o.mouse = 'a' - --- Don't show the mode, since it's already in the status line -vim.o.showmode = false - --- Sync clipboard between OS and Neovim. --- 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) - --- Enable break indent -vim.o.breakindent = true - --- 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 -vim.o.ignorecase = true -vim.o.smartcase = true - --- Keep signcolumn on by default -vim.o.signcolumn = 'yes' - --- Decrease update time -vim.o.updatetime = 250 - --- Decrease mapped sequence wait time -vim.o.timeoutlen = 300 - --- Configure how new splits should be opened -vim.o.splitright = true -vim.o.splitbelow = true - --- Sets how neovim will display certain whitespace characters in the editor. --- See `:help 'list'` --- and `:help 'listchars'` --- --- 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-guide-options` -vim.o.list = true -vim.opt.listchars = { tab = '» ', trail = '·', nbsp = '␣' } - --- Preview substitutions live, as you type! -vim.o.inccommand = 'split' - --- Show which line your cursor is on -vim.o.cursorline = true - --- Minimal number of screen lines to keep above and below the cursor. -vim.o.scrolloff = 10 - --- if performing an operation that would fail due to unsaved changes in the buffer (like `:q`), --- instead raise a dialog asking if you wish to save the current file(s) --- See `:help 'confirm'` -vim.o.confirm = true - --- [[ Basic Keymaps ]] --- See `:help vim.keymap.set()` - --- Clear highlights on search when pressing in normal mode --- See `:help hlsearch` -vim.keymap.set('n', '', 'nohlsearch') - --- 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 --- for people to discover. Otherwise, you normally need to press , which --- is not what someone will guess without a bit more experience. --- --- NOTE: This won't work in all terminal emulators/tmux/etc. Try your own mapping --- or just use to exit terminal mode -vim.keymap.set('t', '', '', { desc = 'Exit terminal mode' }) - --- TIP: Disable arrow keys in normal mode --- vim.keymap.set('n', '', 'echo "Use h to move!!"') --- vim.keymap.set('n', '', 'echo "Use l to move!!"') --- vim.keymap.set('n', '', 'echo "Use k to move!!"') --- vim.keymap.set('n', '', 'echo "Use j to move!!"') - --- Keybinds to make split navigation easier. --- Use CTRL+ to switch between windows --- --- See `:help wincmd` for a list of all window commands -vim.keymap.set('n', '', '', { desc = 'Move focus to the left window' }) -vim.keymap.set('n', '', '', { desc = 'Move focus to the right window' }) -vim.keymap.set('n', '', '', { desc = 'Move focus to the lower window' }) -vim.keymap.set('n', '', '', { desc = 'Move focus to the upper window' }) - --- NOTE: Some terminals have colliding keymaps or are not able to send distinct keycodes --- vim.keymap.set("n", "", "H", { desc = "Move window to the left" }) --- vim.keymap.set("n", "", "L", { desc = "Move window to the right" }) --- vim.keymap.set("n", "", "J", { desc = "Move window to the lower" }) --- vim.keymap.set("n", "", "K", { desc = "Move window to the upper" }) - --- [[ Basic Autocommands ]] --- See `:help lua-guide-autocommands` - --- Highlight when yanking (copying) text --- Try it with `yap` in normal mode --- See `:help vim.hl.on_yank()` -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, -}) - --- [[ Install plugins with `vim.pack` ]] --- See `:help vim.pack`, `:help vim.pack-examples` or the --- excellent blog post from the creator of vim.pack and mini.nvim: --- https://echasnovski.com/blog/2026-03-13-a-guide-to-vim-pack --- --- To inspect plugin state and pending updates, run --- :lua vim.pack.update(nil, { offline = true }) --- --- To update plugins, run --- :lua vim.pack.update() - -local function run_build(name, cmd, cwd) - local result = vim.system(cmd, { cwd = cwd }):wait() - if result.code ~= 0 then - local stderr = result.stderr or '' - local stdout = result.stdout or '' - local output = stderr ~= '' and stderr or stdout - if output == '' then output = 'No output from build command.' end - vim.notify(('Build failed for %s:\n%s'):format(name, output), vim.log.levels.ERROR) - end +-- ============================================================ +-- SECTION 1: FOUNDATION +-- Core Neovim settings, leaders, options, basic keymaps, basic autocmds +-- ============================================================ +do + -- Enable faster startup by caching compiled Lua modules + vim.loader.enable() + + -- Set as the leader key + -- See `:help mapleader` + -- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used) + vim.g.mapleader = ' ' + vim.g.maplocalleader = ' ' + + -- Set to true if you have a Nerd Font installed and selected in the terminal + vim.g.have_nerd_font = false + + -- [[ Setting options ]] + -- See `:help vim.o` + -- NOTE: You can change these options as you wish! + -- For more options, you can see `:help option-list` + + -- Make line numbers default + vim.o.number = true + -- You can also add relative line numbers, to help with jumping. + -- Experiment for yourself to see if you like it! + -- vim.o.relativenumber = true + + -- Enable mouse mode, can be useful for resizing splits for example! + vim.o.mouse = 'a' + + -- Don't show the mode, since it's already in the status line + vim.o.showmode = false + + -- Sync clipboard between OS and Neovim. + -- 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) + + -- Enable break indent + vim.o.breakindent = true + + -- 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 + vim.o.ignorecase = true + vim.o.smartcase = true + + -- Keep signcolumn on by default + vim.o.signcolumn = 'yes' + + -- Decrease update time + vim.o.updatetime = 250 + + -- Decrease mapped sequence wait time + vim.o.timeoutlen = 300 + + -- Configure how new splits should be opened + vim.o.splitright = true + vim.o.splitbelow = true + + -- Sets how neovim will display certain whitespace characters in the editor. + -- See `:help 'list'` + -- and `:help 'listchars'` + -- + -- 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-guide-options` + vim.o.list = true + vim.opt.listchars = { tab = '» ', trail = '·', nbsp = '␣' } + + -- Preview substitutions live, as you type! + vim.o.inccommand = 'split' + + -- Show which line your cursor is on + vim.o.cursorline = true + + -- Minimal number of screen lines to keep above and below the cursor. + vim.o.scrolloff = 10 + + -- if performing an operation that would fail due to unsaved changes in the buffer (like `:q`), + -- instead raise a dialog asking if you wish to save the current file(s) + -- See `:help 'confirm'` + vim.o.confirm = true + + -- [[ Basic Keymaps ]] + -- See `:help vim.keymap.set()` + + -- Clear highlights on search when pressing in normal mode + -- See `:help hlsearch` + vim.keymap.set('n', '', 'nohlsearch') + + -- 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 + -- for people to discover. Otherwise, you normally need to press , which + -- is not what someone will guess without a bit more experience. + -- + -- NOTE: This won't work in all terminal emulators/tmux/etc. Try your own mapping + -- or just use to exit terminal mode + vim.keymap.set('t', '', '', { desc = 'Exit terminal mode' }) + + -- TIP: Disable arrow keys in normal mode + -- vim.keymap.set('n', '', 'echo "Use h to move!!"') + -- vim.keymap.set('n', '', 'echo "Use l to move!!"') + -- vim.keymap.set('n', '', 'echo "Use k to move!!"') + -- vim.keymap.set('n', '', 'echo "Use j to move!!"') + + -- Keybinds to make split navigation easier. + -- Use CTRL+ to switch between windows + -- + -- See `:help wincmd` for a list of all window commands + vim.keymap.set('n', '', '', { desc = 'Move focus to the left window' }) + vim.keymap.set('n', '', '', { desc = 'Move focus to the right window' }) + vim.keymap.set('n', '', '', { desc = 'Move focus to the lower window' }) + vim.keymap.set('n', '', '', { desc = 'Move focus to the upper window' }) + + -- NOTE: Some terminals have colliding keymaps or are not able to send distinct keycodes + -- vim.keymap.set("n", "", "H", { desc = "Move window to the left" }) + -- vim.keymap.set("n", "", "L", { desc = "Move window to the right" }) + -- vim.keymap.set("n", "", "J", { desc = "Move window to the lower" }) + -- vim.keymap.set("n", "", "K", { desc = "Move window to the upper" }) + + -- [[ Basic Autocommands ]] + -- See `:help lua-guide-autocommands` + + -- Highlight when yanking (copying) text + -- Try it with `yap` in normal mode + -- See `:help vim.hl.on_yank()` + 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, + }) end --- This autocommand runs after a plugin is installed or updated and --- runs the appropriate build command for that plugin if necessary. --- --- See `:help vim.pack-events` -vim.api.nvim_create_autocmd('PackChanged', { - callback = function(ev) - local name = ev.data.spec.name - local kind = ev.data.kind - if kind ~= 'install' and kind ~= 'update' then return end - - if name == 'telescope-fzf-native.nvim' and vim.fn.executable 'make' == 1 then - run_build(name, { 'make' }, ev.data.path) - return - end - - if name == 'LuaSnip' then - if vim.fn.has 'win32' ~= 1 and vim.fn.executable 'make' == 1 then run_build(name, { 'make', 'install_jsregexp' }, ev.data.path) end - return +-- ============================================================ +-- SECTION 2: PLUGIN MANAGER +-- vim.pack, build hooks, install/update plugins, plugin specs +-- ============================================================ +do + -- [[ Install plugins with `vim.pack` ]] + -- See `:help vim.pack`, `:help vim.pack-examples` or the + -- excellent blog post from the creator of vim.pack and mini.nvim: + -- https://echasnovski.com/blog/2026-03-13-a-guide-to-vim-pack + -- + -- To inspect plugin state and pending updates, run + -- :lua vim.pack.update(nil, { offline = true }) + -- + -- To update plugins, run + -- :lua vim.pack.update() + + local function run_build(name, cmd, cwd) + local result = vim.system(cmd, { cwd = cwd }):wait() + if result.code ~= 0 then + local stderr = result.stderr or '' + local stdout = result.stdout or '' + local output = stderr ~= '' and stderr or stdout + if output == '' then output = 'No output from build command.' end + vim.notify(('Build failed for %s:\n%s'):format(name, output), vim.log.levels.ERROR) end + end - if name == 'nvim-treesitter' then - if not ev.data.active then vim.cmd.packadd 'nvim-treesitter' end - vim.cmd 'TSUpdate' - return - end - end, -}) - -local gh = function(repo) return 'https://github.com/' .. repo end - ----@type (string|vim.pack.Spec)[] -local plugins = { - -- You can specify plugins with a git URL. `vim.pack` then uses the default branch (usually `main` or `master`) - gh 'NMAC427/guess-indent.nvim', - gh 'lewis6991/gitsigns.nvim', - gh 'folke/which-key.nvim', - gh 'nvim-lua/plenary.nvim', - gh 'nvim-telescope/telescope.nvim', - gh 'nvim-telescope/telescope-ui-select.nvim', - gh 'neovim/nvim-lspconfig', - gh 'mason-org/mason.nvim', - gh 'mason-org/mason-lspconfig.nvim', - gh 'WhoIsSethDaniel/mason-tool-installer.nvim', - gh 'j-hui/fidget.nvim', - gh 'stevearc/conform.nvim', - -- You can also specify plugins with a version range for semver git tags - -- See `:help vim.version.range()` for more info - { src = gh 'saghen/blink.cmp', version = vim.version.range '1.*' }, - { src = gh 'L3MON4D3/LuaSnip', version = vim.version.range '2.*' }, - gh 'folke/tokyonight.nvim', - gh 'folke/todo-comments.nvim', - gh 'nvim-mini/mini.nvim', - -- You can also specify a branch or a specific commit - { src = gh 'nvim-treesitter/nvim-treesitter', version = 'main' }, -} - -if vim.fn.executable 'make' == 1 then table.insert(plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') end - --- Useful for getting pretty icons, but requires a Nerd Font. -if vim.g.have_nerd_font then table.insert(plugins, gh 'nvim-tree/nvim-web-devicons') end - --- NOTE: Here is where the plugins are actually installed and added to the path -vim.pack.add(plugins) - --- [[ Configure plugins ]] --- For most plugins you need to call their `.setup()` to start them --- --- For example, here is the simplest possible setup for `guess-indent.nvim`, --- which will automatically detect and set your indentation settings based on the current file. -require('guess-indent').setup {} - --- Here is a more advanced example that passes configuration options to `gitsigns.nvim` --- --- See `:help gitsigns` to understand what each configuration key does. --- Adds git related signs to the gutter, as well as utilities for managing changes -require('gitsigns').setup { - signs = { - 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 - }, -} - --- Useful plugin to show you pending keybinds. -require('which-key').setup { - -- Delay between pressing a key and opening which-key (milliseconds) - delay = 0, - icons = { mappings = vim.g.have_nerd_font }, - -- Document existing key chains - spec = { - { 's', group = '[S]earch', mode = { 'n', 'v' } }, - { 't', group = '[T]oggle' }, - { 'h', group = 'Git [H]unk', mode = { 'n', 'v' } }, -- Enable gitsigns recommended keymaps first - { 'gr', group = 'LSP Actions', mode = { 'n' } }, - }, -} - --- [[ Fuzzy Finder (files, lsp, etc) ]] --- --- Telescope is a fuzzy finder that comes with a lot of different things that --- it can fuzzy find! It's more than just a "file finder", it can search --- many different aspects of Neovim, your workspace, LSP, and more! --- --- There are lots of other alternative pickers (like snacks.picker, or fzf-lua) --- so feel free to experiment and see what you like! --- --- The easiest way to use Telescope, is to start by doing something like: --- :Telescope help_tags --- --- After running this command, a window will open up and you're able to --- type in the prompt window. You'll see a list of `help_tags` options and --- a corresponding preview of the help. --- --- Two important keymaps to use while in Telescope are: --- - Insert mode: --- - Normal mode: ? --- --- This opens a window that shows you all of the keymaps for the current --- Telescope picker. This is really useful to discover what Telescope can --- do as well as how to actually do it! - --- See `:help telescope` and `:help telescope.setup()` -require('telescope').setup { - -- You can put your default mappings / updates / etc. in here - -- All the info you're looking for is in `:help telescope.setup()` + -- This autocommand runs after a plugin is installed or updated and + -- runs the appropriate build command for that plugin if necessary. -- - -- defaults = { - -- mappings = { - -- i = { [''] = 'to_fuzzy_refine' }, - -- }, - -- }, - -- pickers = {} - extensions = { - ['ui-select'] = { require('telescope.themes').get_dropdown() }, - }, -} - --- Enable Telescope extensions if they are installed -pcall(require('telescope').load_extension, 'fzf') -pcall(require('telescope').load_extension, 'ui-select') - --- See `:help telescope.builtin` -local builtin = require 'telescope.builtin' -vim.keymap.set('n', 'sh', builtin.help_tags, { desc = '[S]earch [H]elp' }) -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', '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' }) - --- Add Telescope-based LSP pickers when an LSP attaches to a buffer. --- If you later switch picker plugins, this is where to update these mappings. -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 { - winblend = 10, - previewer = false, + -- See `:help vim.pack-events` + vim.api.nvim_create_autocmd('PackChanged', { + callback = function(ev) + local name = ev.data.spec.name + local kind = ev.data.kind + if kind ~= 'install' and kind ~= 'update' then return end + + if name == 'telescope-fzf-native.nvim' and vim.fn.executable 'make' == 1 then + run_build(name, { 'make' }, ev.data.path) + return + end + + if name == 'LuaSnip' then + if vim.fn.has 'win32' ~= 1 and vim.fn.executable 'make' == 1 then run_build(name, { 'make', 'install_jsregexp' }, ev.data.path) end + return + end + + if name == 'nvim-treesitter' then + if not ev.data.active then vim.cmd.packadd 'nvim-treesitter' end + vim.cmd 'TSUpdate' + return + end + end, }) -end, { desc = '[/] Fuzzily search in current buffer' }) - --- 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' } -) - --- 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' }) - --- [[ LSP Configuration ]] --- Brief aside: **What is LSP?** --- --- LSP is an initialism you've probably heard, but might not understand what it is. --- --- LSP stands for Language Server Protocol. It's a protocol that helps editors --- and language tooling communicate in a standardized fashion. --- --- In general, you have a "server" which is some tool built to understand a particular --- language (such as `gopls`, `lua_ls`, `rust_analyzer`, etc.). These Language Servers --- (sometimes called LSP servers, but that's kind of like ATM Machine) are standalone --- processes that communicate with some "client" - in this case, Neovim! --- --- LSP provides Neovim with features like: --- - Go to definition --- - Find references --- - Autocompletion --- - Symbol Search --- - and more! --- --- Thus, Language Servers are external tools that must be installed separately from --- Neovim. This is where `mason` and related plugins come into play. --- --- If you're wondering about lsp vs treesitter, you can check out the wonderfully --- and elegantly composed help section, `:help lsp-vs-treesitter` - --- Useful status updates for LSP. -require('fidget').setup {} - --- This function gets run when an LSP attaches to a particular buffer. --- That is to say, every time a new file is opened that is associated with --- an lsp (for example, opening `main.rs` is associated with `rust_analyzer`) this --- function will be executed to configure the current buffer -vim.api.nvim_create_autocmd('LspAttach', { - group = vim.api.nvim_create_augroup('kickstart-lsp-attach', { clear = true }), - callback = function(event) - -- NOTE: Remember that Lua is a real programming language, and as such it is possible - -- to define small helper and utility functions so you don't have to repeat yourself. - -- - -- In this case, we create a function that lets us more easily define mappings specific - -- for LSP related items. It sets the mode, buffer and description for us each time. - local map = function(keys, func, desc, mode) - mode = mode or 'n' - vim.keymap.set(mode, keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc }) - end - -- Rename the variable under your cursor. - -- Most Language Servers support renaming across files, etc. - map('grn', vim.lsp.buf.rename, '[R]e[n]ame') + local gh = function(repo) return 'https://github.com/' .. repo end + + ---@type (string|vim.pack.Spec)[] + local plugins = { + -- You can specify plugins with a git URL. `vim.pack` then uses the default branch (usually `main` or `master`) + gh 'NMAC427/guess-indent.nvim', + gh 'lewis6991/gitsigns.nvim', + gh 'folke/which-key.nvim', + gh 'nvim-lua/plenary.nvim', + gh 'nvim-telescope/telescope.nvim', + gh 'nvim-telescope/telescope-ui-select.nvim', + gh 'neovim/nvim-lspconfig', + gh 'mason-org/mason.nvim', + gh 'mason-org/mason-lspconfig.nvim', + gh 'WhoIsSethDaniel/mason-tool-installer.nvim', + gh 'j-hui/fidget.nvim', + gh 'stevearc/conform.nvim', + -- You can also specify plugins with a version range for semver git tags + -- See `:help vim.version.range()` for more info + { src = gh 'saghen/blink.cmp', version = vim.version.range '1.*' }, + { src = gh 'L3MON4D3/LuaSnip', version = vim.version.range '2.*' }, + gh 'folke/tokyonight.nvim', + gh 'folke/todo-comments.nvim', + gh 'nvim-mini/mini.nvim', + -- You can also specify a branch or a specific commit + { src = gh 'nvim-treesitter/nvim-treesitter', version = 'main' }, + } + + if vim.fn.executable 'make' == 1 then table.insert(plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') end + + -- Useful for getting pretty icons, but requires a Nerd Font. + if vim.g.have_nerd_font then table.insert(plugins, gh 'nvim-tree/nvim-web-devicons') end + + -- NOTE: Here is where the plugins are actually installed and added to the path + vim.pack.add(plugins) +end - -- Execute a code action, usually your cursor needs to be on top of an error - -- or a suggestion from your LSP for this to activate. - map('gra', vim.lsp.buf.code_action, '[G]oto Code [A]ction', { 'n', 'x' }) +-- ============================================================ +-- SECTION 3: UI / CORE UX PLUGINS +-- guess-indent, gitsigns, which-key, colorscheme, todo-comments, mini modules +-- ============================================================ +do + -- [[ Configure plugins ]] + -- For most plugins you need to call their `.setup()` to start them + -- + -- For example, here is the simplest possible setup for `guess-indent.nvim`, + -- which will automatically detect and set your indentation settings based on the current file. + require('guess-indent').setup {} - -- 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') + -- Here is a more advanced example that passes configuration options to `gitsigns.nvim` + -- + -- See `:help gitsigns` to understand what each configuration key does. + -- Adds git related signs to the gutter, as well as utilities for managing changes + require('gitsigns').setup { + signs = { + 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 + }, + } + + -- Useful plugin to show you pending keybinds. + require('which-key').setup { + -- Delay between pressing a key and opening which-key (milliseconds) + delay = 0, + icons = { mappings = vim.g.have_nerd_font }, + -- Document existing key chains + spec = { + { 's', group = '[S]earch', mode = { 'n', 'v' } }, + { 't', group = '[T]oggle' }, + { 'h', group = 'Git [H]unk', mode = { 'n', 'v' } }, -- Enable gitsigns recommended keymaps first + { 'gr', group = 'LSP Actions', mode = { 'n' } }, + }, + } - -- The following two autocommands are used to highlight references of the - -- word under your cursor when your cursor rests there for a little while. - -- See `:help CursorHold` for information about when this is executed - -- - -- 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('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, - group = highlight_augroup, - callback = vim.lsp.buf.document_highlight, - }) - - vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, { - buffer = event.buf, - group = highlight_augroup, - callback = vim.lsp.buf.clear_references, - }) - - vim.api.nvim_create_autocmd('LspDetach', { - group = vim.api.nvim_create_augroup('kickstart-lsp-detach', { clear = true }), - callback = function(event2) - vim.lsp.buf.clear_references() - vim.api.nvim_clear_autocmds { group = 'kickstart-lsp-highlight', buffer = event2.buf } - end, - }) - end + -- [[ Colorscheme ]] + -- You can easily change to a different colorscheme. + -- Change the name of the colorscheme plugin below, and then + -- change the command under that to load whatever the name of that colorscheme is. + -- + -- If you want to see what colorschemes are already installed, you can use `:Telescope colorscheme`. + ---@diagnostic disable-next-line: missing-fields + require('tokyonight').setup { + styles = { + comments = { italic = false }, -- Disable italics in comments + }, + } - -- The following code creates a keymap to toggle inlay hints in your - -- 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('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, -}) - --- Enable the following language servers --- Feel free to add/remove any LSPs that you want here. They will automatically be installed. --- See `:help lsp-config` for information about keys and how to configure ----@type table -local servers = { - -- clangd = {}, - -- gopls = {}, - -- pyright = {}, - -- rust_analyzer = {}, + -- Load the colorscheme here. + -- Like many other themes, this one has different styles, and you could load + -- any other, such as 'tokyonight-storm', 'tokyonight-moon', or 'tokyonight-day'. + vim.cmd.colorscheme 'tokyonight-night' + + -- Highlight todo, notes, etc in comments + require('todo-comments').setup { signs = false } + + -- [[ mini.nvim ]] + -- A collection of various small independent plugins/modules + + -- Better Around/Inside textobjects + -- + -- Examples: + -- - va) - [V]isually select [A]round [)]paren + -- - yiiq - [Y]ank [I]nside [I]+1 [Q]uote + -- - ci' - [C]hange [I]nside [']quote + 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.) + -- + -- - saiw) - [S]urround [A]dd [I]nner [W]ord [)]Paren + -- - sd' - [S]urround [D]elete [']quotes + -- - sr)' - [S]urround [R]eplace [)] ['] + require('mini.surround').setup() + + -- Simple and easy statusline. + -- You could remove this setup call if you don't like it, + -- and try some other statusline plugin + local statusline = require 'mini.statusline' + -- Set `use_icons` to true if you have a Nerd Font + statusline.setup { use_icons = vim.g.have_nerd_font } + + -- You can configure sections in the statusline by overriding their + -- 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 + + -- ... and there is more! + -- Check out: https://github.com/nvim-mini/mini.nvim +end + +-- ============================================================ +-- SECTION 4: SEARCH & NAVIGATION +-- Telescope setup, keymaps, LSP picker mappings +-- ============================================================ +do + -- [[ Fuzzy Finder (files, lsp, etc) ]] + -- + -- Telescope is a fuzzy finder that comes with a lot of different things that + -- it can fuzzy find! It's more than just a "file finder", it can search + -- many different aspects of Neovim, your workspace, LSP, and more! -- - -- Some languages (like typescript) have entire language plugins that can be useful: - -- https://github.com/pmizio/typescript-tools.nvim + -- There are lots of other alternative pickers (like snacks.picker, or fzf-lua) + -- so feel free to experiment and see what you like! -- - -- But for many setups, the LSP (`ts_ls`) will work just fine - -- ts_ls = {}, + -- The easiest way to use Telescope, is to start by doing something like: + -- :Telescope help_tags + -- + -- After running this command, a window will open up and you're able to + -- type in the prompt window. You'll see a list of `help_tags` options and + -- a corresponding preview of the help. + -- + -- Two important keymaps to use while in Telescope are: + -- - Insert mode: + -- - Normal mode: ? + -- + -- This opens a window that shows you all of the keymaps for the current + -- Telescope picker. This is really useful to discover what Telescope can + -- do as well as how to actually do it! + + -- See `:help telescope` and `:help telescope.setup()` + require('telescope').setup { + -- You can put your default mappings / updates / etc. in here + -- All the info you're looking for is in `:help telescope.setup()` + -- + -- defaults = { + -- mappings = { + -- i = { [''] = 'to_fuzzy_refine' }, + -- }, + -- }, + -- pickers = {} + extensions = { + ['ui-select'] = { require('telescope.themes').get_dropdown() }, + }, + } + + -- Enable Telescope extensions if they are installed + pcall(require('telescope').load_extension, 'fzf') + pcall(require('telescope').load_extension, 'ui-select') + + -- See `:help telescope.builtin` + local builtin = require 'telescope.builtin' + vim.keymap.set('n', 'sh', builtin.help_tags, { desc = '[S]earch [H]elp' }) + 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', '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' }) + + -- Add Telescope-based LSP pickers when an LSP attaches to a buffer. + -- If you later switch picker plugins, this is where to update these mappings. + 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, + }) - stylua = {}, -- Used to format Lua code + -- 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 { + winblend = 10, + previewer = false, + }) + end, { desc = '[/] Fuzzily search in current buffer' }) + + -- 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' } + ) - -- Special Lua Config, as recommended by neovim help docs - lua_ls = { - on_init = function(client) - client.server_capabilities.documentFormattingProvider = false -- Disable formatting (formatting is done by stylua) + -- 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' }) +end - 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 +-- ============================================================ +-- SECTION 5: LSP +-- LSP keymaps, server configuration, Mason tools installations +-- ============================================================ +do + -- [[ LSP Configuration ]] + -- Brief aside: **What is LSP?** + -- + -- LSP is an initialism you've probably heard, but might not understand what it is. + -- + -- LSP stands for Language Server Protocol. It's a protocol that helps editors + -- and language tooling communicate in a standardized fashion. + -- + -- In general, you have a "server" which is some tool built to understand a particular + -- language (such as `gopls`, `lua_ls`, `rust_analyzer`, etc.). These Language Servers + -- (sometimes called LSP servers, but that's kind of like ATM Machine) are standalone + -- processes that communicate with some "client" - in this case, Neovim! + -- + -- LSP provides Neovim with features like: + -- - Go to definition + -- - Find references + -- - Autocompletion + -- - Symbol Search + -- - and more! + -- + -- Thus, Language Servers are external tools that must be installed separately from + -- Neovim. This is where `mason` and related plugins come into play. + -- + -- If you're wondering about lsp vs treesitter, you can check out the wonderfully + -- and elegantly composed help section, `:help lsp-vs-treesitter` + + -- Useful status updates for LSP. + require('fidget').setup {} + + -- This function gets run when an LSP attaches to a particular buffer. + -- That is to say, every time a new file is opened that is associated with + -- an lsp (for example, opening `main.rs` is associated with `rust_analyzer`) this + -- function will be executed to configure the current buffer + vim.api.nvim_create_autocmd('LspAttach', { + group = vim.api.nvim_create_augroup('kickstart-lsp-attach', { clear = true }), + callback = function(event) + -- NOTE: Remember that Lua is a real programming language, and as such it is possible + -- to define small helper and utility functions so you don't have to repeat yourself. + -- + -- In this case, we create a function that lets us more easily define mappings specific + -- for LSP related items. It sets the mode, buffer and description for us each time. + local map = function(keys, func, desc, mode) + mode = mode or 'n' + vim.keymap.set(mode, keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc }) 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', - }), - }, - }) + -- Rename the variable under your cursor. + -- Most Language Servers support renaming across files, etc. + map('grn', vim.lsp.buf.rename, '[R]e[n]ame') + + -- Execute a code action, usually your cursor needs to be on top of an error + -- or a suggestion from your LSP for this to activate. + map('gra', vim.lsp.buf.code_action, '[G]oto Code [A]ction', { 'n', 'x' }) + + -- 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') + + -- The following two autocommands are used to highlight references of the + -- word under your cursor when your cursor rests there for a little while. + -- See `:help CursorHold` for information about when this is executed + -- + -- 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('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, + group = highlight_augroup, + callback = vim.lsp.buf.document_highlight, + }) + + vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, { + buffer = event.buf, + group = highlight_augroup, + callback = vim.lsp.buf.clear_references, + }) + + vim.api.nvim_create_autocmd('LspDetach', { + group = vim.api.nvim_create_augroup('kickstart-lsp-detach', { clear = true }), + callback = function(event2) + vim.lsp.buf.clear_references() + vim.api.nvim_clear_autocmds { group = 'kickstart-lsp-highlight', buffer = event2.buf } + end, + }) + end + + -- The following code creates a keymap to toggle inlay hints in your + -- 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('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, - ---@type lspconfig.settings.lua_ls - settings = { - Lua = { - format = { enable = false }, -- Disable formatting (formatting is done by stylua) + }) + + -- Enable the following language servers + -- Feel free to add/remove any LSPs that you want here. They will automatically be installed. + -- See `:help lsp-config` for information about keys and how to configure + ---@type table + local servers = { + -- clangd = {}, + -- gopls = {}, + -- pyright = {}, + -- rust_analyzer = {}, + -- + -- 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 = { + 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 = { + format = { enable = false }, -- Disable formatting (formatting is done by stylua) + }, }, }, - }, -} - --- Automatically install LSPs and related tools to stdpath for Neovim -require('mason').setup {} - --- Ensure the servers and tools above are installed --- --- To check the current status of installed tools and/or manually install --- other tools, you can run --- :Mason --- --- You can press `g?` for help in this menu. -local ensure_installed = vim.tbl_keys(servers or {}) -vim.list_extend(ensure_installed, { - -- You can add other tools here that you want Mason to install -}) - -require('mason-tool-installer').setup { ensure_installed = ensure_installed } - -for name, server in pairs(servers) do - vim.lsp.config(name, server) - vim.lsp.enable(name) + } + + -- Automatically install LSPs and related tools to stdpath for Neovim + require('mason').setup {} + + -- Ensure the servers and tools above are installed + -- + -- To check the current status of installed tools and/or manually install + -- other tools, you can run + -- :Mason + -- + -- You can press `g?` for help in this menu. + local ensure_installed = vim.tbl_keys(servers or {}) + vim.list_extend(ensure_installed, { + -- You can add other tools here that you want Mason to install + }) + + require('mason-tool-installer').setup { ensure_installed = ensure_installed } + + for name, server in pairs(servers) do + vim.lsp.config(name, server) + vim.lsp.enable(name) + end end --- [[ Formatting ]] -require('conform').setup { - notify_on_error = false, - format_on_save = function(bufnr) - -- 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 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 = { - -- rust = { 'rustfmt' }, - -- Conform can also run multiple formatters sequentially - -- python = { "isort", "black" }, - -- - -- You can use 'stop_after_first' to run the first available formatter from the list - -- javascript = { "prettierd", "prettier", stop_after_first = true }, - }, -} - -vim.keymap.set({ 'n', 'v' }, 'f', function() require('conform').format { async = true } end, { desc = '[F]ormat buffer' }) - --- [[ Autocompletion Configuration ]] - --- Snippet Engine -require('luasnip').setup {} - --- `friendly-snippets` contains a variety of premade snippets. --- See the README about individual language/framework/plugin snippets: --- https://github.com/rafamadriz/friendly-snippets --- --- vim.pack.add { gh 'rafamadriz/friendly-snippets' } --- require('luasnip.loaders.from_vscode').lazy_load() - --- The autocomplete engine -require('blink.cmp').setup { - keymap = { - -- 'default' (recommended) for mappings similar to built-in completions - -- to accept ([y]es) the completion. - -- This will auto-import if your LSP supports it. - -- This will expand snippets if the LSP sent a snippet. - -- 'super-tab' for tab to accept - -- 'enter' for enter to accept - -- 'none' for no mappings - -- - -- For an understanding of why the 'default' preset is recommended, - -- you will need to read `:help ins-completion` - -- - -- No, but seriously. Please read `:help ins-completion`, it is really good! +-- ============================================================ +-- SECTION 6: FORMATTING +-- conform.nvim setup and keymap +-- ============================================================ +do + -- [[ Formatting ]] + require('conform').setup { + notify_on_error = false, + format_on_save = function(bufnr) + -- 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 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 = { + -- rust = { 'rustfmt' }, + -- Conform can also run multiple formatters sequentially + -- python = { "isort", "black" }, + -- + -- You can use 'stop_after_first' to run the first available formatter from the list + -- javascript = { "prettierd", "prettier", stop_after_first = true }, + }, + } + + vim.keymap.set({ 'n', 'v' }, 'f', function() require('conform').format { async = true } end, { desc = '[F]ormat buffer' }) +end + +-- ============================================================ +-- SECTION 7: AUTOCOMPLETE & SNIPPETS +-- blink.cmp and luasnip setup +-- ============================================================ +do + -- [[ Snippet Engine ]] + require('luasnip').setup {} + + -- `friendly-snippets` contains a variety of premade snippets. + -- See the README about individual language/framework/plugin snippets: + -- https://github.com/rafamadriz/friendly-snippets + -- + -- vim.pack.add { gh 'rafamadriz/friendly-snippets' } + -- require('luasnip.loaders.from_vscode').lazy_load() + + -- [[ Autocomplete Engine ]] + require('blink.cmp').setup { + keymap = { + -- 'default' (recommended) for mappings similar to built-in completions + -- to accept ([y]es) the completion. + -- This will auto-import if your LSP supports it. + -- This will expand snippets if the LSP sent a snippet. + -- 'super-tab' for tab to accept + -- 'enter' for enter to accept + -- 'none' for no mappings + -- + -- For an understanding of why the 'default' preset is recommended, + -- you will need to read `:help ins-completion` + -- + -- No, but seriously. Please read `:help ins-completion`, it is really good! + -- + -- All presets have the following mappings: + -- /: move to right/left of your snippet expansion + -- : Open menu or open docs if already open + -- / or /: Select next/previous item + -- : Hide menu + -- : Toggle signature help + -- + -- See `:help blink-cmp-config-keymap` for defining your own keymap + preset = 'default', + + -- For more advanced Luasnip keymaps (e.g. selecting choice nodes, expansion) see: + -- https://github.com/L3MON4D3/LuaSnip?tab=readme-ov-file#keymaps + }, + + appearance = { + -- 'mono' (default) for 'Nerd Font Mono' or 'normal' for 'Nerd Font' + -- Adjusts spacing to ensure icons are aligned + nerd_font_variant = 'mono', + }, + + completion = { + -- By default, you may press `` to show the documentation. + -- Optionally, set `auto_show = true` to show the documentation after a delay. + documentation = { auto_show = false, auto_show_delay_ms = 500 }, + }, + + sources = { + default = { 'lsp', 'path', 'snippets' }, + }, + + snippets = { preset = 'luasnip' }, + + -- Blink.cmp includes an optional, recommended rust fuzzy matcher, + -- which automatically downloads a prebuilt binary when enabled. -- - -- All presets have the following mappings: - -- /: move to right/left of your snippet expansion - -- : Open menu or open docs if already open - -- / or /: Select next/previous item - -- : Hide menu - -- : Toggle signature help + -- By default, we use the Lua implementation instead, but you may enable + -- the rust implementation via `'prefer_rust_with_warning'` -- - -- See `:help blink-cmp-config-keymap` for defining your own keymap - preset = 'default', + -- See `:help blink-cmp-config-fuzzy` for more information + fuzzy = { implementation = 'lua' }, - -- For more advanced Luasnip keymaps (e.g. selecting choice nodes, expansion) see: - -- https://github.com/L3MON4D3/LuaSnip?tab=readme-ov-file#keymaps - }, - - appearance = { - -- 'mono' (default) for 'Nerd Font Mono' or 'normal' for 'Nerd Font' - -- Adjusts spacing to ensure icons are aligned - nerd_font_variant = 'mono', - }, + -- Shows a signature help window while you type arguments for a function + signature = { enabled = true }, + } +end - completion = { - -- By default, you may press `` to show the documentation. - -- Optionally, set `auto_show = true` to show the documentation after a delay. - documentation = { auto_show = false, auto_show_delay_ms = 500 }, - }, +-- ============================================================ +-- SECTION 8: TREESITTER +-- Parser installation, syntax highlighting, folds, indentation +-- ============================================================ +do + -- [[ Configure Treesitter ]] + -- Used to highlight, edit, and navigate code + -- + -- See `:help nvim-treesitter-intro` + + -- Ensure basic parsers 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 a parser exists and load it + if not vim.treesitter.language.add(language) then return end + -- Enable syntax highlighting and other treesitter features + vim.treesitter.start(buf, language) + + -- Enable 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 + + -- Enable treesitter based indentation + if has_indent_query then vim.bo.indentexpr = "v:lua.require'nvim-treesitter'.indentexpr()" end + end - sources = { - default = { 'lsp', 'path', 'snippets' }, - }, + 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 already 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 - snippets = { preset = 'luasnip' }, +-- ============================================================ +-- SECTION 9: OPTIONAL EXAMPLES / NEXT STEPS +-- kickstart.plugins.* examples +-- ============================================================ +do + -- The following comments only work if you have downloaded the kickstart repo, not just copy pasted the + -- init.lua. If you want these files, they are in the repository, so you can just download them and + -- place them in the correct locations. - -- Blink.cmp includes an optional, recommended rust fuzzy matcher, - -- which automatically downloads a prebuilt binary when enabled. + -- NOTE: Next step on your Neovim journey: Add/Configure additional plugins for Kickstart -- - -- By default, we use the Lua implementation instead, but you may enable - -- the rust implementation via `'prefer_rust_with_warning'` + -- Here are some example plugins that I've included in the Kickstart repository. + -- Uncomment any of the lines below to enable them (you will need to restart nvim). -- - -- See `:help blink-cmp-config-fuzzy` for more information - fuzzy = { implementation = 'lua' }, - - -- Shows a signature help window while you type arguments for a function - signature = { enabled = true }, -} - --- [[ Colorscheme ]] --- You can easily change to a different colorscheme. --- Change the name of the colorscheme plugin below, and then --- change the command under that to load whatever the name of that colorscheme is. --- --- If you want to see what colorschemes are already installed, you can use `:Telescope colorscheme`. ----@diagnostic disable-next-line: missing-fields -require('tokyonight').setup { - styles = { - comments = { italic = false }, -- Disable italics in comments - }, -} - --- Load the colorscheme here. --- Like many other themes, this one has different styles, and you could load --- any other, such as 'tokyonight-storm', 'tokyonight-moon', or 'tokyonight-day'. -vim.cmd.colorscheme 'tokyonight-night' - --- Highlight todo, notes, etc in comments -require('todo-comments').setup { signs = false } - --- [[ mini.nvim ]] --- A collection of various small independent plugins/modules - --- Better Around/Inside textobjects --- --- Examples: --- - va) - [V]isually select [A]round [)]paren --- - yiiq - [Y]ank [I]nside [I]+1 [Q]uote --- - ci' - [C]hange [I]nside [']quote -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.) --- --- - saiw) - [S]urround [A]dd [I]nner [W]ord [)]Paren --- - sd' - [S]urround [D]elete [']quotes --- - sr)' - [S]urround [R]eplace [)] ['] -require('mini.surround').setup() - --- Simple and easy statusline. --- You could remove this setup call if you don't like it, --- and try some other statusline plugin -local statusline = require 'mini.statusline' --- Set `use_icons` to true if you have a Nerd Font -statusline.setup { use_icons = vim.g.have_nerd_font } - --- You can configure sections in the statusline by overriding their --- 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 - --- ... and there is more! --- Check out: https://github.com/nvim-mini/mini.nvim - --- [[ Configure Treesitter ]] --- Used to highlight, edit, and navigate code --- --- See `:help nvim-treesitter-intro` - --- Ensure basic parsers 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 a parser exists and load it - if not vim.treesitter.language.add(language) then return end - -- Enable syntax highlighting and other treesitter features - vim.treesitter.start(buf, language) - - -- Enable 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 - - -- Enable treesitter based indentation - if has_indent_query then vim.bo.indentexpr = "v:lua.require'nvim-treesitter'.indentexpr()" end + -- require 'kickstart.plugins.debug' + -- require 'kickstart.plugins.indent_line' + -- require 'kickstart.plugins.lint' + -- require 'kickstart.plugins.autopairs' + -- require 'kickstart.plugins.neo-tree' + -- require 'kickstart.plugins.gitsigns' -- adds gitsigns recommended keymaps + + -- NOTE: You can add your own plugins, configuration, etc from `lua/custom/plugins/*.lua` + -- + -- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going. + -- require 'custom.plugins' 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 already 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, -}) - --- The following comments only work if you have downloaded the kickstart repo, not just copy pasted the --- init.lua. If you want these files, they are in the repository, so you can just download them and --- place them in the correct locations. - --- NOTE: Next step on your Neovim journey: Add/Configure additional plugins for Kickstart --- --- Here are some example plugins that I've included in the Kickstart repository. --- Uncomment any of the lines below to enable them (you will need to restart nvim). --- --- require 'kickstart.plugins.debug' --- require 'kickstart.plugins.indent_line' --- require 'kickstart.plugins.lint' --- require 'kickstart.plugins.autopairs' --- require 'kickstart.plugins.neo-tree' --- require 'kickstart.plugins.gitsigns' -- adds gitsigns recommended keymaps - --- NOTE: You can add your own plugins, configuration, etc from `lua/custom/plugins/*.lua` --- --- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going. --- require 'custom.plugins' - -- The line beneath this is called `modeline`. See `:help modeline` -- vim: ts=2 sts=2 sw=2 et From 2fccee4349b166ffcdf282bd7a69cb9a36a70820 Mon Sep 17 00:00:00 2001 From: orip Date: Sat, 2 May 2026 23:46:47 +0300 Subject: [PATCH 06/11] Split the vim.pack.add call and move each part to the relevant sections --- init.lua | 117 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 73 insertions(+), 44 deletions(-) diff --git a/init.lua b/init.lua index 27bb539710c..ec7ad44f777 100644 --- a/init.lua +++ b/init.lua @@ -240,11 +240,14 @@ do end -- ============================================================ --- SECTION 2: PLUGIN MANAGER --- vim.pack, build hooks, install/update plugins, plugin specs +-- SECTION 2: PLUGIN MANAGER INTRO +-- vim.pack intro, build hooks -- ============================================================ do - -- [[ Install plugins with `vim.pack` ]] + -- [[ Intro to `vim.pack` ]] + -- `vim.pack` is a new plugin manager built into Neovim, + -- which provides a Lua interface for installing and managing plugins. + -- -- See `:help vim.pack`, `:help vim.pack-examples` or the -- excellent blog post from the creator of vim.pack and mini.nvim: -- https://echasnovski.com/blog/2026-03-13-a-guide-to-vim-pack @@ -254,6 +257,13 @@ do -- -- To update plugins, run -- :lua vim.pack.update() + -- + -- + -- Throughout the rest of the config there will be examples + -- of how to install and configure plugins using `vim.pack`. + -- + -- In this section we set up some autocommands to run build + -- steps for certain plugins after they are installed or updated. local function run_build(name, cmd, cwd) local result = vim.system(cmd, { cwd = cwd }):wait() @@ -293,60 +303,47 @@ do end end, }) - - local gh = function(repo) return 'https://github.com/' .. repo end - - ---@type (string|vim.pack.Spec)[] - local plugins = { - -- You can specify plugins with a git URL. `vim.pack` then uses the default branch (usually `main` or `master`) - gh 'NMAC427/guess-indent.nvim', - gh 'lewis6991/gitsigns.nvim', - gh 'folke/which-key.nvim', - gh 'nvim-lua/plenary.nvim', - gh 'nvim-telescope/telescope.nvim', - gh 'nvim-telescope/telescope-ui-select.nvim', - gh 'neovim/nvim-lspconfig', - gh 'mason-org/mason.nvim', - gh 'mason-org/mason-lspconfig.nvim', - gh 'WhoIsSethDaniel/mason-tool-installer.nvim', - gh 'j-hui/fidget.nvim', - gh 'stevearc/conform.nvim', - -- You can also specify plugins with a version range for semver git tags - -- See `:help vim.version.range()` for more info - { src = gh 'saghen/blink.cmp', version = vim.version.range '1.*' }, - { src = gh 'L3MON4D3/LuaSnip', version = vim.version.range '2.*' }, - gh 'folke/tokyonight.nvim', - gh 'folke/todo-comments.nvim', - gh 'nvim-mini/mini.nvim', - -- You can also specify a branch or a specific commit - { src = gh 'nvim-treesitter/nvim-treesitter', version = 'main' }, - } - - if vim.fn.executable 'make' == 1 then table.insert(plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') end - - -- Useful for getting pretty icons, but requires a Nerd Font. - if vim.g.have_nerd_font then table.insert(plugins, gh 'nvim-tree/nvim-web-devicons') end - - -- NOTE: Here is where the plugins are actually installed and added to the path - vim.pack.add(plugins) end +---Because most plugins are hosted on GitHub, you can use the helper +---function to have less repetition in the following sections. +---@param repo string +---@return string +local function gh(repo) return 'https://github.com/' .. repo end + -- ============================================================ -- SECTION 3: UI / CORE UX PLUGINS -- guess-indent, gitsigns, which-key, colorscheme, todo-comments, mini modules -- ============================================================ do - -- [[ Configure plugins ]] - -- For most plugins you need to call their `.setup()` to start them + -- [[ Installing and Configuring Plugins ]] + -- + -- To install a plugin simply call `vim.pack.add` with its git url. + -- This will download the default branch of the plugin, which will usually be `main` or `master` + -- You can also have more advanced specs, which we will talk about later. -- - -- For example, here is the simplest possible setup for `guess-indent.nvim`, - -- which will automatically detect and set your indentation settings based on the current file. + -- For most plugins its not enough to install them, you also need to call their `.setup()` to start them. + -- + -- For example, lets say we want to install `guess-indent.nvim` - a plugin for + -- automatically detecting and setting the indentation. + -- + -- We first install it from https://github.com/NMAC427/guess-indent.nvim + -- and then call its `setup()` function to start it with default settings. + vim.pack.add { gh 'NMAC427/guess-indent.nvim' } require('guess-indent').setup {} - -- Here is a more advanced example that passes configuration options to `gitsigns.nvim` + -- Because lua is a real programming language, you can also have some logic to your installation - + -- like only installing a plugin if a condition is met. + -- + -- Here we only install `nvim-web-devicons` (which adds pretty icons) if we have a Nerd Font, + -- since otherwise the icons won't display properly. + if vim.g.have_nerd_font then vim.pack.add { gh 'nvim-tree/nvim-web-devicons' } end + + -- Here is a more advanced configuration example that passes options to `gitsigns.nvim` -- -- See `:help gitsigns` to understand what each configuration key does. -- Adds git related signs to the gutter, as well as utilities for managing changes + vim.pack.add { gh 'lewis6991/gitsigns.nvim' } require('gitsigns').setup { signs = { add = { text = '+' }, ---@diagnostic disable-line: missing-fields @@ -358,6 +355,7 @@ do } -- Useful plugin to show you pending keybinds. + vim.pack.add { gh 'folke/which-key.nvim' } require('which-key').setup { -- Delay between pressing a key and opening which-key (milliseconds) delay = 0, @@ -377,6 +375,7 @@ do -- change the command under that to load whatever the name of that colorscheme is. -- -- If you want to see what colorschemes are already installed, you can use `:Telescope colorscheme`. + vim.pack.add { gh 'folke/tokyonight.nvim' } ---@diagnostic disable-next-line: missing-fields require('tokyonight').setup { styles = { @@ -390,10 +389,12 @@ do vim.cmd.colorscheme 'tokyonight-night' -- Highlight todo, notes, etc in comments + vim.pack.add { gh 'folke/todo-comments.nvim' } require('todo-comments').setup { signs = false } -- [[ mini.nvim ]] -- A collection of various small independent plugins/modules + vim.pack.add { gh 'nvim-mini/mini.nvim' } -- Better Around/Inside textobjects -- @@ -463,6 +464,17 @@ do -- Telescope picker. This is really useful to discover what Telescope can -- do as well as how to actually do it! + ---@type (string|vim.pack.Spec)[] + local telescope_plugins = { + gh 'nvim-lua/plenary.nvim', + gh 'nvim-telescope/telescope.nvim', + gh 'nvim-telescope/telescope-ui-select.nvim', + } + if vim.fn.executable 'make' == 1 then table.insert(telescope_plugins, gh 'nvim-telescope/telescope-fzf-native.nvim') end + + -- NOTE: You can install multiple plugins at once + vim.pack.add(telescope_plugins) + -- See `:help telescope` and `:help telescope.setup()` require('telescope').setup { -- You can put your default mappings / updates / etc. in here @@ -590,6 +602,7 @@ do -- and elegantly composed help section, `:help lsp-vs-treesitter` -- Useful status updates for LSP. + vim.pack.add { gh 'j-hui/fidget.nvim' } require('fidget').setup {} -- This function gets run when an LSP attaches to a particular buffer. @@ -713,6 +726,13 @@ do }, } + vim.pack.add { + gh 'neovim/nvim-lspconfig', + gh 'mason-org/mason.nvim', + gh 'mason-org/mason-lspconfig.nvim', + gh 'WhoIsSethDaniel/mason-tool-installer.nvim', + } + -- Automatically install LSPs and related tools to stdpath for Neovim require('mason').setup {} @@ -742,6 +762,7 @@ end -- ============================================================ do -- [[ Formatting ]] + vim.pack.add { gh 'stevearc/conform.nvim' } require('conform').setup { notify_on_error = false, format_on_save = function(bufnr) @@ -779,6 +800,10 @@ end -- ============================================================ do -- [[ Snippet Engine ]] + + -- NOTE: You can also specify plugin using a version range for its git tag. + -- See `:help vim.version.range()` for more info + vim.pack.add { { src = gh 'L3MON4D3/LuaSnip', version = vim.version.range '2.*' } } require('luasnip').setup {} -- `friendly-snippets` contains a variety of premade snippets. @@ -789,6 +814,7 @@ do -- require('luasnip.loaders.from_vscode').lazy_load() -- [[ Autocomplete Engine ]] + vim.pack.add { { src = gh 'saghen/blink.cmp', version = vim.version.range '1.*' } } require('blink.cmp').setup { keymap = { -- 'default' (recommended) for mappings similar to built-in completions @@ -860,6 +886,9 @@ do -- -- See `:help nvim-treesitter-intro` + -- NOTE: You can also specify a branch or a specific commit + vim.pack.add { { src = gh 'nvim-treesitter/nvim-treesitter', version = 'main' } } + -- Ensure basic parsers are installed local parsers = { 'bash', 'c', 'diff', 'html', 'lua', 'luadoc', 'markdown', 'markdown_inline', 'query', 'vim', 'vimdoc' } require('nvim-treesitter').install(parsers) From a5d4d12c8cd4973b8a4602f1795518fa1d270071 Mon Sep 17 00:00:00 2001 From: Nathan Zeng Date: Sun, 5 Apr 2026 22:30:06 -0700 Subject: [PATCH 07/11] fix: deprecated diagnostic jumping config --- init.lua | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/init.lua b/init.lua index ec7ad44f777..5d29c72dc94 100644 --- a/init.lua +++ b/init.lua @@ -192,7 +192,15 @@ do 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 }, + jump = { + on_jump = function(_, bufnr) + vim.diagnostic.open_float { + bufnr = bufnr, + scope = 'cursor', + focus = false, + } + end, + }, } vim.keymap.set('n', 'q', vim.diagnostic.setloclist, { desc = 'Open diagnostic [Q]uickfix list' }) From 821b80cf95ecfe1f6a99ae4f07f68917d53c40d3 Mon Sep 17 00:00:00 2001 From: orip Date: Tue, 5 May 2026 22:40:07 +0300 Subject: [PATCH 08/11] Added: scripts/split_init.py By: Ori Perry from: oriori1703/kickstart-modular.nvim.git commit: 6aa660c test/modular --- scripts/split_init.py | 322 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 322 insertions(+) create mode 100644 scripts/split_init.py diff --git a/scripts/split_init.py b/scripts/split_init.py new file mode 100644 index 00000000000..b4b53912da2 --- /dev/null +++ b/scripts/split_init.py @@ -0,0 +1,322 @@ +#!/usr/bin/env python3 + +"""Split kickstart's monolithic init.lua into modular Lua files. + +This script is intentionally repo-specific. It understands the current section +markers in the single-file init.lua and emits the modular tree into a separate +output root: + +* init.lua loader +* one Lua file per core section (options, keymaps, pack, plugins) +* each generated file includes its original section header at the top + +Use --write to update files and --check to verify them. +""" + +from __future__ import annotations + +import argparse +import difflib +import re +import sys +from dataclasses import dataclass +from pathlib import Path +from typing import NoReturn, cast + + +@dataclass(frozen=True) +class CliArgs: + source: str + output_root: str + write: bool + check: bool + + +@dataclass(frozen=True) +class SectionHeader: + title: str + description: str + + +SECTION_HEADER_RE = re.compile(r"^-- SECTION (?P\d+): (?P.+)$") +SECTION_DESCRIPTION_RE = re.compile(r"^-- (?P<description>.+)$") +SEPARATOR_LINE = "-- ============================================================" +GH_HELPER = [ + "---Because most plugins are hosted on GitHub, you can use the helper", + "---function to have less repetition in the following sections.", + "---@param repo string", + "---@return string", + "local function gh(repo) return 'https://github.com/' .. repo end", +] + + +@dataclass(frozen=True) +class ModuleSpec: + number: int + path: Path + module: str + uses_gh: bool = False + + +FILE_SPECS = [ + ModuleSpec(1, Path("lua/options.lua"), "options"), + ModuleSpec(2, Path("lua/keymaps.lua"), "keymaps"), + ModuleSpec(3, Path("lua/pack.lua"), "pack"), + ModuleSpec(4, Path("lua/kickstart/plugins/ui.lua"), "kickstart.plugins.ui", uses_gh=True), + ModuleSpec(5, Path("lua/kickstart/plugins/search.lua"), "kickstart.plugins.search", uses_gh=True), + ModuleSpec(6, Path("lua/kickstart/plugins/lsp.lua"), "kickstart.plugins.lsp", uses_gh=True), + ModuleSpec(7, Path("lua/kickstart/plugins/formatting.lua"), "kickstart.plugins.formatting", uses_gh=True), + ModuleSpec(8, Path("lua/kickstart/plugins/completion.lua"), "kickstart.plugins.completion", uses_gh=True), + ModuleSpec(9, Path("lua/kickstart/plugins/treesitter.lua"), "kickstart.plugins.treesitter", uses_gh=True), +] + +ALL_SECTION_NUMBERS = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] + + +def fail(message: str) -> NoReturn: + raise SystemExit(message) + + +def read_lines(path: Path) -> list[str]: + try: + return path.read_text(encoding="utf-8").splitlines() + except FileNotFoundError: + fail(f"missing source file: {path}") + + +def render(lines: list[str]) -> str: + text = "\n".join(lines) + if not text.endswith("\n"): + text += "\n" + return text + + +def parse_section_headers(lines: list[str]) -> dict[int, SectionHeader]: + headers: dict[int, SectionHeader] = {} + for idx, line in enumerate(lines): + match = SECTION_HEADER_RE.match(line) + if match: + number = int(match.group("number")) + title = match.group("title") + description = "" + if idx + 1 < len(lines): + desc_match = SECTION_DESCRIPTION_RE.match(lines[idx + 1]) + if desc_match: + description = desc_match.group("description") + if number in headers: + fail(f"duplicate section marker {number}") + headers[number] = SectionHeader(title=title, description=description) + return headers + + +def make_header(number: int, header: SectionHeader) -> list[str]: + result = [ + SEPARATOR_LINE, + f"-- SECTION {number}: {header.title}", + f"-- {header.description}", + SEPARATOR_LINE, + "", + ] + return result + + +def find_section_headers(lines: list[str]) -> dict[int, int]: + headers: dict[int, int] = {} + for idx, line in enumerate(lines): + match = SECTION_HEADER_RE.match(line) + if match: + number = int(match.group("number")) + if number in headers: + fail(f"duplicate section marker {number}") + headers[number] = idx + return headers + + + +def section_start_index(lines: list[str], header_idx: int) -> int: + start_idx = header_idx - 1 + if start_idx < 0 or lines[start_idx] != SEPARATOR_LINE: + fail(f"section header at line {header_idx + 1} is missing its leading separator") + return start_idx + + +def section_end_index(lines: list[str], next_header_idx: int | None) -> int: + if next_header_idx is None: + for idx in range(len(lines) - 1, -1, -1): + if lines[idx] == "end": + return idx + fail("could not find the final section end") + + end_idx: int = next_header_idx - 2 + if end_idx < 0: + fail("invalid section boundary before the next header") + return end_idx + + +def section_body(lines: list[str]) -> list[str]: + do_idx = -1 + end_idx = -1 + for idx, line in enumerate(lines): + if line == "do" and do_idx < 0: + do_idx = idx + + if do_idx < 0: + fail("section did not contain a top-level do block") + + for idx in range(len(lines) - 1, do_idx, -1): + if lines[idx] == "end": + end_idx = idx + break + + if end_idx < 0: + fail("section did not contain a matching end block") + + return lines[do_idx + 1 : end_idx] + + +def dedent_block(lines: list[str]) -> list[str]: + dedented: list[str] = [] + for line in lines: + if line.startswith(" "): + dedented.append(line[2:]) + else: + dedented.append(line) + return dedented + + +def build_section_module(lines: list[str], uses_gh: bool) -> list[str]: + body = dedent_block(section_body(lines)) + if uses_gh: + return [*GH_HELPER, "", *body] + return body + + +def build_plugin_loader() -> list[str]: + lines = ["-- Load plugin modules in order.", ""] + lines.extend([f"require '{spec.module}'" for spec in FILE_SPECS[3:]]) + return lines + + +def build_root_init(prelude: list[str], postlude: list[str]) -> list[str]: + root = list(prelude) + if root and root[-1] != "": + root.append("") + + root.extend( + [ + "-- [[ Setting options ]]", + "require 'options'", + "", + "-- [[ Basic Keymaps ]]", + "require 'keymaps'", + "", + "-- [[ Set up vim.pack ]]", + "require 'pack'", + "", + "-- [[ Configure and install plugins ]]", + "require 'kickstart.plugins'", + ] + ) + root.extend(postlude) + return root + + +def build_outputs(source_lines: list[str]) -> dict[Path, list[str]]: + headers = find_section_headers(source_lines) + section_headers = parse_section_headers(source_lines) + expected_numbers = ALL_SECTION_NUMBERS + if sorted(headers) != expected_numbers: + fail(f"section markers do not match expected set: found {sorted(headers)}, expected {expected_numbers}") + + header_positions = [headers[number] for number in expected_numbers] + if header_positions != sorted(header_positions): + fail("section markers are out of order") + + first_header_idx = min(headers.values()) + first_section_start_idx = section_start_index(source_lines, first_header_idx) + prelude = source_lines[:first_section_start_idx] + + section_lines: list[list[str]] = [] + for i, number in enumerate(expected_numbers): + next_idx = headers[expected_numbers[i + 1]] if i + 1 < len(expected_numbers) else None + start = section_start_index(source_lines, headers[number]) + end = section_end_index(source_lines, next_idx) + section_lines.append(source_lines[start : end + 1]) + + spec_by_number = {spec.number: spec for spec in FILE_SPECS} + outputs: dict[Path, list[str]] = { + Path("init.lua"): build_root_init(prelude, source_lines[section_end_index(source_lines, None) + 1 :]), + Path("lua/kickstart/plugins/init.lua"): [*build_plugin_loader(), "", *make_header(10, section_headers[10]), *build_section_module(section_lines[9], False)], + } + + for i, number in enumerate(expected_numbers[:9]): + spec = spec_by_number[number] + outputs[spec.path] = [*make_header(number, section_headers[number]), *build_section_module(section_lines[i], spec.uses_gh)] + + return outputs + + +def write_outputs(outputs: dict[Path, list[str]], root: Path) -> None: + for rel_path, lines in outputs.items(): + path = root / rel_path + path.parent.mkdir(parents=True, exist_ok=True) + _ = path.write_text(render(lines), encoding="utf-8") + + +def check_outputs(outputs: dict[Path, list[str]], root: Path) -> int: + exit_code = 0 + for rel_path, lines in outputs.items(): + path = root / rel_path + expected = render(lines) + if not path.exists(): + print(f"MISSING {rel_path}") + exit_code = 1 + continue + + current = path.read_text(encoding="utf-8") + if current != expected: + print(f"DIFF {rel_path}") + diff = difflib.unified_diff( + current.splitlines(), + expected.splitlines(), + fromfile=str(rel_path), + tofile=f"expected/{rel_path}", + lineterm="", + ) + for line in diff: + print(line) + exit_code = 1 + return exit_code + + +def parse_args() -> CliArgs: + parser = argparse.ArgumentParser(description=__doc__) + _ = parser.add_argument("--source", default="init.lua", help="Path to the monolithic init.lua source file") + _ = parser.add_argument("--output-root", required=True, help="Directory where modular files should be written") + mode = parser.add_mutually_exclusive_group(required=True) + _ = mode.add_argument("--write", action="store_true", help="Write the split files to disk") + _ = mode.add_argument("--check", action="store_true", help="Check the split files without writing") + namespace = parser.parse_args() + return CliArgs( + source=cast(str, getattr(namespace, "source", "init.lua")), + output_root=cast(str, getattr(namespace, "output_root")), + write=cast(bool, getattr(namespace, "write", False)), + check=cast(bool, getattr(namespace, "check", False)), + ) + + +def main() -> int: + args = parse_args() + source = Path(args.source) + output_root = Path(args.output_root) + outputs = build_outputs(read_lines(source)) + + if args.write: + write_outputs(outputs, output_root) + return 0 + + return check_outputs(outputs, output_root) + + +if __name__ == "__main__": + sys.exit(main()) From 3e691bc7750f193b35ed6a5401b238f944318a62 Mon Sep 17 00:00:00 2001 From: Damjan 9000 <damjan.9000@gmail.com> Date: Wed, 3 Jun 2026 21:59:55 +0200 Subject: [PATCH 09/11] split_init.py: several adjustments to match existing modular structure more closer A couple of notable changes: - renamed section file names to match existing files in kickstart-modular - split ui section to separate plugins to match existing files in kickstart-modular - append modeline - merge gitsigns from init.lua and existing gitsigns.lua plugin This is so that the resulting file names match existing kickstart-modular files, which should make it easier to review changes, and also to merge these changes to anyone that is forking kickstart-modular --- scripts/split_init.py | 233 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 211 insertions(+), 22 deletions(-) diff --git a/scripts/split_init.py b/scripts/split_init.py index b4b53912da2..acf3d3e22d8 100644 --- a/scripts/split_init.py +++ b/scripts/split_init.py @@ -8,7 +8,7 @@ * init.lua loader * one Lua file per core section (options, keymaps, pack, plugins) -* each generated file includes its original section header at the top +* by default, no section headers are emitted (use --section-headers to include them) Use --write to update files and --check to verify them. """ @@ -19,7 +19,7 @@ import difflib import re import sys -from dataclasses import dataclass +from dataclasses import dataclass, field from pathlib import Path from typing import NoReturn, cast @@ -30,6 +30,7 @@ class CliArgs: output_root: str write: bool check: bool + section_headers: bool = False @dataclass(frozen=True) @@ -41,37 +42,44 @@ class SectionHeader: SECTION_HEADER_RE = re.compile(r"^-- SECTION (?P<number>\d+): (?P<title>.+)$") SECTION_DESCRIPTION_RE = re.compile(r"^-- (?P<description>.+)$") SEPARATOR_LINE = "-- ============================================================" +MODELINE = "-- vim: ts=2 sts=2 sw=2 et" +# Full gh() comments from init.lua: +# "---Because most plugins are hosted on GitHub, you can use the helper", +# "---function to have less repetition in the following sections.", +# "---@param repo string", +# "---@return string", GH_HELPER = [ - "---Because most plugins are hosted on GitHub, you can use the helper", - "---function to have less repetition in the following sections.", - "---@param repo string", - "---@return string", "local function gh(repo) return 'https://github.com/' .. repo end", ] -@dataclass(frozen=True) +@dataclass(frozen=False) class ModuleSpec: number: int path: Path module: str uses_gh: bool = False + split: bool = False + plugins: list[str] = field(default_factory=list) FILE_SPECS = [ ModuleSpec(1, Path("lua/options.lua"), "options"), ModuleSpec(2, Path("lua/keymaps.lua"), "keymaps"), ModuleSpec(3, Path("lua/pack.lua"), "pack"), - ModuleSpec(4, Path("lua/kickstart/plugins/ui.lua"), "kickstart.plugins.ui", uses_gh=True), - ModuleSpec(5, Path("lua/kickstart/plugins/search.lua"), "kickstart.plugins.search", uses_gh=True), - ModuleSpec(6, Path("lua/kickstart/plugins/lsp.lua"), "kickstart.plugins.lsp", uses_gh=True), - ModuleSpec(7, Path("lua/kickstart/plugins/formatting.lua"), "kickstart.plugins.formatting", uses_gh=True), - ModuleSpec(8, Path("lua/kickstart/plugins/completion.lua"), "kickstart.plugins.completion", uses_gh=True), + ModuleSpec(4, Path("lua/kickstart/plugins/ui.lua"), "kickstart.plugins.ui", + uses_gh=True, split=True), + ModuleSpec(5, Path("lua/kickstart/plugins/telescope.lua"), "kickstart.plugins.telescope", uses_gh=True), + ModuleSpec(6, Path("lua/kickstart/plugins/lspconfig.lua"), "kickstart.plugins.lspconfig", uses_gh=True), + ModuleSpec(7, Path("lua/kickstart/plugins/conform.lua"), "kickstart.plugins.conform", uses_gh=True), + ModuleSpec(8, Path("lua/kickstart/plugins/blink-cmp.lua"), "kickstart.plugins.blink-cmp", uses_gh=True), ModuleSpec(9, Path("lua/kickstart/plugins/treesitter.lua"), "kickstart.plugins.treesitter", uses_gh=True), ] ALL_SECTION_NUMBERS = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] +ARGS: CliArgs + def fail(message: str) -> NoReturn: raise SystemExit(message) @@ -191,9 +199,171 @@ def build_section_module(lines: list[str], uses_gh: bool) -> list[str]: return body +PLUGIN_NAME_RE = re.compile(r"gh\s*['\"]([^'\"]+)['\"]") + + +def extract_plugin_name(line: str) -> str: + """Extract plugin name from a vim.pack.add line. + + From 'vim.pack.add { gh \'folke/todo-comments.nvim\' }' → 'todo-comments' + From 'if ... then vim.pack.add { gh \'nvim-tree/nvim-web-devicons\' } end' → 'web-devicons' + """ + match = PLUGIN_NAME_RE.search(line) + if not match: + fail(f"could not extract plugin name from: {line}") + repo = match.group(1) # e.g. 'folke/todo-comments.nvim' + name = repo.rsplit('/', 1)[-1] # strip owner/ → 'todo-comments.nvim' + if name.endswith('.nvim'): + name = name[:-5] # strip .nvim suffix + return name + + +def extract_setup_content(lines: list[str]) -> str | None: + """Find 'setup {' in lines and return the inner content up to the matching '^}' line. + + Works because stylua keeps nested braces indented, so the closing brace + of the outermost setup block is always at column 0 after dedenting. + """ + for i, line in enumerate(lines): + if '.setup {' in line or '.setup{' in line: + content: list[str] = [] + for j in range(i + 1, len(lines)): + if lines[j] == '}': + return '\n'.join(content) + content.append(lines[j]) + return None + + +def _merge_with_extra(plugin_name: str, content: list[str], source_root: Path) -> list[str]: + """If a plugin has an extra config file with a setup block, merge them. + + The extra file's setup content is appended to the init.lua version. + A trailing comma is added to the first block if missing (styLua usually adds it). + """ + extra_path = source_root / 'lua' / 'kickstart' / 'plugins' / f'{plugin_name}.lua' + if not extra_path.exists(): + return content + + init_setup = extract_setup_content(content) + extra_setup = extract_setup_content(read_lines(extra_path)) + + if not init_setup or not extra_setup: + return content + + # Concatenate with comma safety + merged = init_setup.rstrip() + if not merged.endswith(','): + merged += ',' + merged += '\n' + extra_setup + + return replace_setup_block(content, merged) + + +def replace_setup_block(content: list[str], merged_setup: str) -> list[str]: + """Replace the existing setup { ... } block in content with a merged version.""" + result: list[str] = [] + i = 0 + while i < len(content): + line = content[i] + if '.setup {' in line or '.setup{' in line: + # Found the setup line — replace everything up to and including '^}' + result.append(line) + i += 1 + while i < len(content) and content[i] != '}': + i += 1 + # i is now at the '^}' line — skip it (we're replacing the whole block) + if i < len(content): + i += 1 + # Insert merged setup content (already properly indented from sources), plus closing brace + for ml in merged_setup.split('\n'): + result.append(ml) + result.append('}') + else: + result.append(line) + i += 1 + return result + + +def split_section(section_lines: list[str], spec: ModuleSpec, source_root: Path) -> dict[Path, list[str]]: + """Split a section into individual plugin files. + + Scans for vim.pack.add lines (not commented-out), groups the preceding + comment preamble + following code up to the next block, extracts the + plugin name, mutates spec.plugins with the ordered list of names, + and returns a mapping of filename → content lines. + """ + # Strip do/end wrapper and dedent (same as build_section_module does) + inner = dedent_block(section_body(section_lines)) + + # Step 1: Find all vim.pack.add boundaries with their preceding comment preambles + blocks: list[dict] = [] # [{preamble: [...], start: int, name: str}] + i = 0 + while i < len(inner): + line = inner[i] + # Skip commented-out lines + stripped = line.lstrip() + if stripped.startswith('--'): + i += 1 + continue + # Check for vim.pack.add (not necessarily at line start) + if 'vim.pack.add' in line: + # Walk backward to collect comment preamble + preamble: list[str] = [] + j = i - 1 + while j >= 0 and (inner[j].strip() == '' or inner[j].strip().startswith('--')): + preamble.insert(0, inner[j]) + j -= 1 + name = extract_plugin_name(line) + blocks.append({'preamble': preamble, 'start': i, 'name': name}) + i += 1 + + if not blocks: + fail("section contains no vim.pack.add blocks") + + # Step 2: Slice lines into blocks (each block = preamble + code up to next preamble) + outputs: dict[Path, list[str]] = {} + for idx, block in enumerate(blocks): + start = block['start'] + # End is the start of the next block's preamble, or end of inner + if idx + 1 < len(blocks): + next_preamble_start = blocks[idx + 1]['start'] - len(blocks[idx + 1]['preamble']) + else: + next_preamble_start = len(inner) + + # Collect lines from preamble start to just before next block's code + preamble_start = start - len(block['preamble']) + block_lines = inner[preamble_start:next_preamble_start] + + # Strip leading blank lines so the single "" after gh() is the only separator + while block_lines and block_lines[0].strip() == '': + block_lines.pop(0) + + # Add gh helper and format + if spec.uses_gh: + content = [*GH_HELPER, "", *block_lines] + else: + content = list(block_lines) + + # Post-process: merge with extra config file if one exists + content = _merge_with_extra(block['name'], content, source_root) + + plugin_path = Path(f"lua/kickstart/plugins/{block['name']}.lua") + outputs[plugin_path] = content + + # Step 3: Populate spec.plugins (side effect) + spec.plugins = [b['name'] for b in blocks] + + return outputs + + def build_plugin_loader() -> list[str]: lines = ["-- Load plugin modules in order.", ""] - lines.extend([f"require '{spec.module}'" for spec in FILE_SPECS[3:]]) + for spec in FILE_SPECS[3:]: + if spec.split: + for name in spec.plugins: + lines.append(f"require 'kickstart.plugins.{name}'") + else: + lines.append(f"require '{spec.module}'") return lines @@ -214,14 +384,14 @@ def build_root_init(prelude: list[str], postlude: list[str]) -> list[str]: "require 'pack'", "", "-- [[ Configure and install plugins ]]", - "require 'kickstart.plugins'", + "require 'plugins'", ] ) root.extend(postlude) return root -def build_outputs(source_lines: list[str]) -> dict[Path, list[str]]: +def build_outputs(source_lines: list[str], source_root: Path) -> dict[Path, list[str]]: headers = find_section_headers(source_lines) section_headers = parse_section_headers(source_lines) expected_numbers = ALL_SECTION_NUMBERS @@ -243,15 +413,31 @@ def build_outputs(source_lines: list[str]) -> dict[Path, list[str]]: end = section_end_index(source_lines, next_idx) section_lines.append(source_lines[start : end + 1]) + def _header(number: int) -> list[str]: + if ARGS.section_headers: + return make_header(number, section_headers[number]) + return [] + spec_by_number = {spec.number: spec for spec in FILE_SPECS} outputs: dict[Path, list[str]] = { Path("init.lua"): build_root_init(prelude, source_lines[section_end_index(source_lines, None) + 1 :]), - Path("lua/kickstart/plugins/init.lua"): [*build_plugin_loader(), "", *make_header(10, section_headers[10]), *build_section_module(section_lines[9], False)], } + # Process sections first (populates spec.plugins for split sections) for i, number in enumerate(expected_numbers[:9]): spec = spec_by_number[number] - outputs[spec.path] = [*make_header(number, section_headers[number]), *build_section_module(section_lines[i], spec.uses_gh)] + if spec.split: + outputs.update(split_section(section_lines[i], spec, source_root)) + else: + outputs[spec.path] = [*_header(number), *build_section_module(section_lines[i], spec.uses_gh)] + + # Generate plugins.lua after split sections are processed + outputs[Path("lua/plugins.lua")] = [*build_plugin_loader(), "", *_header(10), *build_section_module(section_lines[9], False)] + + # Append modeline to every output file + for lines in outputs.values(): + if lines and lines[-1] != MODELINE: + lines.append(MODELINE) return outputs @@ -296,22 +482,25 @@ def parse_args() -> CliArgs: mode = parser.add_mutually_exclusive_group(required=True) _ = mode.add_argument("--write", action="store_true", help="Write the split files to disk") _ = mode.add_argument("--check", action="store_true", help="Check the split files without writing") + _ = parser.add_argument("--section-headers", action="store_true", help="Include section headers in generated files") namespace = parser.parse_args() return CliArgs( source=cast(str, getattr(namespace, "source", "init.lua")), output_root=cast(str, getattr(namespace, "output_root")), write=cast(bool, getattr(namespace, "write", False)), check=cast(bool, getattr(namespace, "check", False)), + section_headers=cast(bool, getattr(namespace, "section_headers", False)), ) def main() -> int: - args = parse_args() - source = Path(args.source) - output_root = Path(args.output_root) - outputs = build_outputs(read_lines(source)) + global ARGS + ARGS = parse_args() + source = Path(ARGS.source) + output_root = Path(ARGS.output_root) + outputs = build_outputs(read_lines(source), source.parent) - if args.write: + if ARGS.write: write_outputs(outputs, output_root) return 0 From 3fc36390567850deab4bf1605b71f969f38ae980 Mon Sep 17 00:00:00 2001 From: Damjan 9000 <damjan.9000@gmail.com> Date: Thu, 11 Jun 2026 23:37:03 +0200 Subject: [PATCH 10/11] Apply suggestions from code review Co-authored-by: Ori Perry <48057913+oriori1703@users.noreply.github.com> --- scripts/split_init.py | 93 ++++++++++++++++++++++--------------------- 1 file changed, 47 insertions(+), 46 deletions(-) diff --git a/scripts/split_init.py b/scripts/split_init.py index acf3d3e22d8..644efb6be2b 100644 --- a/scripts/split_init.py +++ b/scripts/split_init.py @@ -53,6 +53,13 @@ class SectionHeader: ] +@dataclass(frozen=True) +class PluginBlock: + preamble: list[str] + start: int + name: str + + @dataclass(frozen=False) class ModuleSpec: number: int @@ -213,27 +220,34 @@ def extract_plugin_name(line: str) -> str: fail(f"could not extract plugin name from: {line}") repo = match.group(1) # e.g. 'folke/todo-comments.nvim' name = repo.rsplit('/', 1)[-1] # strip owner/ → 'todo-comments.nvim' - if name.endswith('.nvim'): - name = name[:-5] # strip .nvim suffix - return name + return name.removesuffix('.nvim') -def extract_setup_content(lines: list[str]) -> str | None: - """Find 'setup {' in lines and return the inner content up to the matching '^}' line. +def find_setup_block(lines: list[str]) -> tuple[int, int] | None: + """Find a setup { ... } block and return (start_idx, end_idx) inclusive. Works because stylua keeps nested braces indented, so the closing brace of the outermost setup block is always at column 0 after dedenting. + Returns None if no setup block is found. """ for i, line in enumerate(lines): - if '.setup {' in line or '.setup{' in line: - content: list[str] = [] + if '.setup {' in line: for j in range(i + 1, len(lines)): if lines[j] == '}': - return '\n'.join(content) - content.append(lines[j]) + return (i, j) + break # setup found but no closing brace return None +def extract_setup_content(lines: list[str]) -> str | None: + """Extract the inner content of a setup { ... } block.""" + block = find_setup_block(lines) + if block is None: + return None + start, end = block + return '\n'.join(lines[start + 1:end]) + + def _merge_with_extra(plugin_name: str, content: list[str], source_root: Path) -> list[str]: """If a plugin has an extra config file with a setup block, merge them. @@ -261,26 +275,15 @@ def _merge_with_extra(plugin_name: str, content: list[str], source_root: Path) - def replace_setup_block(content: list[str], merged_setup: str) -> list[str]: """Replace the existing setup { ... } block in content with a merged version.""" - result: list[str] = [] - i = 0 - while i < len(content): - line = content[i] - if '.setup {' in line or '.setup{' in line: - # Found the setup line — replace everything up to and including '^}' - result.append(line) - i += 1 - while i < len(content) and content[i] != '}': - i += 1 - # i is now at the '^}' line — skip it (we're replacing the whole block) - if i < len(content): - i += 1 - # Insert merged setup content (already properly indented from sources), plus closing brace - for ml in merged_setup.split('\n'): - result.append(ml) - result.append('}') - else: - result.append(line) - i += 1 + block = find_setup_block(content) + if block is None: + return content + start, end = block + result = list(content[:start + 1]) # everything including the setup line + for ml in merged_setup.split('\n'): + result.append(ml) + result.append('}') + result.extend(content[end + 1:]) # everything after closing brace return result @@ -296,26 +299,23 @@ def split_section(section_lines: list[str], spec: ModuleSpec, source_root: Path) inner = dedent_block(section_body(section_lines)) # Step 1: Find all vim.pack.add boundaries with their preceding comment preambles - blocks: list[dict] = [] # [{preamble: [...], start: int, name: str}] - i = 0 - while i < len(inner): - line = inner[i] + blocks: list[PluginBlock] = [] + for i, line in enumerate(inner): # Skip commented-out lines stripped = line.lstrip() if stripped.startswith('--'): - i += 1 continue # Check for vim.pack.add (not necessarily at line start) if 'vim.pack.add' in line: # Walk backward to collect comment preamble preamble: list[str] = [] - j = i - 1 - while j >= 0 and (inner[j].strip() == '' or inner[j].strip().startswith('--')): - preamble.insert(0, inner[j]) - j -= 1 + for j in range(i - 1, -1, -1): + if inner[j].strip() == '' or inner[j].strip().startswith('--'): + preamble.insert(0, inner[j]) + else: + break name = extract_plugin_name(line) - blocks.append({'preamble': preamble, 'start': i, 'name': name}) - i += 1 + blocks.append(PluginBlock(preamble=preamble, start=i, name=name)) if not blocks: fail("section contains no vim.pack.add blocks") @@ -323,15 +323,15 @@ def split_section(section_lines: list[str], spec: ModuleSpec, source_root: Path) # Step 2: Slice lines into blocks (each block = preamble + code up to next preamble) outputs: dict[Path, list[str]] = {} for idx, block in enumerate(blocks): - start = block['start'] + start = block.start # End is the start of the next block's preamble, or end of inner if idx + 1 < len(blocks): - next_preamble_start = blocks[idx + 1]['start'] - len(blocks[idx + 1]['preamble']) + next_preamble_start = blocks[idx + 1].start - len(blocks[idx + 1].preamble) else: next_preamble_start = len(inner) # Collect lines from preamble start to just before next block's code - preamble_start = start - len(block['preamble']) + preamble_start = start - len(block.preamble) block_lines = inner[preamble_start:next_preamble_start] # Strip leading blank lines so the single "" after gh() is the only separator @@ -345,13 +345,13 @@ def split_section(section_lines: list[str], spec: ModuleSpec, source_root: Path) content = list(block_lines) # Post-process: merge with extra config file if one exists - content = _merge_with_extra(block['name'], content, source_root) + content = _merge_with_extra(block.name, content, source_root) - plugin_path = Path(f"lua/kickstart/plugins/{block['name']}.lua") + plugin_path = Path(f"lua/kickstart/plugins/{block.name}.lua") outputs[plugin_path] = content # Step 3: Populate spec.plugins (side effect) - spec.plugins = [b['name'] for b in blocks] + spec.plugins = [b.name for b in blocks] return outputs @@ -437,6 +437,7 @@ def _header(number: int) -> list[str]: # Append modeline to every output file for lines in outputs.values(): if lines and lines[-1] != MODELINE: + lines.append("") lines.append(MODELINE) return outputs From f26595a5536777f22a237de0857fdd0d8c9286af Mon Sep 17 00:00:00 2001 From: Damjan 9000 <damjan.9000@gmail.com> Date: Fri, 12 Jun 2026 01:04:02 +0200 Subject: [PATCH 11/11] insert empty line before vim modeline --- lua/keymaps.lua | 1 + lua/kickstart/plugins/blink-cmp.lua | 1 + lua/kickstart/plugins/conform.lua | 1 + lua/kickstart/plugins/gitsigns.lua | 1 + lua/kickstart/plugins/guess-indent.lua | 1 + lua/kickstart/plugins/lspconfig.lua | 1 + lua/kickstart/plugins/mini.lua | 1 + lua/kickstart/plugins/nvim-web-devicons.lua | 1 + lua/kickstart/plugins/telescope.lua | 1 + lua/kickstart/plugins/todo-comments.lua | 1 + lua/kickstart/plugins/tokyonight.lua | 1 + lua/kickstart/plugins/treesitter.lua | 1 + lua/kickstart/plugins/which-key.lua | 1 + lua/options.lua | 1 + lua/pack.lua | 1 + lua/plugins.lua | 1 + 16 files changed, 16 insertions(+) diff --git a/lua/keymaps.lua b/lua/keymaps.lua index eeb4da9dd4e..1144bc8e95d 100644 --- a/lua/keymaps.lua +++ b/lua/keymaps.lua @@ -71,4 +71,5 @@ vim.api.nvim_create_autocmd('TextYankPost', { group = vim.api.nvim_create_augroup('kickstart-highlight-yank', { clear = true }), callback = function() vim.hl.on_yank() end, }) + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/blink-cmp.lua b/lua/kickstart/plugins/blink-cmp.lua index 4d794c64dd6..4c2741ae6f5 100644 --- a/lua/kickstart/plugins/blink-cmp.lua +++ b/lua/kickstart/plugins/blink-cmp.lua @@ -75,4 +75,5 @@ require('blink.cmp').setup { -- Shows a signature help window while you type arguments for a function signature = { enabled = true }, } + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/conform.lua b/lua/kickstart/plugins/conform.lua index cf38a248f4f..cb479d27a82 100644 --- a/lua/kickstart/plugins/conform.lua +++ b/lua/kickstart/plugins/conform.lua @@ -31,4 +31,5 @@ require('conform').setup { } vim.keymap.set({ 'n', 'v' }, '<leader>f', function() require('conform').format { async = true } end, { desc = '[F]ormat buffer' }) + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/gitsigns.lua b/lua/kickstart/plugins/gitsigns.lua index 3c5411e181f..dc6ab05d596 100644 --- a/lua/kickstart/plugins/gitsigns.lua +++ b/lua/kickstart/plugins/gitsigns.lua @@ -63,4 +63,5 @@ require('gitsigns').setup { map({ 'o', 'x' }, 'ih', gitsigns.select_hunk) end, } + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/guess-indent.lua b/lua/kickstart/plugins/guess-indent.lua index 5be2a68ce94..c3b2123ad33 100644 --- a/lua/kickstart/plugins/guess-indent.lua +++ b/lua/kickstart/plugins/guess-indent.lua @@ -15,4 +15,5 @@ local function gh(repo) return 'https://github.com/' .. repo end -- and then call its `setup()` function to start it with default settings. vim.pack.add { gh 'NMAC427/guess-indent.nvim' } require('guess-indent').setup {} + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/lspconfig.lua b/lua/kickstart/plugins/lspconfig.lua index 4ac2d03114c..5b8104519da 100644 --- a/lua/kickstart/plugins/lspconfig.lua +++ b/lua/kickstart/plugins/lspconfig.lua @@ -179,4 +179,5 @@ for name, server in pairs(servers) do vim.lsp.config(name, server) vim.lsp.enable(name) end + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/mini.lua b/lua/kickstart/plugins/mini.lua index cc0b083be63..487bcf20ea5 100644 --- a/lua/kickstart/plugins/mini.lua +++ b/lua/kickstart/plugins/mini.lua @@ -41,4 +41,5 @@ statusline.section_location = function() return '%2l:%-2v' end -- ... and there is more! -- Check out: https://github.com/nvim-mini/mini.nvim + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/nvim-web-devicons.lua b/lua/kickstart/plugins/nvim-web-devicons.lua index b21902aea00..e78b68bf4ee 100644 --- a/lua/kickstart/plugins/nvim-web-devicons.lua +++ b/lua/kickstart/plugins/nvim-web-devicons.lua @@ -6,4 +6,5 @@ local function gh(repo) return 'https://github.com/' .. repo end -- Here we only install `nvim-web-devicons` (which adds pretty icons) if we have a Nerd Font, -- since otherwise the icons won't display properly. if vim.g.have_nerd_font then vim.pack.add { gh 'nvim-tree/nvim-web-devicons' } end + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/telescope.lua b/lua/kickstart/plugins/telescope.lua index 3247efed869..e1e057a29b0 100644 --- a/lua/kickstart/plugins/telescope.lua +++ b/lua/kickstart/plugins/telescope.lua @@ -128,4 +128,5 @@ vim.keymap.set( -- Shortcut for searching your Neovim configuration files vim.keymap.set('n', '<leader>sn', function() builtin.find_files { cwd = vim.fn.stdpath 'config' } end, { desc = '[S]earch [N]eovim files' }) + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/todo-comments.lua b/lua/kickstart/plugins/todo-comments.lua index 03c00c5f161..6b2b5384f33 100644 --- a/lua/kickstart/plugins/todo-comments.lua +++ b/lua/kickstart/plugins/todo-comments.lua @@ -3,4 +3,5 @@ local function gh(repo) return 'https://github.com/' .. repo end -- Highlight todo, notes, etc in comments vim.pack.add { gh 'folke/todo-comments.nvim' } require('todo-comments').setup { signs = false } + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/tokyonight.lua b/lua/kickstart/plugins/tokyonight.lua index 8f635f4a17b..792ae9c3691 100644 --- a/lua/kickstart/plugins/tokyonight.lua +++ b/lua/kickstart/plugins/tokyonight.lua @@ -18,4 +18,5 @@ require('tokyonight').setup { -- Like many other themes, this one has different styles, and you could load -- any other, such as 'tokyonight-storm', 'tokyonight-moon', or 'tokyonight-day'. vim.cmd.colorscheme 'tokyonight-night' + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/treesitter.lua b/lua/kickstart/plugins/treesitter.lua index 9895481d688..4a18c5ce58d 100644 --- a/lua/kickstart/plugins/treesitter.lua +++ b/lua/kickstart/plugins/treesitter.lua @@ -55,4 +55,5 @@ vim.api.nvim_create_autocmd('FileType', { end end, }) + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/kickstart/plugins/which-key.lua b/lua/kickstart/plugins/which-key.lua index acd93cea515..53ae352fdbc 100644 --- a/lua/kickstart/plugins/which-key.lua +++ b/lua/kickstart/plugins/which-key.lua @@ -14,4 +14,5 @@ require('which-key').setup { { 'gr', group = 'LSP Actions', mode = { 'n' } }, }, } + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/options.lua b/lua/options.lua index 147692d631c..94b0d8415a0 100644 --- a/lua/options.lua +++ b/lua/options.lua @@ -80,4 +80,5 @@ vim.o.scrolloff = 10 -- instead raise a dialog asking if you wish to save the current file(s) -- See `:help 'confirm'` vim.o.confirm = true + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/pack.lua b/lua/pack.lua index c09e7630343..c43e1f3109a 100644 --- a/lua/pack.lua +++ b/lua/pack.lua @@ -57,4 +57,5 @@ vim.api.nvim_create_autocmd('PackChanged', { end end, }) + -- vim: ts=2 sts=2 sw=2 et diff --git a/lua/plugins.lua b/lua/plugins.lua index 2d7a2ccac60..e962c0a535a 100644 --- a/lua/plugins.lua +++ b/lua/plugins.lua @@ -33,4 +33,5 @@ require 'kickstart.plugins.treesitter' -- -- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going. -- require 'custom.plugins' + -- vim: ts=2 sts=2 sw=2 et