From 01ed2525bbff69756cd867673dea4dd9e54dfdee Mon Sep 17 00:00:00 2001
From: Ashraf Michail <user@noemail.com>
Date: Tue, 3 Oct 2023 13:22:25 +0000
Subject: [PATCH 01/40] Fix bash errors
---
init.lua | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index 11f55d05..ee1f390e 100644
--- a/init.lua
+++ b/init.lua
@@ -333,7 +333,7 @@ vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc =
vim.defer_fn(function()
require('nvim-treesitter.configs').setup {
-- Add languages to be installed here that you want installed for treesitter
- ensure_installed = { 'c', 'cpp', 'go', 'lua', 'python', 'rust', 'tsx', 'javascript', 'typescript', 'vimdoc', 'vim' },
+ ensure_installed = { 'c', 'cpp', 'go', 'lua', 'python', 'rust', 'tsx', 'javascript', 'typescript', 'vimdoc', 'vim', 'bash' },
-- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
auto_install = false,
From c27b05467a80a36a2be757a84384ffba86221094 Mon Sep 17 00:00:00 2001
From: Pedro Santayana <me@pedrosantayana.dev>
Date: Sat, 7 Oct 2023 22:34:24 -0300
Subject: [PATCH 02/40] docs: fix misstype on README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4d27756c..433a51de 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ Neovim's configurations are located under the following paths, depending on your
| OS | PATH |
| :- | :--- |
| Linux | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
-| MacOS | `$XDG_CONFIG_HOME/nvim`, '~/.config/nvim` |
+| MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| Windows | `%userprofile%\AppData\Local\nvim\` |
Clone kickstart.nvim:
From db7189f35c33f9b7e95a1602ff4d8dffe5cbf741 Mon Sep 17 00:00:00 2001
From: Alvaro-Kothe <kothe65@gmail.com>
Date: Tue, 10 Oct 2023 19:57:49 -0300
Subject: [PATCH 03/40] Fix help for indent-blankline plugin
Since version 3 `:help indent_blankline` no longer works. Replace it
with `:help ibl`.
---
init.lua | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index ee1f390e..fb080807 100644
--- a/init.lua
+++ b/init.lua
@@ -177,7 +177,7 @@ require('lazy').setup({
-- Add indentation guides even on blank lines
'lukas-reineke/indent-blankline.nvim',
-- Enable `lukas-reineke/indent-blankline.nvim`
- -- See `:help indent_blankline.txt`
+ -- See `:help ibl`
main = 'ibl',
opts = {},
},
From 5d8921990bf2fab9a1c9dc0d74bf1bbe1b6dc980 Mon Sep 17 00:00:00 2001
From: Theo P <theo.park.n@gmail.com>
Date: Fri, 13 Oct 2023 16:21:10 +0900
Subject: [PATCH 04/40] feat(lsp): use Telescope builtin functions for LSP
definition and type definition
---
init.lua | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/init.lua b/init.lua
index fb080807..a7667ddc 100644
--- a/init.lua
+++ b/init.lua
@@ -422,10 +422,10 @@ local on_attach = function(_, bufnr)
nmap('<leader>rn', vim.lsp.buf.rename, '[R]e[n]ame')
nmap('<leader>ca', vim.lsp.buf.code_action, '[C]ode [A]ction')
- nmap('gd', vim.lsp.buf.definition, '[G]oto [D]efinition')
+ nmap('gd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')
nmap('gr', require('telescope.builtin').lsp_references, '[G]oto [R]eferences')
nmap('gI', require('telescope.builtin').lsp_implementations, '[G]oto [I]mplementation')
- nmap('<leader>D', vim.lsp.buf.type_definition, 'Type [D]efinition')
+ nmap('<leader>D', require('telescope.builtin').lsp_type_definitions, 'Type [D]efinition')
nmap('<leader>ds', require('telescope.builtin').lsp_document_symbols, '[D]ocument [S]ymbols')
nmap('<leader>ws', require('telescope.builtin').lsp_dynamic_workspace_symbols, '[W]orkspace [S]ymbols')
From 68b1981f0298f5b92b68acc00f42eda5702c4044 Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Wed, 25 Oct 2023 21:46:24 +0200
Subject: [PATCH 05/40] Update README Post Installation steps
Change the recommendation to just run nvim normally instead of the headless
mode for the first run. This will show Lazy UI updating the plugins which
would match what the video show and may be easier to understand what is going
on thant the silent headless run.
---
README.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 433a51de..f8198270 100644
--- a/README.md
+++ b/README.md
@@ -51,7 +51,15 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\L
### Post Installation
-Run the following command and then **you are ready to go**!
+Start Neovim
+
+```sh
+nvim
+```
+
+The `Lazy` plugin manager will start automatically on the first run and install the configured plugins - as can be seen in the introduction video. After the installation is complete you can press `q` to close the `Lazy` UI and **you are ready to go**! Next time you run nvim `Lazy` will no longer show up.
+
+If you would prefer to hide this step and run the plugin sync from the command line, you can use:
```sh
nvim --headless "+Lazy! sync" +qa
From 0dd934ee017cdd52bc91b4e5dd9f4e4e31a5d98b Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Sat, 28 Oct 2023 23:33:10 +0200
Subject: [PATCH 06/40] README.md: add a note about NVIM_APPNAME in the FAQ
section
---
README.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/README.md b/README.md
index f8198270..9652d708 100644
--- a/README.md
+++ b/README.md
@@ -149,6 +149,13 @@ Each PR, especially those which increase the line count, should have a descripti
* You should back it up, then delete all files associated with it.
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
* You may also want to look at the [migration guide for lazy.nvim](https://github.com/folke/lazy.nvim#-migration-guide)
+* Can I keep my existing configuration in parallel to kickstart?
+ * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example you can install the kickstart configuration in `~/.config/nvim-kickstart` and create a script `~/bin/nvim-kickstart`:
+ ```
+ #!/bin/sh
+ exec env NVIM_APPNAME=nvim-kickstart nvim "$@"
+ ```
+ When you run Neovim with `nvim-kickstart` it will use the alternative config directory and the matching local directory: `~/.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://github.com/folke/lazy.nvim#-uninstalling) information
* Are there any cool videos about this plugin?
From 4d2cf48fb6b620a5b4ae30f6b2a0b3b521cdbce8 Mon Sep 17 00:00:00 2001
From: n-a11s <nikolaus.athanassiadis@gmail.com>
Date: Fri, 3 Nov 2023 13:47:30 +0100
Subject: [PATCH 07/40] Update README.md
Added information on where to install if you use Powershell in windows. Since CMD and Powershell work differently.
`%userprofile%` only works for the CMD application.
`$env:USERPROFILE` works in Powershell.
---
README.md | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 9652d708..e2d9ea84 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,8 @@ Neovim's configurations are located under the following paths, depending on your
| :- | :--- |
| Linux | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
-| Windows | `%userprofile%\AppData\Local\nvim\` |
+| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
+| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
Clone kickstart.nvim:
@@ -45,10 +46,16 @@ git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HO
```
-# on Windows
+# on Windows (cmd)
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
```
+```
+# on Windows (powershell)
+git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
+```
+
+
### Post Installation
Start Neovim
From 1ad1ec250907acd6e1c593f9990eb61430aa7c74 Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Fri, 3 Nov 2023 19:04:25 +0100
Subject: [PATCH 08/40] README.md: Added a FAQ: why is init.lua a single file
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index 9652d708..1f8e6f40 100644
--- a/README.md
+++ b/README.md
@@ -161,6 +161,16 @@ Each PR, especially those which increase the line count, should have a descripti
* Are there any cool videos about this plugin?
* Current iteration of kickstart (coming soon)
* Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s). Note the install via init.lua no longer works as specified. Please follow the install instructions in this file instead as they're up to date.
+* 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 `git clone` as a basis for their own.
+ As you progress in learning Neovim and Lua, you might consider splitting `init.lua`
+ into smaller parts. A fork of kickstart that does this while maintaining the exact
+ same functionality is available here:
+ * [kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim)
+ * Discussions on this topic can be found here:
+ * [Restructure the configuration](https://github.com/nvim-lua/kickstart.nvim/issues/218)
+ * [Reorganize init.lua into a multi-file setup](https://github.com/nvim-lua/kickstart.nvim/pull/473)
### Windows Installation
From 0fda9af7c94a2c3687a5123a7cf254613de45a46 Mon Sep 17 00:00:00 2001
From: Sebastian Lara Menares <slara@mtsolutions.io>
Date: Mon, 6 Nov 2023 11:10:16 -0300
Subject: [PATCH 09/40] add Telescope live_grep on Git root
---
init.lua | 37 ++++++++++++++++++++++++++++++++++++-
1 file changed, 36 insertions(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index a7667ddc..a301a94e 100644
--- a/init.lua
+++ b/init.lua
@@ -308,6 +308,40 @@ require('telescope').setup {
-- Enable telescope fzf native, if installed
pcall(require('telescope').load_extension, 'fzf')
+-- Telescope live_grep in git root
+-- Function to find the git root directory based on the current buffer's path
+local function find_git_root()
+ -- Use the current buffer's path as the starting point for the git search
+ local current_file = vim.api.nvim_buf_get_name(0)
+ -- If the buffer is not associated with a file, return nil
+ if current_file == "" then
+ print("Buffer is not associated with a file")
+ return nil
+ end
+ -- Extract the directory from the current file's path
+ local current_dir = vim.fn.fnamemodify(current_file, ":h")
+ -- Find the Git root directory from the current file's path
+ print("git -C " .. vim.fn.escape(current_dir, " ") .. " rev-parse --show-toplevel")
+ local git_root = vim.fn.systemlist("git -C " .. vim.fn.escape(current_dir, " ") .. " rev-parse --show-toplevel")[1]
+ if vim.v.shell_error ~= 0 then
+ print("Not a git repository")
+ return nil
+ end
+ return git_root
+end
+
+-- Custom live_grep function to search in git root
+local function live_grep_git_root()
+ local git_root = find_git_root()
+ if git_root then
+ require('telescope.builtin').live_grep({
+ search_dirs = {git_root},
+ })
+ end
+end
+
+vim.api.nvim_create_user_command('LiveGrepGitRoot', live_grep_git_root, {})
+
-- See `:help telescope.builtin`
vim.keymap.set('n', '<leader>?', require('telescope.builtin').oldfiles, { desc = '[?] Find recently opened files' })
vim.keymap.set('n', '<leader><space>', require('telescope.builtin').buffers, { desc = '[ ] Find existing buffers' })
@@ -323,7 +357,8 @@ vim.keymap.set('n', '<leader>gf', require('telescope.builtin').git_files, { desc
vim.keymap.set('n', '<leader>sf', require('telescope.builtin').find_files, { desc = '[S]earch [F]iles' })
vim.keymap.set('n', '<leader>sh', require('telescope.builtin').help_tags, { desc = '[S]earch [H]elp' })
vim.keymap.set('n', '<leader>sw', require('telescope.builtin').grep_string, { desc = '[S]earch current [W]ord' })
-vim.keymap.set('n', '<leader>sg', require('telescope.builtin').live_grep, { desc = '[S]earch by [G]rep' })
+vim.keymap.set('n', '<leader>sG', require('telescope.builtin').live_grep, { desc = '[S]earch by [G]rep' })
+vim.keymap.set('n', '<leader>sg', ':LiveGrepGitRoot<cr>', { desc = '[S]earch by [G]rep on Git Root' })
vim.keymap.set('n', '<leader>sd', require('telescope.builtin').diagnostics, { desc = '[S]earch [D]iagnostics' })
vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
From 5ce4f38e1e9b62c7e2477b2e21af08ecac232bc5 Mon Sep 17 00:00:00 2001
From: Sebastian Lara Menares <slara@mtsolutions.io>
Date: Mon, 6 Nov 2023 15:29:09 -0300
Subject: [PATCH 10/40] change keymap to not disrupt existing users of Search
by Grep
---
init.lua | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/init.lua b/init.lua
index a301a94e..b4b83051 100644
--- a/init.lua
+++ b/init.lua
@@ -321,7 +321,6 @@ local function find_git_root()
-- Extract the directory from the current file's path
local current_dir = vim.fn.fnamemodify(current_file, ":h")
-- Find the Git root directory from the current file's path
- print("git -C " .. vim.fn.escape(current_dir, " ") .. " rev-parse --show-toplevel")
local git_root = vim.fn.systemlist("git -C " .. vim.fn.escape(current_dir, " ") .. " rev-parse --show-toplevel")[1]
if vim.v.shell_error ~= 0 then
print("Not a git repository")
@@ -357,8 +356,8 @@ vim.keymap.set('n', '<leader>gf', require('telescope.builtin').git_files, { desc
vim.keymap.set('n', '<leader>sf', require('telescope.builtin').find_files, { desc = '[S]earch [F]iles' })
vim.keymap.set('n', '<leader>sh', require('telescope.builtin').help_tags, { desc = '[S]earch [H]elp' })
vim.keymap.set('n', '<leader>sw', require('telescope.builtin').grep_string, { desc = '[S]earch current [W]ord' })
-vim.keymap.set('n', '<leader>sG', require('telescope.builtin').live_grep, { desc = '[S]earch by [G]rep' })
-vim.keymap.set('n', '<leader>sg', ':LiveGrepGitRoot<cr>', { desc = '[S]earch by [G]rep on Git Root' })
+vim.keymap.set('n', '<leader>sg', require('telescope.builtin').live_grep, { desc = '[S]earch by [G]rep' })
+vim.keymap.set('n', '<leader>sG', ':LiveGrepGitRoot<cr>', { desc = '[S]earch by [G]rep on Git Root' })
vim.keymap.set('n', '<leader>sd', require('telescope.builtin').diagnostics, { desc = '[S]earch [D]iagnostics' })
vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
From 1d14453024dcb8e2025ba3a14d5c3f1daa384e63 Mon Sep 17 00:00:00 2001
From: Sebastian Lara Menares <slara@mtsolutions.io>
Date: Mon, 6 Nov 2023 22:29:05 -0300
Subject: [PATCH 11/40] Live Grep from Git root falls back to cwd on special
buffers
---
init.lua | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/init.lua b/init.lua
index b4b83051..0976a461 100644
--- a/init.lua
+++ b/init.lua
@@ -313,18 +313,21 @@ pcall(require('telescope').load_extension, 'fzf')
local function find_git_root()
-- Use the current buffer's path as the starting point for the git search
local current_file = vim.api.nvim_buf_get_name(0)
+ local current_dir
+ local cwd = vim.fn.getcwd()
-- If the buffer is not associated with a file, return nil
if current_file == "" then
- print("Buffer is not associated with a file")
- return nil
+ current_dir = cwd
+ else
+ -- Extract the directory from the current file's path
+ current_dir = vim.fn.fnamemodify(current_file, ":h")
end
- -- Extract the directory from the current file's path
- local current_dir = vim.fn.fnamemodify(current_file, ":h")
+
-- Find the Git root directory from the current file's path
local git_root = vim.fn.systemlist("git -C " .. vim.fn.escape(current_dir, " ") .. " rev-parse --show-toplevel")[1]
if vim.v.shell_error ~= 0 then
- print("Not a git repository")
- return nil
+ print("Not a git repository. Searching on current working directory")
+ return cwd
end
return git_root
end
From f23484cf88197ac38574f4fd4965cc2c17263f20 Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Tue, 7 Nov 2023 11:18:15 +0100
Subject: [PATCH 12/40] init.lua: move diagnostic keymaps together with other
keymaps
---
init.lua | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/init.lua b/init.lua
index 0976a461..225ad21a 100644
--- a/init.lua
+++ b/init.lua
@@ -281,6 +281,12 @@ vim.keymap.set({ 'n', 'v' }, '<Space>', '<Nop>', { silent = true })
vim.keymap.set('n', 'k', "v:count == 0 ? 'gk' : 'k'", { expr = true, silent = true })
vim.keymap.set('n', 'j', "v:count == 0 ? 'gj' : 'j'", { expr = true, silent = true })
+-- Diagnostic keymaps
+vim.keymap.set('n', '[d', vim.diagnostic.goto_prev, { desc = 'Go to previous diagnostic message' })
+vim.keymap.set('n', ']d', vim.diagnostic.goto_next, { desc = 'Go to next diagnostic message' })
+vim.keymap.set('n', '<leader>e', vim.diagnostic.open_float, { desc = 'Open floating diagnostic message' })
+vim.keymap.set('n', '<leader>q', vim.diagnostic.setloclist, { desc = 'Open diagnostics list' })
+
-- [[ Highlight on yank ]]
-- See `:help vim.highlight.on_yank()`
local highlight_group = vim.api.nvim_create_augroup('YankHighlight', { clear = true })
@@ -433,12 +439,6 @@ vim.defer_fn(function()
}
end, 0)
--- Diagnostic keymaps
-vim.keymap.set('n', '[d', vim.diagnostic.goto_prev, { desc = 'Go to previous diagnostic message' })
-vim.keymap.set('n', ']d', vim.diagnostic.goto_next, { desc = 'Go to next diagnostic message' })
-vim.keymap.set('n', '<leader>e', vim.diagnostic.open_float, { desc = 'Open floating diagnostic message' })
-vim.keymap.set('n', '<leader>q', vim.diagnostic.setloclist, { desc = 'Open diagnostics list' })
-
-- [[ Configure LSP ]]
-- This function gets run when an LSP connects to a particular buffer.
local on_attach = function(_, bufnr)
From c8dd8e7e0cd5d3d1d3760eac908513de1be0b37c Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Tue, 7 Nov 2023 11:27:14 +0100
Subject: [PATCH 13/40] init.lua: minor edits of section comments for
consistency
---
init.lua | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index 225ad21a..748e7f81 100644
--- a/init.lua
+++ b/init.lua
@@ -37,13 +37,14 @@ I hope you enjoy your Neovim journey,
P.S. You can delete this when you're done too. It's your config now :)
--]]
+
-- Set <space> as the leader key
-- See `:help mapleader`
-- NOTE: Must happen before plugins are required (otherwise wrong leader will be used)
vim.g.mapleader = ' '
vim.g.maplocalleader = ' '
--- Install package manager
+-- [[ Install `lazy.nvim` plugin manager ]]
-- https://github.com/folke/lazy.nvim
-- `:help lazy.nvim.txt` for more info
local lazypath = vim.fn.stdpath 'data' .. '/lazy/lazy.nvim'
@@ -59,6 +60,7 @@ if not vim.loop.fs_stat(lazypath) then
end
vim.opt.rtp:prepend(lazypath)
+-- [[ Configure plugins ]]
-- NOTE: Here is where you install your plugins.
-- You can configure plugins using the `config` key.
--
From af4f51b2cd6cfb2511d34adc99900110f4d3916b Mon Sep 17 00:00:00 2001
From: Shashwat Agrawal <shashwatagrawal473@gmail.com>
Date: Sat, 11 Nov 2023 20:31:05 +0530
Subject: [PATCH 14/40] fix(auto-completion): ensure first menu item is
selected by default
---
init.lua | 3 +++
1 file changed, 3 insertions(+)
diff --git a/init.lua b/init.lua
index 748e7f81..385b19a0 100644
--- a/init.lua
+++ b/init.lua
@@ -564,6 +564,9 @@ cmp.setup {
luasnip.lsp_expand(args.body)
end,
},
+ completion = {
+ completeopt = 'menu,menuone,noinsert'
+ },
mapping = cmp.mapping.preset.insert {
['<C-n>'] = cmp.mapping.select_next_item(),
['<C-p>'] = cmp.mapping.select_prev_item(),
From 711e5976dd83f0bdb904e3d884375b79c89f0e2a Mon Sep 17 00:00:00 2001
From: j-hui <j-hui@cs.columbia.edu>
Date: Mon, 13 Nov 2023 15:46:34 -0500
Subject: [PATCH 15/40] init.lua: remove 'legacy' tag from fidget.nvim
---
init.lua | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index 385b19a0..3a98da03 100644
--- a/init.lua
+++ b/init.lua
@@ -88,7 +88,7 @@ require('lazy').setup({
-- Useful status updates for LSP
-- NOTE: `opts = {}` is the same as calling `require('fidget').setup({})`
- { 'j-hui/fidget.nvim', tag = 'legacy', opts = {} },
+ { 'j-hui/fidget.nvim', opts = {} },
-- Additional lua configuration, makes nvim stuff amazing!
'folke/neodev.nvim',
From ee9790b381416781063d0de6653b303f10ed89b0 Mon Sep 17 00:00:00 2001
From: Tommy Williams <wommy@users.noreply.github.com>
Date: Fri, 24 Nov 2023 09:55:19 -0700
Subject: [PATCH 16/40] option to reduce noisy Lua_LS's missing-fields warnings
(#511)
---
init.lua | 2 ++
1 file changed, 2 insertions(+)
diff --git a/init.lua b/init.lua
index 3a98da03..e7f1eec4 100644
--- a/init.lua
+++ b/init.lua
@@ -522,6 +522,8 @@ local servers = {
Lua = {
workspace = { checkThirdParty = false },
telemetry = { enable = false },
+ -- NOTE: toggle below to ignore Lua_LS's noisy `missing-fields` warnings
+ -- diagnostics = { disable = { 'missing-fields' } },
},
},
}
From 14cf319dbd63ef4bedf9cf219c3732c568718996 Mon Sep 17 00:00:00 2001
From: matt <55467261+mattwyd@users.noreply.github.com>
Date: Wed, 29 Nov 2023 19:34:43 -0500
Subject: [PATCH 17/40] Update README.md (#520)
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 7f54ce88..1979e9ec 100644
--- a/README.md
+++ b/README.md
@@ -39,19 +39,19 @@ Neovim's configurations are located under the following paths, depending on your
Clone kickstart.nvim:
-```sh
# on Linux and Mac
+```sh
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
-```
# on Windows (cmd)
+```
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
```
-```
# on Windows (powershell)
+```
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
```
From afafc9ab194be254467b4cc8be049fc33fe27b14 Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Thu, 30 Nov 2023 10:04:27 +0100
Subject: [PATCH 18/40] README.md: update install section formatting (#523)
---
README.md | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 1979e9ec..36c13861 100644
--- a/README.md
+++ b/README.md
@@ -39,18 +39,17 @@ Neovim's configurations are located under the following paths, depending on your
Clone kickstart.nvim:
-# on Linux and Mac
+- on Linux and Mac
```sh
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
-
-# on Windows (cmd)
+- on Windows (cmd)
```
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
```
-# on Windows (powershell)
+- on Windows (powershell)
```
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
```
From 39ae0829acea66175721fcf48695c7df6db040b9 Mon Sep 17 00:00:00 2001
From: Sudo <788991+wadkar@users.noreply.github.com>
Date: Fri, 1 Dec 2023 07:30:55 +0900
Subject: [PATCH 19/40] Use alias instead of a wrapper script (#524)
It is much easier to stick an alias statement in `~/.{z,ba}shrc` than create a script, invoke another instance of interpreter and then run neovim
---
README.md | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 36c13861..78ac6df0 100644
--- a/README.md
+++ b/README.md
@@ -156,12 +156,11 @@ Each PR, especially those which increase the line count, should have a descripti
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
* You may also want to look at the [migration guide for lazy.nvim](https://github.com/folke/lazy.nvim#-migration-guide)
* Can I keep my existing configuration in parallel to kickstart?
- * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example you can install the kickstart configuration in `~/.config/nvim-kickstart` and create a script `~/bin/nvim-kickstart`:
+ * Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias:
```
- #!/bin/sh
- exec env NVIM_APPNAME=nvim-kickstart nvim "$@"
+ alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
```
- When you run Neovim with `nvim-kickstart` it will use the alternative config directory and the matching local directory: `~/.local/share/nvim-kickstart`. You can apply this approach to any Neovim distribution that you would like to try out.
+ When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.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://github.com/folke/lazy.nvim#-uninstalling) information
* Are there any cool videos about this plugin?
From 3ca08acf0e9023b3f8b602a5db2dd00cebdcbfbc Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Sat, 2 Dec 2023 22:27:13 +0100
Subject: [PATCH 20/40] Add a github action on pull request to check lua
formatting (#526)
GitHub Action used:
https://github.com/marketplace/actions/stylua
This runs `stylua --check` on a PR and it will show
success or failure. The suggested stylua changes can
be inspected when clicking on the details.
The PR can still be merged even if the check fails.
---
.github/workflows/stylua.yml | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
create mode 100644 .github/workflows/stylua.yml
diff --git a/.github/workflows/stylua.yml b/.github/workflows/stylua.yml
new file mode 100644
index 00000000..e189fe01
--- /dev/null
+++ b/.github/workflows/stylua.yml
@@ -0,0 +1,18 @@
+# Check Lua Formatting
+name: Check Lua Formatting
+on: pull_request
+
+jobs:
+ stylua-check:
+ name: Stylua Check
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout Code
+ uses: actions/checkout@v2
+ - name: Stylua Check
+ uses: JohnnyMorganz/stylua-action@v3
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ version: latest
+ args: --check .
+
From 12bd68e8b9bc98242084bce55236d2bf9fe299b1 Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Sun, 3 Dec 2023 20:23:39 +0100
Subject: [PATCH 21/40] Run stylua (#525)
---
init.lua | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/init.lua b/init.lua
index e7f1eec4..94f7cf4e 100644
--- a/init.lua
+++ b/init.lua
@@ -324,17 +324,17 @@ local function find_git_root()
local current_dir
local cwd = vim.fn.getcwd()
-- If the buffer is not associated with a file, return nil
- if current_file == "" then
+ if current_file == '' then
current_dir = cwd
else
-- Extract the directory from the current file's path
- current_dir = vim.fn.fnamemodify(current_file, ":h")
+ current_dir = vim.fn.fnamemodify(current_file, ':h')
end
-- Find the Git root directory from the current file's path
- local git_root = vim.fn.systemlist("git -C " .. vim.fn.escape(current_dir, " ") .. " rev-parse --show-toplevel")[1]
+ local git_root = vim.fn.systemlist('git -C ' .. vim.fn.escape(current_dir, ' ') .. ' rev-parse --show-toplevel')[1]
if vim.v.shell_error ~= 0 then
- print("Not a git repository. Searching on current working directory")
+ print 'Not a git repository. Searching on current working directory'
return cwd
end
return git_root
@@ -344,9 +344,9 @@ end
local function live_grep_git_root()
local git_root = find_git_root()
if git_root then
- require('telescope.builtin').live_grep({
- search_dirs = {git_root},
- })
+ require('telescope.builtin').live_grep {
+ search_dirs = { git_root },
+ }
end
end
@@ -567,7 +567,7 @@ cmp.setup {
end,
},
completion = {
- completeopt = 'menu,menuone,noinsert'
+ completeopt = 'menu,menuone,noinsert',
},
mapping = cmp.mapping.preset.insert {
['<C-n>'] = cmp.mapping.select_next_item(),
From f8c8b08bc15b2bac590b3c397db3b466f7fb1d0b Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Mon, 4 Dec 2023 16:35:54 +0100
Subject: [PATCH 22/40] Add gitsigns recommended keymaps (#531)
* Import gitsigns README.md recommended keymaps (and apply stylua)
the previously added visual mode for ]c [c is kept.
* Add gitsigns keymap descriptions
---
init.lua | 59 ++++++++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 51 insertions(+), 8 deletions(-)
diff --git a/init.lua b/init.lua
index 94f7cf4e..76ddd45a 100644
--- a/init.lua
+++ b/init.lua
@@ -126,11 +126,16 @@ require('lazy').setup({
changedelete = { text = '~' },
},
on_attach = function(bufnr)
- vim.keymap.set('n', '<leader>hp', require('gitsigns').preview_hunk, { buffer = bufnr, desc = 'Preview git hunk' })
-
- -- don't override the built-in and fugitive keymaps
local gs = package.loaded.gitsigns
- vim.keymap.set({ 'n', 'v' }, ']c', function()
+
+ local function map(mode, l, r, opts)
+ opts = opts or {}
+ opts.buffer = bufnr
+ vim.keymap.set(mode, l, r, opts)
+ end
+
+ -- Navigation
+ map({ 'n', 'v' }, ']c', function()
if vim.wo.diff then
return ']c'
end
@@ -138,8 +143,9 @@ require('lazy').setup({
gs.next_hunk()
end)
return '<Ignore>'
- end, { expr = true, buffer = bufnr, desc = 'Jump to next hunk' })
- vim.keymap.set({ 'n', 'v' }, '[c', function()
+ end, { expr = true, desc = 'Jump to next hunk' })
+
+ map({ 'n', 'v' }, '[c', function()
if vim.wo.diff then
return '[c'
end
@@ -147,7 +153,37 @@ require('lazy').setup({
gs.prev_hunk()
end)
return '<Ignore>'
- end, { expr = true, buffer = bufnr, desc = 'Jump to previous hunk' })
+ end, { expr = true, desc = 'Jump to previous hunk' })
+
+ -- Actions
+ -- visual mode
+ map('v', '<leader>hs', function()
+ gs.stage_hunk { vim.fn.line '.', vim.fn.line 'v' }
+ end, { desc = 'stage git hunk' })
+ map('v', '<leader>hr', function()
+ gs.reset_hunk { vim.fn.line '.', vim.fn.line 'v' }
+ end, { desc = 'reset git hunk' })
+ -- normal mode
+ map('n', '<leader>hs', gs.stage_hunk, { desc = 'git stage hunk' })
+ map('n', '<leader>hr', gs.reset_hunk, { desc = 'git reset hunk' })
+ map('n', '<leader>hS', gs.stage_buffer, { desc = 'git Stage buffer' })
+ map('n', '<leader>hu', gs.undo_stage_hunk, { desc = 'undo stage hunk' })
+ map('n', '<leader>hR', gs.reset_buffer, { desc = 'git Reset buffer' })
+ map('n', '<leader>hp', gs.preview_hunk, { desc = 'preview git hunk' })
+ map('n', '<leader>hb', function()
+ gs.blame_line { full = false }
+ end, { desc = 'git blame line' })
+ map('n', '<leader>hd', gs.diffthis, { desc = 'git diff against index' })
+ map('n', '<leader>hD', function()
+ gs.diffthis '~'
+ end, { desc = 'git diff against last commit' })
+
+ -- Toggles
+ map('n', '<leader>tb', gs.toggle_current_line_blame, { desc = 'toggle git blame line' })
+ map('n', '<leader>td', gs.toggle_deleted, { desc = 'toggle git show deleted' })
+
+ -- Text object
+ map({ 'o', 'x' }, 'ih', ':<C-U>Gitsigns select_hunk<CR>', { desc = 'select git hunk' })
end,
},
},
@@ -491,11 +527,18 @@ require('which-key').register {
['<leader>c'] = { name = '[C]ode', _ = 'which_key_ignore' },
['<leader>d'] = { name = '[D]ocument', _ = 'which_key_ignore' },
['<leader>g'] = { name = '[G]it', _ = 'which_key_ignore' },
- ['<leader>h'] = { name = 'More git', _ = 'which_key_ignore' },
+ ['<leader>h'] = { name = 'Git [H]unk', _ = 'which_key_ignore' },
['<leader>r'] = { name = '[R]ename', _ = 'which_key_ignore' },
['<leader>s'] = { name = '[S]earch', _ = 'which_key_ignore' },
+ ['<leader>t'] = { name = '[T]oggle', _ = 'which_key_ignore' },
['<leader>w'] = { name = '[W]orkspace', _ = 'which_key_ignore' },
}
+-- register which-key VISUAL mode
+-- required for visual <leader>hs (hunk stage) to work
+require('which-key').register({
+ ['<leader>'] = { name = 'VISUAL <leader>' },
+ ['<leader>h'] = { 'Git [H]unk' },
+}, { mode = 'v' })
-- mason-lspconfig requires that these setup functions are called in this order
-- before setting up the servers.
From 3824342d107850dfe5b179d0a39e0d8fcd54411d Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Mon, 4 Dec 2023 16:45:01 +0100
Subject: [PATCH 23/40] Adds two essential telescope keymaps (#528)
* Added keymap for select Telescope picker
* Added keymap for search in all open files
---
init.lua | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/init.lua b/init.lua
index 76ddd45a..36cc9a52 100644
--- a/init.lua
+++ b/init.lua
@@ -399,6 +399,14 @@ vim.keymap.set('n', '<leader>/', function()
})
end, { desc = '[/] Fuzzily search in current buffer' })
+local function telescope_live_grep_open_files()
+ require('telescope.builtin').live_grep {
+ grep_open_files = true,
+ prompt_title = 'Live Grep in Open Files',
+ }
+end
+vim.keymap.set('n', '<leader>s/', telescope_live_grep_open_files, { desc = '[S]earch [/] in Open Files' })
+vim.keymap.set('n', '<leader>ss', require('telescope.builtin').builtin, { desc = '[S]earch [S]elect Telescope' })
vim.keymap.set('n', '<leader>gf', require('telescope.builtin').git_files, { desc = 'Search [G]it [F]iles' })
vim.keymap.set('n', '<leader>sf', require('telescope.builtin').find_files, { desc = '[S]earch [F]iles' })
vim.keymap.set('n', '<leader>sh', require('telescope.builtin').help_tags, { desc = '[S]earch [H]elp' })
From 76c5b1ec57f40d17ac787feb018817a802e24bb6 Mon Sep 17 00:00:00 2001
From: Shashwat Agrawal <72117025+ShashwatAgrawal20@users.noreply.github.com>
Date: Fri, 8 Dec 2023 18:44:06 +0530
Subject: [PATCH 24/40] feat(cmp): path completion feature (#536)
---
init.lua | 2 ++
1 file changed, 2 insertions(+)
diff --git a/init.lua b/init.lua
index 36cc9a52..cf4a3790 100644
--- a/init.lua
+++ b/init.lua
@@ -105,6 +105,7 @@ require('lazy').setup({
-- Adds LSP completion capabilities
'hrsh7th/cmp-nvim-lsp',
+ 'hrsh7th/cmp-path',
-- Adds a number of user-friendly snippets
'rafamadriz/friendly-snippets',
@@ -652,6 +653,7 @@ cmp.setup {
sources = {
{ name = 'nvim_lsp' },
{ name = 'luasnip' },
+ { name = 'path' },
},
}
From e39a8bce9d25b3bd8d50098fadf13575a4a71b4b Mon Sep 17 00:00:00 2001
From: Ari Pollak <aripollak@users.noreply.github.com>
Date: Thu, 21 Dec 2023 15:35:28 -0500
Subject: [PATCH 25/40] Switch cmp up mapping from C-d to C-b to match regular
vim up key (#549)
---
init.lua | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index cf4a3790..48cf771b 100644
--- a/init.lua
+++ b/init.lua
@@ -624,7 +624,7 @@ cmp.setup {
mapping = cmp.mapping.preset.insert {
['<C-n>'] = cmp.mapping.select_next_item(),
['<C-p>'] = cmp.mapping.select_prev_item(),
- ['<C-d>'] = cmp.mapping.scroll_docs(-4),
+ ['<C-b>'] = cmp.mapping.scroll_docs(-4),
['<C-f>'] = cmp.mapping.scroll_docs(4),
['<C-Space>'] = cmp.mapping.complete {},
['<CR>'] = cmp.mapping.confirm {
From 4d0dc8d4b1bd6b94e59f7773158149bb1b0ee5be Mon Sep 17 00:00:00 2001
From: John Pekcan <johnpekcan@gmail.com>
Date: Sat, 23 Dec 2023 20:59:59 -0800
Subject: [PATCH 26/40] fix: restore mason config timing for dap startup (#555)
Co-authored-by: John Pekcan <john.pekcan@epicgames.com>
---
init.lua | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index 48cf771b..7e68de67 100644
--- a/init.lua
+++ b/init.lua
@@ -83,7 +83,7 @@ require('lazy').setup({
'neovim/nvim-lspconfig',
dependencies = {
-- Automatically install LSPs to stdpath for neovim
- 'williamboman/mason.nvim',
+ { 'williamboman/mason.nvim', config = true },
'williamboman/mason-lspconfig.nvim',
-- Useful status updates for LSP
From d45e5fe85582332ee7bd0e12f1062a40f8b9fa1f Mon Sep 17 00:00:00 2001
From: gitressa <3491208+gitressa@users.noreply.github.com>
Date: Wed, 3 Jan 2024 16:03:23 +0100
Subject: [PATCH 27/40] Move video up on the README.md page (#563)
To help new users get started, how about moving the video link ("Effective Neovim: Instant IDE ") right after "Post Installation"?
This way new users, can install it, and right away proceed to learn how to use it.
---
README.md | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 78ac6df0..e1a4ee19 100644
--- a/README.md
+++ b/README.md
@@ -71,6 +71,10 @@ If you would prefer to hide this step and run the plugin sync from the command l
nvim --headless "+Lazy! sync" +qa
```
+### Introduction
+
+To get started, see [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the previous version. Note: The install via init.lua is outdated, please follow the install instructions in this file instead. An updated video is coming soon.
+
### Recommended Steps
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo (so that you have your own copy that you can modify) and then installing you can install to your machine using the methods above.
@@ -163,9 +167,6 @@ Each PR, especially those which increase the line count, should have a descripti
When you run Neovim using `nvim-kickstart` alias it will use the alternative config directory and the matching local directory `~/.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://github.com/folke/lazy.nvim#-uninstalling) information
-* Are there any cool videos about this plugin?
- * Current iteration of kickstart (coming soon)
- * Here is one about the previous iteration of kickstart: [video introduction to Kickstart.nvim](https://youtu.be/stqUbv-5u2s). Note the install via init.lua no longer works as specified. Please follow the install instructions in this file instead as they're up to date.
* 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 `git clone` as a basis for their own.
From c4055a2212c6a1515d07edae5a9de435543102d2 Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Wed, 3 Jan 2024 18:30:37 +0100
Subject: [PATCH 28/40] Improve stylua github workflow (#571)
Addressing issue nvim-lua/kickstart.nvim#570
This improves the github workflow to no longer require manual
approval for PRs from first time contributors.
Changes the github event from pull_request to pull_request_target
and adds an explicit PR head checkout
---
.github/workflows/stylua.yml | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/stylua.yml b/.github/workflows/stylua.yml
index e189fe01..5ec9daba 100644
--- a/.github/workflows/stylua.yml
+++ b/.github/workflows/stylua.yml
@@ -1,6 +1,6 @@
# Check Lua Formatting
name: Check Lua Formatting
-on: pull_request
+on: pull_request_target
jobs:
stylua-check:
@@ -9,6 +9,8 @@ jobs:
steps:
- name: Checkout Code
uses: actions/checkout@v2
+ with:
+ ref: ${{ github.event.pull_request.head.sha }}
- name: Stylua Check
uses: JohnnyMorganz/stylua-action@v3
with:
From c11afa2f90a9e5b995ef51c8f4b37dfcdc1a7390 Mon Sep 17 00:00:00 2001
From: Mohamad Alamin Yassin <ameen.yaseen.98@gmail.com>
Date: Mon, 8 Jan 2024 20:17:01 +0300
Subject: [PATCH 29/40] Add Missing Fields to Treesitter Config to Resolve
Warnings (#582)
This commit introduces three additional fields - `sync_install`, `ignore_install`, and `modules` - to the Treesitter configuration. This update is aimed at resolving warnings that were previously displayed, potentially causing confusion or frustration for new users of Neovim. By explicitly defining these fields, the configuration aligns better with the latest `nvim-treesitter` requirements.
---
init.lua | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index 7e68de67..dd9ef7b9 100644
--- a/init.lua
+++ b/init.lua
@@ -427,7 +427,14 @@ vim.defer_fn(function()
-- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
auto_install = false,
-
+ -- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
+ auto_install = false,
+ -- Install languages synchronously (only applied to `ensure_installed`)
+ sync_install = false,
+ -- List of parsers to ignore installing
+ ignore_install = {},
+ -- You can specify additional Treesitter modules here: -- For example: -- playground = {--enable = true,-- },
+ modules = {},
highlight = { enable = true },
indent = { enable = true },
incremental_selection = {
From 60b93c95d31d1b6723ba1c85db42352b343ebe10 Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Mon, 8 Jan 2024 20:44:00 +0100
Subject: [PATCH 30/40] README.md: rename the duplicate "Introduction" to
"Getting Started" (#572)
Changing this second "Introduction" heading to "Getting Started"
The recent change in README which moved the youtube link from FAQ
to it's own section used the heading "Introduction" which is already
the first heading in the file.
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index e1a4ee19..a4c6bd78 100644
--- a/README.md
+++ b/README.md
@@ -71,9 +71,9 @@ If you would prefer to hide this step and run the plugin sync from the command l
nvim --headless "+Lazy! sync" +qa
```
-### Introduction
+### Getting Started
-To get started, see [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the previous version. Note: The install via init.lua is outdated, please follow the install instructions in this file instead. An updated video is coming soon.
+See [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the previous version. Note: The install via init.lua is outdated, please follow the install instructions in this file instead. An updated video is coming soon.
### Recommended Steps
From 2510c29d62d39d63bb75f1a613d2ae628a2af4ee Mon Sep 17 00:00:00 2001
From: Sreejith I V <46400271+pzerone@users.noreply.github.com>
Date: Wed, 10 Jan 2024 20:06:33 +0530
Subject: [PATCH 31/40] Removed duplicate line (#583)
---
init.lua | 2 --
1 file changed, 2 deletions(-)
diff --git a/init.lua b/init.lua
index dd9ef7b9..1ff16af5 100644
--- a/init.lua
+++ b/init.lua
@@ -425,8 +425,6 @@ vim.defer_fn(function()
-- Add languages to be installed here that you want installed for treesitter
ensure_installed = { 'c', 'cpp', 'go', 'lua', 'python', 'rust', 'tsx', 'javascript', 'typescript', 'vimdoc', 'vim', 'bash' },
- -- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
- auto_install = false,
-- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
auto_install = false,
-- Install languages synchronously (only applied to `ensure_installed`)
From deaafcf5491a76f71d3bc70c9d75b3320fe83e83 Mon Sep 17 00:00:00 2001
From: Victor Bertin <83238030+v-bertin@users.noreply.github.com>
Date: Mon, 29 Jan 2024 13:48:14 +0100
Subject: [PATCH 32/40] Set status line theme to the global colorscheme (#600)
---
init.lua | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index 1ff16af5..3694bc03 100644
--- a/init.lua
+++ b/init.lua
@@ -205,7 +205,7 @@ require('lazy').setup({
opts = {
options = {
icons_enabled = false,
- theme = 'onedark',
+ theme = 'auto',
component_separators = '|',
section_separators = '',
},
From b11581491671ed49b1dfdb1ea777932ade7ff2e5 Mon Sep 17 00:00:00 2001
From: Nazar <63452145+Tokarak@users.noreply.github.com>
Date: Mon, 29 Jan 2024 18:52:50 +0000
Subject: [PATCH 33/40] Add Onedark Style (#590)
* Add style options to Onedark setup (init.lua)
* stylua init.lua
* Load onedark through `require`
* Improve commenting
---
init.lua | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index 3694bc03..6c6ae020 100644
--- a/init.lua
+++ b/init.lua
@@ -193,8 +193,13 @@ require('lazy').setup({
-- Theme inspired by Atom
'navarasu/onedark.nvim',
priority = 1000,
+ lazy = false,
config = function()
- vim.cmd.colorscheme 'onedark'
+ require('onedark').setup {
+ -- Set a style preset. 'dark' is default.
+ style = 'dark', -- dark, darker, cool, deep, warm, warmer, light
+ }
+ require('onedark').load()
end,
},
From c3ae716fb394344e168ca7ed856e13fb8b6c96bd Mon Sep 17 00:00:00 2001
From: Damjan 9000 <damjan.9000@gmail.com>
Date: Thu, 1 Feb 2024 17:01:46 +0100
Subject: [PATCH 34/40] issue: #594 stylua workflow only on official kickstart
repo (#609)
Only run the github stylua workflow check on the official
kickstart repo (nvim-lua/kickstart.nvim) so that it's not
enforced on any other forks.
As suggested by: @zwergius
---
.github/workflows/stylua.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/.github/workflows/stylua.yml b/.github/workflows/stylua.yml
index 5ec9daba..75db6c33 100644
--- a/.github/workflows/stylua.yml
+++ b/.github/workflows/stylua.yml
@@ -4,6 +4,7 @@ on: pull_request_target
jobs:
stylua-check:
+ if: github.repository == 'nvim-lua/kickstart.nvim'
name: Stylua Check
runs-on: ubuntu-latest
steps:
From bc4ad1218b908ec4efc3b0f6ea6e3cb4940b0084 Mon Sep 17 00:00:00 2001
From: Micah Effiong <52747707+micaiah-effiong@users.noreply.github.com>
Date: Fri, 2 Feb 2024 21:24:46 +0100
Subject: [PATCH 35/40] feat: added contexts for code action - source fix-all
errors (#599)
* feat: added contexts for code action - source fix-all errors
* fix: resolve stylua checks
* fix: resolve stylua checks
---
init.lua | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index 6c6ae020..c7e64006 100644
--- a/init.lua
+++ b/init.lua
@@ -514,7 +514,9 @@ local on_attach = function(_, bufnr)
end
nmap('<leader>rn', vim.lsp.buf.rename, '[R]e[n]ame')
- nmap('<leader>ca', vim.lsp.buf.code_action, '[C]ode [A]ction')
+ nmap('<leader>ca', function()
+ vim.lsp.buf.code_action { context = { only = { 'quickfix', 'refactor', 'source' } } }
+ end, '[C]ode [A]ction')
nmap('gd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')
nmap('gr', require('telescope.builtin').lsp_references, '[G]oto [R]eferences')
From 5d2d81b1ea7373a585fcf02e23296fe1f8bc58e7 Mon Sep 17 00:00:00 2001
From: Chris Patti <feoh@feoh.org>
Date: Sat, 3 Feb 2024 19:15:25 -0500
Subject: [PATCH 36/40] Fixes #607. Add hints for new neovim users to learn how
to learn. (#615)
---
README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 52 insertions(+)
diff --git a/README.md b/README.md
index a4c6bd78..b7fe337a 100644
--- a/README.md
+++ b/README.md
@@ -192,3 +192,55 @@ This requires:
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
```
+### Hints And Tips For New Neovimmers
+
+Neovim is a very rich and powerful environment, but it can also feel a bit
+intimidating for new users trying to find their way around, especially if
+they're coming from other environments like Visual Studio Code or a traditional
+IDE.
+
+There's no way this README can provide you with everything you need to know, but
+here are a few tips so you can learn how to learn.
+
+### Use The Help, Luke!
+
+Neovim's help system is incredibly thorough and extensive. You should really
+take a moment to get comfortable navigating through help topics, going back and
+forth, navigating the menus, etc. This won't just help you read the help, it
+will empower you in the rest of your Neovim journey.
+
+You can double click on a topic to drill down, and hit Ctrl-o (Hold down the
+Control key and the 'o' key) to go back.
+
+Read the first page you get when you run :help carefully. it will serve you
+well.
+
+You can also get help on a particular thing by typing ":help <topic>".
+
+Like, let's say we want to learn more about folding, just type ":help folding".
+
+### To The Telescope!
+
+One of the more powerful features you get by installing this project is the
+brilliant Telescope plugin co-written by @tjdevries.
+
+Take a minute to browse through ":help telescope" and get a sense for all the
+amazing superpowers you've gained.
+
+In particular, there are two Telescope features that are incredible for helping
+you understand how to do a particular thing or how to configure a particular
+feature.
+
+If you're not sure what to look for, try ":Telescope help_tags". Let's say we
+want to configure Neovim to automatically word wrap. We might type ":Telescope
+help_tags" and then type w, r, a, p. Notice how the list of results changes with
+each new letter you type? When you're done you've got a screen full of topics
+involving word wrap.
+
+Another common question is "What keys do I hit to make a thing happen?". To get
+an answer, one way is to use ":Telescope keymaps". You'll get the same list of
+results that changes to adapt with each new key you press.
+
+With these hints in mind you should be in good shape to get learning. Remember,
+you are on a journey of discovery here, adapting your programming environment to
+your needs. It will take effort, but the rewards are worth it! :)
From 7af594fd319fbae6b2aaa06337f3df8acbbb7f18 Mon Sep 17 00:00:00 2001
From: rgarber11 <rg.1029384756@gmail.com>
Date: Mon, 5 Feb 2024 13:49:19 -0500
Subject: [PATCH 37/40] Add Build Step to LuaSnip (#611)
---
init.lua | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index c7e64006..fd4567d9 100644
--- a/init.lua
+++ b/init.lua
@@ -100,7 +100,18 @@ require('lazy').setup({
'hrsh7th/nvim-cmp',
dependencies = {
-- Snippet Engine & its associated nvim-cmp source
- 'L3MON4D3/LuaSnip',
+ {
+ 'L3MON4D3/LuaSnip',
+ 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 then
+ return
+ end
+ return 'make install_jsregexp'
+ end)(),
+ },
'saadparwaiz1/cmp_luasnip',
-- Adds LSP completion capabilities
From 8b5d48a199c02658e399f5b43ff8d06df1ede7fb Mon Sep 17 00:00:00 2001
From: TJ DeVries <devries.timothyj@gmail.com>
Date: Mon, 26 Feb 2024 10:03:53 -0500
Subject: [PATCH 38/40] rewrite: slimmer, trimmer and more lazy kickstart.nvim
(#635)
We've removed over 1/3 of the code that was in kickstart previously,
and more than doubled the amount of comments explaining every line
of code (to the best of my ability).
kickstart now properly uses many of the lazy.nvim config and loading
idioms, which should be really helpful for people moving both to
modular configs, as well as extending the kickstart config in one file.
Additional features:
- Beautiful ascii art
- Added some documentation that explains what is an LSP, what is telescope, etc
- There is now a `:checkhealth` for kickstart, which checks some basic information
and adds useful information for maintainers (for people cloning the repo).
- Improved LSP configuration and tool installation, for easier first time startup
- Changed init.lua ordering, so that it moves from simple options to complicated config
```
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
Lua 1 108 404 298
-------------------------------------------------------------------------------
```
---
.gitignore | 3 +
README.md | 158 +--
init.lua | 1314 ++++++++++++++-----------
lua/kickstart/health.lua | 51 +
lua/kickstart/plugins/autoformat.lua | 74 --
lua/kickstart/plugins/indent_line.lua | 9 +
6 files changed, 836 insertions(+), 773 deletions(-)
create mode 100644 lua/kickstart/health.lua
delete mode 100644 lua/kickstart/plugins/autoformat.lua
create mode 100644 lua/kickstart/plugins/indent_line.lua
diff --git a/.gitignore b/.gitignore
index d699e1d6..005b535b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,6 @@ tags
test.sh
.luarc.json
nvim
+
+spell/
+lazy-lock.json
diff --git a/README.md b/README.md
index b7fe337a..c9b9d84e 100644
--- a/README.md
+++ b/README.md
@@ -1,59 +1,73 @@
# kickstart.nvim
-https://github.com/kdheepak/kickstart.nvim/assets/1813121/f3ff9a2b-c31f-44df-a4fa-8a0d7b17cf7b
-
-### Introduction
+## Introduction
A starting point for Neovim that is:
* Small
-* Single-file (with examples of moving to multi-file)
-* Documented
-* Modular
+* Single-file
+* Completely Documented
+
+**NOT** a Neovim distribution, but instead a starting point for your configuration.
-This repo is meant to be used by **YOU** to begin your Neovim journey; remove the things you don't use and add what you miss.
+## Installation
-Kickstart.nvim targets *only* the latest ['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest ['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim. If you are experiencing issues, please make sure you have the latest versions.
+### Install Neovim
-Distribution Alternatives:
-- [LazyVim](https://www.lazyvim.org/): A delightful distribution maintained by @folke (the author of lazy.nvim, the package manager used here)
+Kickstart.nvim targets *only* the latest
+['stable'](https://github.com/neovim/neovim/releases/tag/stable) and latest
+['nightly'](https://github.com/neovim/neovim/releases/tag/nightly) of Neovim.
+If you are experiencing issues, please make sure you have the latest versions.
-### Installation
+### Install External Dependencies
> **NOTE**
> [Backup](#FAQ) your previous configuration (if any exists)
-Requirements:
-* Make sure to review the readmes of the plugins if you are experiencing errors. In particular:
- * [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers.
-* See [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native`
+External Requirements:
+- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
+- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
+- Language Setup:
+ - If want to write Typescript, you need `npm`
+ - If want to write Golang, you will need `go`
+ - etc.
+
+> **NOTE**
+> See [Windows Installation](#Windows-Installation) to double check any additional Windows notes
Neovim's configurations are located under the following paths, depending on your OS:
| OS | PATH |
| :- | :--- |
-| Linux | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
-| MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
+| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
Clone kickstart.nvim:
-- on Linux and Mac
+<details><summary> Linux and Mac </summary>
+
```sh
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
-- on Windows (cmd)
+</details>
+
+<details><summary> Windows </summary>
+
+If you're using `cmd.exe`:
+
```
git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
```
-- on Windows (powershell)
+If you're using `powershell.exe`
+
```
git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
```
+</details>
### Post Installation
@@ -63,37 +77,33 @@ Start Neovim
nvim
```
-The `Lazy` plugin manager will start automatically on the first run and install the configured plugins - as can be seen in the introduction video. After the installation is complete you can press `q` to close the `Lazy` UI and **you are ready to go**! Next time you run nvim `Lazy` will no longer show up.
+That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
+current plugin status.
-If you would prefer to hide this step and run the plugin sync from the command line, you can use:
-
-```sh
-nvim --headless "+Lazy! sync" +qa
-```
+Read through the `init.lua` file in your configuration folder for more
+information about extending and exploring Neovim.
### Getting Started
-See [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the previous version. Note: The install via init.lua is outdated, please follow the install instructions in this file instead. An updated video is coming soon.
+See [Effective Neovim: Instant IDE](https://youtu.be/stqUbv-5u2s), covering the
+previous version. Note: The install via init.lua is outdated, please follow the
+install instructions in this file instead. An updated video is coming soon.
### Recommended Steps
-[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo (so that you have your own copy that you can modify) and then installing you can install to your machine using the methods above.
+[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
+(so that you have your own copy that you can modify) and then installing you
+can install to your machine using the methods above.
> **NOTE**
> Your fork's url will be something like this: `https://github.com/<your_github_username>/kickstart.nvim.git`
-### Configuration And Extension
-
-* Inside of your copy, feel free to modify any file you like! It's your copy!
-* Feel free to change any of the default options in `init.lua` to better suit your needs.
-* For adding plugins, there are 3 primary options:
- * Add new configuration in `lua/custom/plugins/*` files, which will be auto sourced using `lazy.nvim` (uncomment the line importing the `custom/plugins` directory in the `init.lua` file to enable this)
- * Modify `init.lua` with additional plugins.
- * Include the `lua/kickstart/plugins/*` files in your configuration.
+#### Examples of adding popularly requested plugins
-You can also merge updates/changes from the repo back into your fork, to keep up-to-date with any changes for the default configuration.
+<details>
+ <summary>Adding autopairs</summary>
-#### Example: Adding an autopairs plugin
+This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) and enable it on startup. For more information, see documentation for [lazy.nvim](https://github.com/folke/lazy.nvim).
In the file: `lua/custom/plugins/autopairs.lua`, add:
@@ -117,10 +127,11 @@ return {
}
```
+</details>
+<details>
+ <summary>Adding a file tree plugin</summary>
-This will automatically install [windwp/nvim-autopairs](https://github.com/windwp/nvim-autopairs) and enable it on startup. For more information, see documentation for [lazy.nvim](https://github.com/folke/lazy.nvim).
-
-#### Example: Adding a file tree plugin
+This will install the tree plugin and add the command `:Neotree` for you. You can explore the documentation at [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim) for more information.
In the file: `lua/custom/plugins/filetree.lua`, add:
@@ -142,23 +153,13 @@ return {
}
```
-This will install the tree plugin and add the command `:Neotree` for you. You can explore the documentation at [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim) for more information.
-
-### Contribution
-
-Pull-requests are welcome. The goal of this repo is not to create a Neovim configuration framework, but to offer a starting template that shows, by example, available features in Neovim. Some things that will not be included:
-
-* Custom language server configuration (null-ls templates)
-* Theming beyond a default colorscheme necessary for LSP highlight groups
-
-Each PR, especially those which increase the line count, should have a description as to why the PR is necessary.
+</details>
### FAQ
* What should I do if I already have a pre-existing neovim configuration?
* You should back it up, then delete all files associated with it.
* This includes your existing init.lua and the neovim files in `~/.local` which can be deleted with `rm -rf ~/.local/share/nvim/`
- * You may also want to look at the [migration guide for lazy.nvim](https://github.com/folke/lazy.nvim#-migration-guide)
* Can I keep my existing configuration in parallel to kickstart?
* Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#%24NVIM_APPNAME)`=nvim-NAME` to maintain multiple configurations. For example you can install the kickstart configuration in `~/.config/nvim-kickstart` and create an alias:
```
@@ -191,56 +192,3 @@ This requires:
```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' }
```
-
-### Hints And Tips For New Neovimmers
-
-Neovim is a very rich and powerful environment, but it can also feel a bit
-intimidating for new users trying to find their way around, especially if
-they're coming from other environments like Visual Studio Code or a traditional
-IDE.
-
-There's no way this README can provide you with everything you need to know, but
-here are a few tips so you can learn how to learn.
-
-### Use The Help, Luke!
-
-Neovim's help system is incredibly thorough and extensive. You should really
-take a moment to get comfortable navigating through help topics, going back and
-forth, navigating the menus, etc. This won't just help you read the help, it
-will empower you in the rest of your Neovim journey.
-
-You can double click on a topic to drill down, and hit Ctrl-o (Hold down the
-Control key and the 'o' key) to go back.
-
-Read the first page you get when you run :help carefully. it will serve you
-well.
-
-You can also get help on a particular thing by typing ":help <topic>".
-
-Like, let's say we want to learn more about folding, just type ":help folding".
-
-### To The Telescope!
-
-One of the more powerful features you get by installing this project is the
-brilliant Telescope plugin co-written by @tjdevries.
-
-Take a minute to browse through ":help telescope" and get a sense for all the
-amazing superpowers you've gained.
-
-In particular, there are two Telescope features that are incredible for helping
-you understand how to do a particular thing or how to configure a particular
-feature.
-
-If you're not sure what to look for, try ":Telescope help_tags". Let's say we
-want to configure Neovim to automatically word wrap. We might type ":Telescope
-help_tags" and then type w, r, a, p. Notice how the list of results changes with
-each new letter you type? When you're done you've got a screen full of topics
-involving word wrap.
-
-Another common question is "What keys do I hit to make a thing happen?". To get
-an answer, one way is to use ":Telescope keymaps". You'll get the same list of
-results that changes to adapt with each new key you press.
-
-With these hints in mind you should be in good shape to get learning. Remember,
-you are on a journey of discovery here, adapting your programming environment to
-your needs. It will take effort, but the rewards are worth it! :)
diff --git a/init.lua b/init.lua
index fd4567d9..0d19b081 100644
--- a/init.lua
+++ b/init.lua
@@ -3,101 +3,627 @@
=====================================================================
==================== READ THIS BEFORE CONTINUING ====================
=====================================================================
+======== .-----. ========
+======== .----------------------. | === | ========
+======== |.-""""""""""""""""""-.| |-----| ========
+======== || || | === | ========
+======== || KICKSTART.NVIM || |-----| ========
+======== || || | === | ========
+======== || || |-----| ========
+======== ||:Tutor || |:::::| ========
+======== |'-..................-'| |____o| ========
+======== `"")----------------(""` ___________ ========
+======== /::::::::::| |::::::::::\ \ no mouse \ ========
+======== /:::========| |==hjkl==:::\ \ required \ ========
+======== '""""""""""""' '""""""""""""' '""""""""""' ========
+======== ========
+=====================================================================
+=====================================================================
-Kickstart.nvim is *not* a distribution.
-
-Kickstart.nvim is a template for your own configuration.
- The goal is that you can read every line of code, top-to-bottom, understand
- what your configuration is doing, and modify it to suit your needs.
+What is Kickstart?
- Once you've done that, you should start exploring, configuring and tinkering to
- explore Neovim!
+ Kickstart.nvim is *not* a distribution.
- If you don't know anything about Lua, I recommend taking some time to read through
- a guide. One possible example:
- - https://learnxinyminutes.com/docs/lua/
+ Kickstart.nvim is a starting point for your own configuration.
+ The goal is that you can read every line of code, top-to-bottom, understand
+ what your configuration is doing, and modify it to suit your needs.
+ Once you've done that, you can start exploring, configuring and tinkering to
+ make Neovim your own! That might mean leaving kickstart just the way it is for a while
+ or immediately breaking it into modular pieces. It's up to you!
- And then you can explore or search through `:help lua-guide`
- - https://neovim.io/doc/user/lua-guide.html
+ If you don't know anything about Lua, I recommend taking some time to read through
+ a guide. One possible example which will only take 10-15 minutes:
+ - https://learnxinyminutes.com/docs/lua/
+ After understanding a bit more about Lua, you can use `:help lua-guide` as a
+ reference for how Neovim integrates Lua.
+ - :help lua-guide
+ - (or HTML version): https://neovim.io/doc/user/lua-guide.html
Kickstart Guide:
-I have left several `:help X` comments throughout the init.lua
-You should run that command and read that help section for more information.
+ TODO: The very first thing you should do is to run the command `:Tutor` in Neovim.
+
+ If you don't know what this means, type the following:
+ - <escape key>
+ - :
+ - Tutor
+ - <enter key>
+
+ (If you already know how the Neovim basics, you can skip this step)
+
+ Once you've completed that, you can continue working through **AND READING** the rest
+ of the kickstart init.lua
+
+ Next, run AND READ `:help`.
+ This will open up a help window with some basic information
+ about reading, navigating and searching the builtin help documentation.
+
+ This should be the first place you go to look when you're stuck or confused
+ with something. It's one of my favorite neovim features.
-In addition, I have some `NOTE:` items throughout the file.
-These are for you, the reader to help understand what is happening. Feel free to delete
-them once you know what you're doing, but they should serve as a guide for when you
-are first encountering a few different constructs in your nvim config.
+ MOST IMPORTANTLY, we provide a keymap "<space>sh" to [s]earch the [h]elp documentation,
+ which is very useful when you're not sure exactly what you're looking for.
+
+ I have left several `:help X` comments throughout the init.lua
+ These are hints about where to find more information about the relevant settings,
+ plugins or neovim features used in kickstart.
+
+ NOTE: Look for lines like this
+
+ Throughout the file. These are for you, the reader, to help understand what is happening.
+ Feel free to delete them once you know what you're doing, but they should serve as a guide
+ for when you are first encountering a few different constructs in your nvim config.
+
+If you experience any errors while trying to install kickstart, run `:checkhealth` for more info
I hope you enjoy your Neovim journey,
- TJ
-P.S. You can delete this when you're done too. It's your config now :)
+P.S. You can delete this when you're done too. It's your config now! :)
--]]
-- Set <space> as the leader key
-- See `:help mapleader`
--- NOTE: Must happen before plugins are required (otherwise wrong leader will be used)
+-- NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used)
vim.g.mapleader = ' '
vim.g.maplocalleader = ' '
+-- [[ Setting options ]]
+-- See `:help vim.opt`
+-- NOTE: You can change these options as you wish!
+-- For more options, you can see `:help option-list`
+
+-- Make line numbers default
+vim.opt.number = true
+-- You can also add relative line numbers, for help with jumping.
+-- Experiment for yourself to see if you like it!
+-- vim.opt.relativenumber = true
+
+-- Enable mouse mode, can be useful for resizing splits for example!
+vim.opt.mouse = 'a'
+
+-- Don't show the mode, since it's already in status line
+vim.opt.showmode = false
+
+-- Sync clipboard between OS and Neovim.
+-- Remove this option if you want your OS clipboard to remain independent.
+-- See `:help 'clipboard'`
+vim.opt.clipboard = 'unnamedplus'
+
+-- Enable break indent
+vim.opt.breakindent = true
+
+-- Save undo history
+vim.opt.undofile = true
+
+-- Case-insensitive searching UNLESS \C or capital in search
+vim.opt.ignorecase = true
+vim.opt.smartcase = true
+
+-- Keep signcolumn on by default
+vim.opt.signcolumn = 'yes'
+
+-- Decrease update time
+vim.opt.updatetime = 250
+vim.opt.timeoutlen = 300
+
+-- Configure how new splits should be opened
+vim.opt.splitright = true
+vim.opt.splitbelow = true
+
+-- Sets how neovim will display certain whitespace in the editor.
+-- See :help 'list'
+-- and :help 'listchars'
+vim.opt.list = true
+vim.opt.listchars = { tab = '» ', trail = '·', nbsp = '␣' }
+
+-- Preview substitutions live, as you type!
+vim.opt.inccommand = 'split'
+
+-- Show which line your cursor is on
+vim.opt.cursorline = true
+
+-- Minimal number of screen lines to keep above and below the cursor.
+vim.opt.scrolloff = 10
+
+-- [[ Basic Keymaps ]]
+-- See `:help vim.keymap.set()`
+
+-- Set highlight on search, but clear on pressing <Esc> in normal mode
+vim.opt.hlsearch = true
+vim.keymap.set('n', '<Esc>', '<cmd>nohlsearch<CR>')
+
+-- Diagnostic keymaps
+vim.keymap.set('n', '[d', vim.diagnostic.goto_prev, { desc = 'Go to previous [D]iagnostic message' })
+vim.keymap.set('n', ']d', vim.diagnostic.goto_next, { desc = 'Go to next [D]iagnostic message' })
+vim.keymap.set('n', '<leader>e', vim.diagnostic.open_float, { desc = 'Show diagnostic [E]rror messages' })
+vim.keymap.set('n', '<leader>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 <C-\><C-n>, 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 <C-\><C-n> to exit terminal mode
+vim.keymap.set('t', '<Esc><Esc>', '<C-\\><C-n>', { desc = 'Exit terminal mode' })
+
+-- TIP: Disable arrow keys in normal mode
+-- vim.keymap.set('n', '<left>', '<cmd>echo "Use h to move!!"<CR>')
+-- vim.keymap.set('n', '<right>', '<cmd>echo "Use l to move!!"<CR>')
+-- vim.keymap.set('n', '<up>', '<cmd>echo "Use k to move!!"<CR>')
+-- vim.keymap.set('n', '<down>', '<cmd>echo "Use j to move!!"<CR>')
+
+-- Keybinds to make split navigation easier.
+-- Use CTRL+<hjkl> to switch between windows
+--
+-- See `:help wincmd` for a list of all window commands
+vim.keymap.set('n', '<C-h>', '<C-w><C-h>', { desc = 'Move focus to the left window' })
+vim.keymap.set('n', '<C-l>', '<C-w><C-l>', { desc = 'Move focus to the right window' })
+vim.keymap.set('n', '<C-j>', '<C-w><C-j>', { desc = 'Move focus to the lower window' })
+vim.keymap.set('n', '<C-k>', '<C-w><C-k>', { desc = 'Move focus to the upper window' })
+
+-- Highlight when yanking (copying) text
+-- Try it with `yap` in normal mode
+-- See `:help vim.highlight.on_yank()`
+vim.api.nvim_create_autocmd('TextYankPost', {
+ group = vim.api.nvim_create_augroup('kickstart-highlight-yank', { clear = true }),
+ callback = function()
+ vim.highlight.on_yank()
+ end,
+})
+
-- [[ Install `lazy.nvim` plugin manager ]]
--- https://github.com/folke/lazy.nvim
--- `:help lazy.nvim.txt` for more info
+-- 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.loop.fs_stat(lazypath) then
- vim.fn.system {
- 'git',
- 'clone',
- '--filter=blob:none',
- 'https://github.com/folke/lazy.nvim.git',
- '--branch=stable', -- latest stable release
- lazypath,
- }
-end
+ local lazyrepo = 'https://github.com/folke/lazy.nvim.git'
+ vim.fn.system { 'git', 'clone', '--filter=blob:none', '--branch=stable', lazyrepo, lazypath }
+end ---@diagnostic disable-next-line: undefined-field
vim.opt.rtp:prepend(lazypath)
--- [[ Configure plugins ]]
--- NOTE: Here is where you install your plugins.
--- You can configure plugins using the `config` key.
+-- [[ Configure and install plugins ]]
+--
+-- To check the current status of your plugins, run
+-- :Lazy
--
--- You can also configure plugins after the setup call,
--- as they will be available in your neovim runtime.
+-- You can press `?` in this menu for help. Use `:q` to close the window
+--
+-- To update plugins, you can run
+-- :Lazy update
+--
+-- NOTE: Here is where you install your plugins.
require('lazy').setup({
- -- NOTE: First, some plugins that don't require any configuration
- -- Git related plugins
- 'tpope/vim-fugitive',
- 'tpope/vim-rhubarb',
+ -- NOTE: Plugins can be added with a link (or for a github repo: 'owner/repo' link).
+ 'tpope/vim-sleuth', -- Detect tabstop and shiftwidth automatically
- -- Detect tabstop and shiftwidth automatically
- 'tpope/vim-sleuth',
+ -- NOTE: Plugins can also be added by using a table,
+ -- with the first argument being the link and the following
+ -- keys can be used to configure plugin behavior/loading/etc.
+ --
+ -- Use `opts = {}` to force a plugin to be loaded.
+ --
+ -- This is equivalent to:
+ -- require('Comment').setup({})
- -- NOTE: This is where your plugins related to LSP can be installed.
- -- The configuration is done below. Search for lspconfig to find it below.
- {
- -- LSP Configuration & Plugins
+ -- "gc" to comment visual regions/lines
+ { 'numToStr/Comment.nvim', opts = {} },
+
+ -- Here is a more advanced example where we pass configuration
+ -- options to `gitsigns.nvim`. This is equivalent to the following lua:
+ -- require('gitsigns').setup({ ... })
+ --
+ -- See `:help gitsigns` to understand what the configuration keys do
+ { -- Adds git related signs to the gutter, as well as utilities for managing changes
+ 'lewis6991/gitsigns.nvim',
+ opts = {
+ signs = {
+ add = { text = '+' },
+ change = { text = '~' },
+ delete = { text = '_' },
+ topdelete = { text = '‾' },
+ changedelete = { text = '~' },
+ },
+ },
+ },
+
+ -- 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 = 'VeryLazy'
+ --
+ -- which loads which-key after all the UI elements are loaded. Events can be
+ -- normal autocommands events (:help autocomd-events).
+ --
+ -- Then, because we use the `config` key, the configuration only runs
+ -- after the plugin has been loaded:
+ -- config = function() ... end
+
+ { -- Useful plugin to show you pending keybinds.
+ 'folke/which-key.nvim',
+ event = 'VeryLazy', -- Sets the loading event to 'VeryLazy'
+ config = function() -- This is the function that runs, AFTER loading
+ require('which-key').setup()
+
+ -- Document existing key chains
+ require('which-key').register {
+ ['<leader>c'] = { name = '[C]ode', _ = 'which_key_ignore' },
+ ['<leader>d'] = { name = '[D]ocument', _ = 'which_key_ignore' },
+ ['<leader>r'] = { name = '[R]ename', _ = 'which_key_ignore' },
+ ['<leader>s'] = { name = '[S]earch', _ = 'which_key_ignore' },
+ ['<leader>w'] = { name = '[W]orkspace', _ = 'which_key_ignore' },
+ }
+ 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',
+ event = 'VeryLazy',
+ branch = '0.1.x',
+ dependencies = {
+ 'nvim-lua/plenary.nvim',
+ { -- If encountering errors, see telescope-fzf-native README for install 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' },
+
+ -- Useful for getting pretty icons, but requires special font.
+ -- If you already have a Nerd Font, or terminal set up with fallback fonts
+ -- you can enable this
+ -- { 'nvim-tree/nvim-web-devicons' }
+ },
+ 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: <c-/>
+ -- - 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 = { ['<c-enter>'] = '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', '<leader>sh', builtin.help_tags, { desc = '[S]earch [H]elp' })
+ vim.keymap.set('n', '<leader>sk', builtin.keymaps, { desc = '[S]earch [K]eymaps' })
+ vim.keymap.set('n', '<leader>sf', builtin.find_files, { desc = '[S]earch [F]iles' })
+ vim.keymap.set('n', '<leader>ss', builtin.builtin, { desc = '[S]earch [S]elect Telescope' })
+ vim.keymap.set('n', '<leader>sw', builtin.grep_string, { desc = '[S]earch current [W]ord' })
+ vim.keymap.set('n', '<leader>sg', builtin.live_grep, { desc = '[S]earch by [G]rep' })
+ vim.keymap.set('n', '<leader>sd', builtin.diagnostics, { desc = '[S]earch [D]iagnostics' })
+ vim.keymap.set('n', '<leader>sr', builtin.resume, { desc = '[S]earch [R]esume' })
+ vim.keymap.set('n', '<leader>s.', builtin.oldfiles, { desc = '[S]earch Recent Files ("." for repeat)' })
+ vim.keymap.set('n', '<leader><leader>', builtin.buffers, { desc = '[ ] Find existing buffers' })
+
+ -- Slightly advanced example of overriding default behavior and theme
+ vim.keymap.set('n', '<leader>/', function()
+ -- You can pass additional configuration to telescope to change theme, layout, etc.
+ builtin.current_buffer_fuzzy_find(require('telescope.themes').get_dropdown {
+ winblend = 10,
+ previewer = false,
+ })
+ end, { desc = '[/] Fuzzily search in current buffer' })
+
+ -- Also possible to pass additional configuration options.
+ -- See `:help telescope.builtin.live_grep()` for information about particular keys
+ vim.keymap.set('n', '<leader>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', '<leader>sn', function()
+ builtin.find_files { cwd = vim.fn.stdpath 'config' }
+ end, { desc = '[S]earch [N]eovim files' })
+ end,
+ },
+
+ { -- LSP Configuration & Plugins
'neovim/nvim-lspconfig',
dependencies = {
- -- Automatically install LSPs to stdpath for neovim
- { 'williamboman/mason.nvim', config = true },
+ -- Automatically install LSPs and related tools to stdpath for neovim
+ 'williamboman/mason.nvim',
'williamboman/mason-lspconfig.nvim',
+ 'WhoIsSethDaniel/mason-tool-installer.nvim',
- -- Useful status updates for LSP
+ -- Useful status updates for LSP.
-- NOTE: `opts = {}` is the same as calling `require('fidget').setup({})`
{ 'j-hui/fidget.nvim', opts = {} },
+ },
+ config = function()
+ -- Brief Aside: **What is LSP?**
+ --
+ -- LSP is an acronym 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
+ -- many times.
+ --
+ -- 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)
+ vim.keymap.set('n', keys, func, { buffer = event.buf, desc = 'LSP: ' .. desc })
+ end
+
+ -- 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 <C-T>.
+ map('gd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')
+
+ -- Find references for the word under your cursor.
+ map('gr', require('telescope.builtin').lsp_references, '[G]oto [R]eferences')
+
+ -- Jump to the implementation of the word under your cursor.
+ -- Useful when your language has ways of declaring types without an actual implementation.
+ map('gI', require('telescope.builtin').lsp_implementations, '[G]oto [I]mplementation')
+
+ -- 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*.
+ map('<leader>D', require('telescope.builtin').lsp_type_definitions, 'Type [D]efinition')
+
+ -- Fuzzy find all the symbols in your current document.
+ -- Symbols are things like variables, functions, types, etc.
+ map('<leader>ds', require('telescope.builtin').lsp_document_symbols, '[D]ocument [S]ymbols')
+
+ -- Fuzzy find all the symbols in your current workspace
+ -- Similar to document symbols, except searches over your whole project.
+ map('<leader>ws', require('telescope.builtin').lsp_dynamic_workspace_symbols, '[W]orkspace [S]ymbols')
+
+ -- Rename the variable under your cursor
+ -- Most Language Servers support renaming across files, etc.
+ map('<leader>rn', 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('<leader>ca', vim.lsp.buf.code_action, '[C]ode [A]ction')
+
+ -- Opens a popup that displays documentation about the word under your cursor
+ -- See `:help K` for why this keymap
+ map('K', vim.lsp.buf.hover, 'Hover Documentation')
+
+ -- WARN: This is not Goto Definition, this is Goto Declaration.
+ -- For example, in C this would take you to the header
+ map('gD', 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.server_capabilities.documentHighlightProvider then
+ vim.api.nvim_create_autocmd({ 'CursorHold', 'CursorHoldI' }, {
+ buffer = event.buf,
+ callback = vim.lsp.buf.document_highlight,
+ })
+
+ vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, {
+ buffer = event.buf,
+ callback = vim.lsp.buf.clear_references,
+ })
+ end
+ end,
+ })
+
+ -- LSP servers and clients are able to communicate to each other what features they support.
+ -- By default, Neovim doesn't support everything that is in the LSP Specification.
+ -- When you add nvim-cmp, luasnip, etc. Neovim now has *more* capabilities.
+ -- So, we create new capabilities with nvim cmp, and then broadcast that to the servers.
+ local capabilities = vim.lsp.protocol.make_client_capabilities()
+ capabilities = vim.tbl_deep_extend('force', capabilities, require('cmp_nvim_lsp').default_capabilities())
+
+ -- Enable the following language servers
+ -- Feel free to add/remove any LSPs that you want here. They will automatically be installed.
+ --
+ -- Add any additional override configuration in the following tables. Available keys are:
+ -- - cmd (table): Override the default command used to start the server
+ -- - filetypes (table): Override the default list of associated filetypes for the server
+ -- - capabilities (table): Override fields in capabilities. Can be used to disable certain LSP features.
+ -- - settings (table): Override the default settings passed when initializing the server.
+ -- For example, to see the options for `lua_ls`, you could go to: https://luals.github.io/wiki/settings/
+ local servers = {
+ -- clangd = {},
+ -- gopls = {},
+ -- pyright = {},
+ -- rust_analyzer = {},
+ -- ... etc. See `:help lspconfig-all` for a list of all the pre-configured LSPs
+ --
+ -- Some languages (like typescript) have entire language plugins that can be useful:
+ -- https://github.com/pmizio/typescript-tools.nvim
+ --
+ -- But for many setups, the LSP (`tsserver`) will work just fine
+ -- tsserver = {},
+ --
+
+ lua_ls = {
+ -- cmd = {...},
+ -- filetypes { ...},
+ -- capabilities = {},
+ settings = {
+ Lua = {
+ runtime = { version = 'LuaJIT' },
+ workspace = {
+ checkThirdParty = false,
+ -- Tells lua_ls where to find all the Lua files that you have loaded
+ -- for your neovim configuration.
+ library = {
+ '${3rd}/luv/library',
+ unpack(vim.api.nvim_get_runtime_file('', true)),
+ },
+ -- If lua_ls is really slow on your computer, you can try this instead:
+ -- library = { vim.env.VIMRUNTIME },
+ },
+ -- You can toggle below to ignore Lua_LS's noisy `missing-fields` warnings
+ -- diagnostics = { disable = { 'missing-fields' } },
+ },
+ },
+ },
+ }
+
+ -- 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
+ require('mason').setup()
+
+ -- You can add other tools here that you want Mason to install
+ -- for you, so that they are available from within Neovim.
+ local ensure_installed = vim.tbl_keys(servers or {})
+ vim.list_extend(ensure_installed, {
+ 'stylua', -- Used to format lua code
+ })
+ require('mason-tool-installer').setup { ensure_installed = ensure_installed }
+
+ require('mason-lspconfig').setup {
+ handlers = {
+ function(server_name)
+ local server = servers[server_name] or {}
+ require('lspconfig')[server_name].setup {
+ cmd = server.cmd,
+ settings = server.settings,
+ filetypes = server.filetypes,
+ -- This handles overriding only values explicitly passed
+ -- by the server configuration above. Useful when disabling
+ -- certain features of an LSP (for example, turning off formatting for tsserver)
+ capabilities = vim.tbl_deep_extend('force', {}, capabilities, server.capabilities or {}),
+ }
+ end,
+ },
+ }
+ end,
+ },
- -- Additional lua configuration, makes nvim stuff amazing!
- 'folke/neodev.nvim',
+ { -- Autoformat
+ 'stevearc/conform.nvim',
+ opts = {
+ notify_on_error = false,
+ format_on_save = {
+ timeout_ms = 500,
+ lsp_fallback = true,
+ },
+ formatters_by_ft = {
+ lua = { 'stylua' },
+ -- Conform can also run multiple formatters sequentially
+ -- python = { "isort", "black" },
+ --
+ -- You can use a sub-list to tell conform to run *until* a formatter
+ -- is found.
+ -- javascript = { { "prettierd", "prettier" } },
+ },
},
},
- {
- -- Autocompletion
+ { -- Autocompletion
'hrsh7th/nvim-cmp',
+ event = 'InsertEnter',
dependencies = {
-- Snippet Engine & its associated nvim-cmp source
{
@@ -106,7 +632,7 @@ require('lazy').setup({
-- Build Step is needed for regex support in snippets
-- This step is not supported in many windows environments
-- Remove the below condition to re-enable on windows
- if vim.fn.has 'win32' == 1 then
+ if vim.fn.has 'win32' == 1 or vim.fn.executable 'make' == 0 then
return
end
return 'make install_jsregexp'
@@ -114,571 +640,171 @@ require('lazy').setup({
},
'saadparwaiz1/cmp_luasnip',
- -- Adds LSP completion capabilities
+ -- Adds other completion capabilities.
+ -- nvim-cmp does not ship with all sources by default. They are split
+ -- into multiple repos for maintenance purposes.
'hrsh7th/cmp-nvim-lsp',
'hrsh7th/cmp-path',
- -- Adds a number of user-friendly snippets
- 'rafamadriz/friendly-snippets',
- },
- },
-
- -- Useful plugin to show you pending keybinds.
- { 'folke/which-key.nvim', opts = {} },
- {
- -- Adds git related signs to the gutter, as well as utilities for managing changes
- 'lewis6991/gitsigns.nvim',
- opts = {
- -- See `:help gitsigns.txt`
- signs = {
- add = { text = '+' },
- change = { text = '~' },
- delete = { text = '_' },
- topdelete = { text = '‾' },
- changedelete = { text = '~' },
- },
- on_attach = function(bufnr)
- local gs = package.loaded.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', 'v' }, ']c', function()
- if vim.wo.diff then
- return ']c'
- end
- vim.schedule(function()
- gs.next_hunk()
- end)
- return '<Ignore>'
- end, { expr = true, desc = 'Jump to next hunk' })
-
- map({ 'n', 'v' }, '[c', function()
- if vim.wo.diff then
- return '[c'
- end
- vim.schedule(function()
- gs.prev_hunk()
- end)
- return '<Ignore>'
- end, { expr = true, desc = 'Jump to previous hunk' })
-
- -- Actions
- -- visual mode
- map('v', '<leader>hs', function()
- gs.stage_hunk { vim.fn.line '.', vim.fn.line 'v' }
- end, { desc = 'stage git hunk' })
- map('v', '<leader>hr', function()
- gs.reset_hunk { vim.fn.line '.', vim.fn.line 'v' }
- end, { desc = 'reset git hunk' })
- -- normal mode
- map('n', '<leader>hs', gs.stage_hunk, { desc = 'git stage hunk' })
- map('n', '<leader>hr', gs.reset_hunk, { desc = 'git reset hunk' })
- map('n', '<leader>hS', gs.stage_buffer, { desc = 'git Stage buffer' })
- map('n', '<leader>hu', gs.undo_stage_hunk, { desc = 'undo stage hunk' })
- map('n', '<leader>hR', gs.reset_buffer, { desc = 'git Reset buffer' })
- map('n', '<leader>hp', gs.preview_hunk, { desc = 'preview git hunk' })
- map('n', '<leader>hb', function()
- gs.blame_line { full = false }
- end, { desc = 'git blame line' })
- map('n', '<leader>hd', gs.diffthis, { desc = 'git diff against index' })
- map('n', '<leader>hD', function()
- gs.diffthis '~'
- end, { desc = 'git diff against last commit' })
-
- -- Toggles
- map('n', '<leader>tb', gs.toggle_current_line_blame, { desc = 'toggle git blame line' })
- map('n', '<leader>td', gs.toggle_deleted, { desc = 'toggle git show deleted' })
-
- -- Text object
- map({ 'o', 'x' }, 'ih', ':<C-U>Gitsigns select_hunk<CR>', { desc = 'select git hunk' })
- end,
+ -- If you want to add a bunch of pre-configured snippets,
+ -- you can use this plugin to help you. It even has snippets
+ -- for various frameworks/libraries/etc. but you will have to
+ -- set up the ones that are useful for you.
+ -- 'rafamadriz/friendly-snippets',
},
- },
-
- {
- -- Theme inspired by Atom
- 'navarasu/onedark.nvim',
- priority = 1000,
- lazy = false,
config = function()
- require('onedark').setup {
- -- Set a style preset. 'dark' is default.
- style = 'dark', -- dark, darker, cool, deep, warm, warmer, light
+ -- See `:help cmp`
+ local cmp = require 'cmp'
+ local luasnip = require 'luasnip'
+ luasnip.config.setup {}
+
+ cmp.setup {
+ snippet = {
+ expand = function(args)
+ luasnip.lsp_expand(args.body)
+ end,
+ },
+ completion = { completeopt = 'menu,menuone,noinsert' },
+
+ -- For an understanding of why these mappings were
+ -- chosen, you will need to read `:help ins-completion`
+ --
+ -- No, but seriously. Please read `:help ins-completion`, it is really good!
+ mapping = cmp.mapping.preset.insert {
+ -- Select the [n]ext item
+ ['<C-n>'] = cmp.mapping.select_next_item(),
+ -- Select the [p]revious item
+ ['<C-p>'] = cmp.mapping.select_prev_item(),
+
+ -- Accept ([y]es) the completion.
+ -- This will auto-import if your LSP supports it.
+ -- This will expand snippets if the LSP sent a snippet.
+ ['<C-y>'] = cmp.mapping.confirm { select = true },
+
+ -- Manually trigger a completion from nvim-cmp.
+ -- Generally you don't need this, because nvim-cmp will display
+ -- completions whenever it has completion options available.
+ ['<C-Space>'] = cmp.mapping.complete {},
+
+ -- Think of <c-l> as moving to the right of your snippet expansion.
+ -- So if you have a snippet that's like:
+ -- function $name($args)
+ -- $body
+ -- end
+ --
+ -- <c-l> will move you to the right of each of the expansion locations.
+ -- <c-h> is similar, except moving you backwards.
+ ['<C-l>'] = cmp.mapping(function()
+ if luasnip.expand_or_locally_jumpable() then
+ luasnip.expand_or_jump()
+ end
+ end, { 'i', 's' }),
+ ['<C-h>'] = cmp.mapping(function()
+ if luasnip.locally_jumpable(-1) then
+ luasnip.jump(-1)
+ end
+ end, { 'i', 's' }),
+ },
+ sources = {
+ { name = 'nvim_lsp' },
+ { name = 'luasnip' },
+ { name = 'path' },
+ },
}
- require('onedark').load()
end,
},
- {
- -- Set lualine as statusline
- 'nvim-lualine/lualine.nvim',
- -- See `:help lualine.txt`
- opts = {
- options = {
- icons_enabled = false,
- theme = 'auto',
- component_separators = '|',
- section_separators = '',
- },
- },
- },
+ { -- 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`
+ 'folke/tokyonight.nvim',
+ lazy = false, -- make sure we load this during startup if it is your main colorscheme
+ priority = 1000, -- make sure to load this before all the other start plugins
+ config = function()
+ -- Load the colorscheme here
+ vim.cmd.colorscheme 'tokyonight-night'
- {
- -- Add indentation guides even on blank lines
- 'lukas-reineke/indent-blankline.nvim',
- -- Enable `lukas-reineke/indent-blankline.nvim`
- -- See `:help ibl`
- main = 'ibl',
- opts = {},
+ -- You can configure highlights by doing something like
+ vim.cmd.hi 'Comment gui=none'
+ end,
},
- -- "gc" to comment visual regions/lines
- { 'numToStr/Comment.nvim', opts = {} },
+ -- Highlight todo, notes, etc in comments
+ { 'folke/todo-comments.nvim', dependencies = { 'nvim-lua/plenary.nvim' }, opts = { signs = false } },
- -- Fuzzy Finder (files, lsp, etc)
- {
- 'nvim-telescope/telescope.nvim',
- branch = '0.1.x',
- dependencies = {
- 'nvim-lua/plenary.nvim',
- -- Fuzzy Finder Algorithm which requires local dependencies to be built.
- -- Only load if `make` is available. Make sure you have the system
- -- requirements installed.
- {
- 'nvim-telescope/telescope-fzf-native.nvim',
- -- NOTE: If you are having trouble with this installation,
- -- refer to the README for telescope-fzf-native for more instructions.
- build = 'make',
- cond = function()
- return vim.fn.executable 'make' == 1
- end,
- },
- },
+ { -- Collection of various small independent plugins/modules
+ 'echasnovski/mini.nvim',
+ config = function()
+ -- Better Around/Inside textobjects
+ --
+ -- Examples:
+ -- - va) - [V]isually select [A]round [)]parenthen
+ -- - yinq - [Y]ank [I]nside [N]ext [']quote
+ -- - ci' - [C]hange [I]nside [']quote
+ require('mini.ai').setup { 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
+ require('mini.statusline').setup()
+
+ -- ... and there is more!
+ -- Check out: https://github.com/echasnovski/mini.nvim
+ end,
},
- {
- -- Highlight, edit, and navigate code
+ { -- Highlight, edit, and navigate code
'nvim-treesitter/nvim-treesitter',
- dependencies = {
- 'nvim-treesitter/nvim-treesitter-textobjects',
- },
build = ':TSUpdate',
+ config = function()
+ -- [[ Configure Treesitter ]] See `:help nvim-treesitter`
+
+ ---@diagnostic disable-next-line: missing-fields
+ require('nvim-treesitter.configs').setup {
+ ensure_installed = { 'bash', 'c', 'html', 'lua', 'markdown', 'vim', 'vimdoc' },
+ -- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
+ auto_install = true,
+ highlight = { enable = true },
+ indent = { enable = true },
+ }
+
+ -- There are additional nvim-treesitter modules that you can use to interact
+ -- with nvim-treesitter. You should go explore a few and see what interests you:
+ --
+ -- - Incremental selection: Included, see :help nvim-treesitter-incremental-selection-mod
+ -- - Show your current context: https://github.com/nvim-treesitter/nvim-treesitter-context
+ -- - Treesitter + textobjects: https://github.com/nvim-treesitter/nvim-treesitter-textobjects
+ end,
},
- -- NOTE: Next Step on Your Neovim Journey: Add/Configure additional "plugins" for kickstart
- -- These are some example plugins that I've included in the kickstart repository.
- -- Uncomment any of the lines below to enable them.
- -- require 'kickstart.plugins.autoformat',
+ -- The following two 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
+ -- put them in the right spots if you want.
+
+ -- 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',
-- NOTE: The import below can automatically add your own plugins, configuration, etc from `lua/custom/plugins/*.lua`
- -- You can use this folder to prevent any conflicts with this init.lua if you're interested in keeping
- -- up-to-date with whatever is in the kickstart repo.
- -- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going.
+ -- This is the easiest way to modularize your config.
--
- -- For additional information see: https://github.com/folke/lazy.nvim#-structuring-your-plugins
+ -- Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going.
+ -- For additional information see: :help lazy.nvim-lazy.nvim-structuring-your-plugins
-- { import = 'custom.plugins' },
}, {})
--- [[ Setting options ]]
--- See `:help vim.o`
--- NOTE: You can change these options as you wish!
-
--- Set highlight on search
-vim.o.hlsearch = false
-
--- Make line numbers default
-vim.wo.number = true
-
--- Enable mouse mode
-vim.o.mouse = 'a'
-
--- Sync clipboard between OS and Neovim.
--- Remove this option if you want your OS clipboard to remain independent.
--- See `:help 'clipboard'`
-vim.o.clipboard = 'unnamedplus'
-
--- Enable break indent
-vim.o.breakindent = true
-
--- Save undo history
-vim.o.undofile = true
-
--- Case-insensitive searching UNLESS \C or capital in search
-vim.o.ignorecase = true
-vim.o.smartcase = true
-
--- Keep signcolumn on by default
-vim.wo.signcolumn = 'yes'
-
--- Decrease update time
-vim.o.updatetime = 250
-vim.o.timeoutlen = 300
-
--- Set completeopt to have a better completion experience
-vim.o.completeopt = 'menuone,noselect'
-
--- NOTE: You should make sure your terminal supports this
-vim.o.termguicolors = true
-
--- [[ Basic Keymaps ]]
-
--- Keymaps for better default experience
--- See `:help vim.keymap.set()`
-vim.keymap.set({ 'n', 'v' }, '<Space>', '<Nop>', { silent = true })
-
--- Remap for dealing with word wrap
-vim.keymap.set('n', 'k', "v:count == 0 ? 'gk' : 'k'", { expr = true, silent = true })
-vim.keymap.set('n', 'j', "v:count == 0 ? 'gj' : 'j'", { expr = true, silent = true })
-
--- Diagnostic keymaps
-vim.keymap.set('n', '[d', vim.diagnostic.goto_prev, { desc = 'Go to previous diagnostic message' })
-vim.keymap.set('n', ']d', vim.diagnostic.goto_next, { desc = 'Go to next diagnostic message' })
-vim.keymap.set('n', '<leader>e', vim.diagnostic.open_float, { desc = 'Open floating diagnostic message' })
-vim.keymap.set('n', '<leader>q', vim.diagnostic.setloclist, { desc = 'Open diagnostics list' })
-
--- [[ Highlight on yank ]]
--- See `:help vim.highlight.on_yank()`
-local highlight_group = vim.api.nvim_create_augroup('YankHighlight', { clear = true })
-vim.api.nvim_create_autocmd('TextYankPost', {
- callback = function()
- vim.highlight.on_yank()
- end,
- group = highlight_group,
- pattern = '*',
-})
-
--- [[ Configure Telescope ]]
--- See `:help telescope` and `:help telescope.setup()`
-require('telescope').setup {
- defaults = {
- mappings = {
- i = {
- ['<C-u>'] = false,
- ['<C-d>'] = false,
- },
- },
- },
-}
-
--- Enable telescope fzf native, if installed
-pcall(require('telescope').load_extension, 'fzf')
-
--- Telescope live_grep in git root
--- Function to find the git root directory based on the current buffer's path
-local function find_git_root()
- -- Use the current buffer's path as the starting point for the git search
- local current_file = vim.api.nvim_buf_get_name(0)
- local current_dir
- local cwd = vim.fn.getcwd()
- -- If the buffer is not associated with a file, return nil
- if current_file == '' then
- current_dir = cwd
- else
- -- Extract the directory from the current file's path
- current_dir = vim.fn.fnamemodify(current_file, ':h')
- end
-
- -- Find the Git root directory from the current file's path
- local git_root = vim.fn.systemlist('git -C ' .. vim.fn.escape(current_dir, ' ') .. ' rev-parse --show-toplevel')[1]
- if vim.v.shell_error ~= 0 then
- print 'Not a git repository. Searching on current working directory'
- return cwd
- end
- return git_root
-end
-
--- Custom live_grep function to search in git root
-local function live_grep_git_root()
- local git_root = find_git_root()
- if git_root then
- require('telescope.builtin').live_grep {
- search_dirs = { git_root },
- }
- end
-end
-
-vim.api.nvim_create_user_command('LiveGrepGitRoot', live_grep_git_root, {})
-
--- See `:help telescope.builtin`
-vim.keymap.set('n', '<leader>?', require('telescope.builtin').oldfiles, { desc = '[?] Find recently opened files' })
-vim.keymap.set('n', '<leader><space>', require('telescope.builtin').buffers, { desc = '[ ] Find existing buffers' })
-vim.keymap.set('n', '<leader>/', function()
- -- You can pass additional configuration to telescope to change theme, layout, etc.
- require('telescope.builtin').current_buffer_fuzzy_find(require('telescope.themes').get_dropdown {
- winblend = 10,
- previewer = false,
- })
-end, { desc = '[/] Fuzzily search in current buffer' })
-
-local function telescope_live_grep_open_files()
- require('telescope.builtin').live_grep {
- grep_open_files = true,
- prompt_title = 'Live Grep in Open Files',
- }
-end
-vim.keymap.set('n', '<leader>s/', telescope_live_grep_open_files, { desc = '[S]earch [/] in Open Files' })
-vim.keymap.set('n', '<leader>ss', require('telescope.builtin').builtin, { desc = '[S]earch [S]elect Telescope' })
-vim.keymap.set('n', '<leader>gf', require('telescope.builtin').git_files, { desc = 'Search [G]it [F]iles' })
-vim.keymap.set('n', '<leader>sf', require('telescope.builtin').find_files, { desc = '[S]earch [F]iles' })
-vim.keymap.set('n', '<leader>sh', require('telescope.builtin').help_tags, { desc = '[S]earch [H]elp' })
-vim.keymap.set('n', '<leader>sw', require('telescope.builtin').grep_string, { desc = '[S]earch current [W]ord' })
-vim.keymap.set('n', '<leader>sg', require('telescope.builtin').live_grep, { desc = '[S]earch by [G]rep' })
-vim.keymap.set('n', '<leader>sG', ':LiveGrepGitRoot<cr>', { desc = '[S]earch by [G]rep on Git Root' })
-vim.keymap.set('n', '<leader>sd', require('telescope.builtin').diagnostics, { desc = '[S]earch [D]iagnostics' })
-vim.keymap.set('n', '<leader>sr', require('telescope.builtin').resume, { desc = '[S]earch [R]esume' })
-
--- [[ Configure Treesitter ]]
--- See `:help nvim-treesitter`
--- Defer Treesitter setup after first render to improve startup time of 'nvim {filename}'
-vim.defer_fn(function()
- require('nvim-treesitter.configs').setup {
- -- Add languages to be installed here that you want installed for treesitter
- ensure_installed = { 'c', 'cpp', 'go', 'lua', 'python', 'rust', 'tsx', 'javascript', 'typescript', 'vimdoc', 'vim', 'bash' },
-
- -- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
- auto_install = false,
- -- Install languages synchronously (only applied to `ensure_installed`)
- sync_install = false,
- -- List of parsers to ignore installing
- ignore_install = {},
- -- You can specify additional Treesitter modules here: -- For example: -- playground = {--enable = true,-- },
- modules = {},
- highlight = { enable = true },
- indent = { enable = true },
- incremental_selection = {
- enable = true,
- keymaps = {
- init_selection = '<c-space>',
- node_incremental = '<c-space>',
- scope_incremental = '<c-s>',
- node_decremental = '<M-space>',
- },
- },
- textobjects = {
- select = {
- enable = true,
- lookahead = true, -- Automatically jump forward to textobj, similar to targets.vim
- keymaps = {
- -- You can use the capture groups defined in textobjects.scm
- ['aa'] = '@parameter.outer',
- ['ia'] = '@parameter.inner',
- ['af'] = '@function.outer',
- ['if'] = '@function.inner',
- ['ac'] = '@class.outer',
- ['ic'] = '@class.inner',
- },
- },
- move = {
- enable = true,
- set_jumps = true, -- whether to set jumps in the jumplist
- goto_next_start = {
- [']m'] = '@function.outer',
- [']]'] = '@class.outer',
- },
- goto_next_end = {
- [']M'] = '@function.outer',
- [']['] = '@class.outer',
- },
- goto_previous_start = {
- ['[m'] = '@function.outer',
- ['[['] = '@class.outer',
- },
- goto_previous_end = {
- ['[M'] = '@function.outer',
- ['[]'] = '@class.outer',
- },
- },
- swap = {
- enable = true,
- swap_next = {
- ['<leader>a'] = '@parameter.inner',
- },
- swap_previous = {
- ['<leader>A'] = '@parameter.inner',
- },
- },
- },
- }
-end, 0)
-
--- [[ Configure LSP ]]
--- This function gets run when an LSP connects to a particular buffer.
-local on_attach = function(_, bufnr)
- -- 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
- -- many times.
- --
- -- 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 nmap = function(keys, func, desc)
- if desc then
- desc = 'LSP: ' .. desc
- end
-
- vim.keymap.set('n', keys, func, { buffer = bufnr, desc = desc })
- end
-
- nmap('<leader>rn', vim.lsp.buf.rename, '[R]e[n]ame')
- nmap('<leader>ca', function()
- vim.lsp.buf.code_action { context = { only = { 'quickfix', 'refactor', 'source' } } }
- end, '[C]ode [A]ction')
-
- nmap('gd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')
- nmap('gr', require('telescope.builtin').lsp_references, '[G]oto [R]eferences')
- nmap('gI', require('telescope.builtin').lsp_implementations, '[G]oto [I]mplementation')
- nmap('<leader>D', require('telescope.builtin').lsp_type_definitions, 'Type [D]efinition')
- nmap('<leader>ds', require('telescope.builtin').lsp_document_symbols, '[D]ocument [S]ymbols')
- nmap('<leader>ws', require('telescope.builtin').lsp_dynamic_workspace_symbols, '[W]orkspace [S]ymbols')
-
- -- See `:help K` for why this keymap
- nmap('K', vim.lsp.buf.hover, 'Hover Documentation')
- nmap('<C-k>', vim.lsp.buf.signature_help, 'Signature Documentation')
-
- -- Lesser used LSP functionality
- nmap('gD', vim.lsp.buf.declaration, '[G]oto [D]eclaration')
- nmap('<leader>wa', vim.lsp.buf.add_workspace_folder, '[W]orkspace [A]dd Folder')
- nmap('<leader>wr', vim.lsp.buf.remove_workspace_folder, '[W]orkspace [R]emove Folder')
- nmap('<leader>wl', function()
- print(vim.inspect(vim.lsp.buf.list_workspace_folders()))
- end, '[W]orkspace [L]ist Folders')
-
- -- Create a command `:Format` local to the LSP buffer
- vim.api.nvim_buf_create_user_command(bufnr, 'Format', function(_)
- vim.lsp.buf.format()
- end, { desc = 'Format current buffer with LSP' })
-end
-
--- document existing key chains
-require('which-key').register {
- ['<leader>c'] = { name = '[C]ode', _ = 'which_key_ignore' },
- ['<leader>d'] = { name = '[D]ocument', _ = 'which_key_ignore' },
- ['<leader>g'] = { name = '[G]it', _ = 'which_key_ignore' },
- ['<leader>h'] = { name = 'Git [H]unk', _ = 'which_key_ignore' },
- ['<leader>r'] = { name = '[R]ename', _ = 'which_key_ignore' },
- ['<leader>s'] = { name = '[S]earch', _ = 'which_key_ignore' },
- ['<leader>t'] = { name = '[T]oggle', _ = 'which_key_ignore' },
- ['<leader>w'] = { name = '[W]orkspace', _ = 'which_key_ignore' },
-}
--- register which-key VISUAL mode
--- required for visual <leader>hs (hunk stage) to work
-require('which-key').register({
- ['<leader>'] = { name = 'VISUAL <leader>' },
- ['<leader>h'] = { 'Git [H]unk' },
-}, { mode = 'v' })
-
--- mason-lspconfig requires that these setup functions are called in this order
--- before setting up the servers.
-require('mason').setup()
-require('mason-lspconfig').setup()
-
--- Enable the following language servers
--- Feel free to add/remove any LSPs that you want here. They will automatically be installed.
---
--- Add any additional override configuration in the following tables. They will be passed to
--- the `settings` field of the server config. You must look up that documentation yourself.
---
--- If you want to override the default filetypes that your language server will attach to you can
--- define the property 'filetypes' to the map in question.
-local servers = {
- -- clangd = {},
- -- gopls = {},
- -- pyright = {},
- -- rust_analyzer = {},
- -- tsserver = {},
- -- html = { filetypes = { 'html', 'twig', 'hbs'} },
-
- lua_ls = {
- Lua = {
- workspace = { checkThirdParty = false },
- telemetry = { enable = false },
- -- NOTE: toggle below to ignore Lua_LS's noisy `missing-fields` warnings
- -- diagnostics = { disable = { 'missing-fields' } },
- },
- },
-}
-
--- Setup neovim lua configuration
-require('neodev').setup()
-
--- nvim-cmp supports additional completion capabilities, so broadcast that to servers
-local capabilities = vim.lsp.protocol.make_client_capabilities()
-capabilities = require('cmp_nvim_lsp').default_capabilities(capabilities)
-
--- Ensure the servers above are installed
-local mason_lspconfig = require 'mason-lspconfig'
-
-mason_lspconfig.setup {
- ensure_installed = vim.tbl_keys(servers),
-}
-
-mason_lspconfig.setup_handlers {
- function(server_name)
- require('lspconfig')[server_name].setup {
- capabilities = capabilities,
- on_attach = on_attach,
- settings = servers[server_name],
- filetypes = (servers[server_name] or {}).filetypes,
- }
- end,
-}
-
--- [[ Configure nvim-cmp ]]
--- See `:help cmp`
-local cmp = require 'cmp'
-local luasnip = require 'luasnip'
-require('luasnip.loaders.from_vscode').lazy_load()
-luasnip.config.setup {}
-
-cmp.setup {
- snippet = {
- expand = function(args)
- luasnip.lsp_expand(args.body)
- end,
- },
- completion = {
- completeopt = 'menu,menuone,noinsert',
- },
- mapping = cmp.mapping.preset.insert {
- ['<C-n>'] = cmp.mapping.select_next_item(),
- ['<C-p>'] = cmp.mapping.select_prev_item(),
- ['<C-b>'] = cmp.mapping.scroll_docs(-4),
- ['<C-f>'] = cmp.mapping.scroll_docs(4),
- ['<C-Space>'] = cmp.mapping.complete {},
- ['<CR>'] = cmp.mapping.confirm {
- behavior = cmp.ConfirmBehavior.Replace,
- select = true,
- },
- ['<Tab>'] = cmp.mapping(function(fallback)
- if cmp.visible() then
- cmp.select_next_item()
- elseif luasnip.expand_or_locally_jumpable() then
- luasnip.expand_or_jump()
- else
- fallback()
- end
- end, { 'i', 's' }),
- ['<S-Tab>'] = cmp.mapping(function(fallback)
- if cmp.visible() then
- cmp.select_prev_item()
- elseif luasnip.locally_jumpable(-1) then
- luasnip.jump(-1)
- else
- fallback()
- end
- end, { 'i', 's' }),
- },
- sources = {
- { name = 'nvim_lsp' },
- { name = 'luasnip' },
- { name = 'path' },
- },
-}
-
-- The line beneath this is called `modeline`. See `:help modeline`
-- vim: ts=2 sts=2 sw=2 et
diff --git a/lua/kickstart/health.lua b/lua/kickstart/health.lua
new file mode 100644
index 00000000..957204e8
--- /dev/null
+++ b/lua/kickstart/health.lua
@@ -0,0 +1,51 @@
+--[[
+--
+-- This file is not required for your own configuration,
+-- but helps people determine if their system is setup correctly.
+--
+--]]
+
+local check_version = function()
+ if not vim.version.cmp then
+ vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", tostring(vim.version())))
+ return
+ end
+
+ if vim.version.cmp(vim.version(), { 0, 9, 4 }) >= 0 then
+ vim.health.ok(string.format("Neovim version is: '%s'", tostring(vim.version())))
+ else
+ vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", tostring(vim.version())))
+ end
+end
+
+local check_external_reqs = function()
+ -- Basic utils: `git`, `make`, `unzip`
+ for _, exe in ipairs { 'git', 'make', 'unzip', 'rg' } do
+ local is_executable = vim.fn.executable(exe) == 1
+ if is_executable then
+ vim.health.ok(string.format("Found executable: '%s'", exe))
+ else
+ vim.health.warn(string.format("Could not find executable: '%s'", exe))
+ end
+ end
+
+ return true
+end
+
+return {
+ check = function()
+ vim.health.start 'kickstart.nvim'
+
+ vim.health.info [[NOTE: Not every warning is a 'must-fix' in `:checkhealth`
+
+ Fix only warnings for plugins and languages you intend to use.
+ Mason will give warnings for languages that are not installed.
+ You do not need to install, unless you want to use those languages!]]
+
+ local uv = vim.uv or vim.loop
+ vim.health.info('System Information: ' .. vim.inspect(uv.os_uname()))
+
+ check_version()
+ check_external_reqs()
+ end,
+}
diff --git a/lua/kickstart/plugins/autoformat.lua b/lua/kickstart/plugins/autoformat.lua
deleted file mode 100644
index bc56b15b..00000000
--- a/lua/kickstart/plugins/autoformat.lua
+++ /dev/null
@@ -1,74 +0,0 @@
--- autoformat.lua
---
--- Use your language server to automatically format your code on save.
--- Adds additional commands as well to manage the behavior
-
-return {
- 'neovim/nvim-lspconfig',
- config = function()
- -- Switch for controlling whether you want autoformatting.
- -- Use :KickstartFormatToggle to toggle autoformatting on or off
- local format_is_enabled = true
- vim.api.nvim_create_user_command('KickstartFormatToggle', function()
- format_is_enabled = not format_is_enabled
- print('Setting autoformatting to: ' .. tostring(format_is_enabled))
- end, {})
-
- -- Create an augroup that is used for managing our formatting autocmds.
- -- We need one augroup per client to make sure that multiple clients
- -- can attach to the same buffer without interfering with each other.
- local _augroups = {}
- local get_augroup = function(client)
- if not _augroups[client.id] then
- local group_name = 'kickstart-lsp-format-' .. client.name
- local id = vim.api.nvim_create_augroup(group_name, { clear = true })
- _augroups[client.id] = id
- end
-
- return _augroups[client.id]
- end
-
- -- Whenever an LSP attaches to a buffer, we will run this function.
- --
- -- See `:help LspAttach` for more information about this autocmd event.
- vim.api.nvim_create_autocmd('LspAttach', {
- group = vim.api.nvim_create_augroup('kickstart-lsp-attach-format', { clear = true }),
- -- This is where we attach the autoformatting for reasonable clients
- callback = function(args)
- local client_id = args.data.client_id
- local client = vim.lsp.get_client_by_id(client_id)
- local bufnr = args.buf
-
- -- Only attach to clients that support document formatting
- if not client.server_capabilities.documentFormattingProvider then
- return
- end
-
- -- Tsserver usually works poorly. Sorry you work with bad languages
- -- You can remove this line if you know what you're doing :)
- if client.name == 'tsserver' then
- return
- end
-
- -- Create an autocmd that will run *before* we save the buffer.
- -- Run the formatting command for the LSP that has just attached.
- vim.api.nvim_create_autocmd('BufWritePre', {
- group = get_augroup(client),
- buffer = bufnr,
- callback = function()
- if not format_is_enabled then
- return
- end
-
- vim.lsp.buf.format {
- async = false,
- filter = function(c)
- return c.id == client.id
- end,
- }
- end,
- })
- end,
- })
- end,
-}
diff --git a/lua/kickstart/plugins/indent_line.lua b/lua/kickstart/plugins/indent_line.lua
new file mode 100644
index 00000000..ed7f2693
--- /dev/null
+++ b/lua/kickstart/plugins/indent_line.lua
@@ -0,0 +1,9 @@
+return {
+ { -- Add indentation guides even on blank lines
+ 'lukas-reineke/indent-blankline.nvim',
+ -- Enable `lukas-reineke/indent-blankline.nvim`
+ -- See `:help ibl`
+ main = 'ibl',
+ opts = {},
+ },
+}
From 1c89b024c8ee1cdeda8cc02e9d434c0dbe08bcba Mon Sep 17 00:00:00 2001
From: TJ DeVries <devries.timothyj@gmail.com>
Date: Mon, 26 Feb 2024 10:45:32 -0500
Subject: [PATCH 39/40] fixup: add autocommand link for help and description
---
init.lua | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/init.lua b/init.lua
index 0d19b081..fb569a4a 100644
--- a/init.lua
+++ b/init.lua
@@ -184,10 +184,14 @@ vim.keymap.set('n', '<C-l>', '<C-w><C-l>', { desc = 'Move focus to the right win
vim.keymap.set('n', '<C-j>', '<C-w><C-j>', { desc = 'Move focus to the lower window' })
vim.keymap.set('n', '<C-k>', '<C-w><C-k>', { desc = 'Move focus to the upper window' })
+-- [[ Basic Autocommands ]]
+-- See :help lua-guide-autocommands
+
-- Highlight when yanking (copying) text
-- Try it with `yap` in normal mode
-- See `:help vim.highlight.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.highlight.on_yank()
From af4fd2355f211d4d19ec08ea6d57cbea483e2ee7 Mon Sep 17 00:00:00 2001
From: TJ DeVries <devries.timothyj@gmail.com>
Date: Mon, 26 Feb 2024 10:46:31 -0500
Subject: [PATCH 40/40] fixup: change comment to reflect auto_install
---
init.lua | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/init.lua b/init.lua
index fb569a4a..1e5691a7 100644
--- a/init.lua
+++ b/init.lua
@@ -775,7 +775,7 @@ require('lazy').setup({
---@diagnostic disable-next-line: missing-fields
require('nvim-treesitter.configs').setup {
ensure_installed = { 'bash', 'c', 'html', 'lua', 'markdown', 'vim', 'vimdoc' },
- -- Autoinstall languages that are not installed. Defaults to false (but you can change for yourself!)
+ -- Autoinstall languages that are not installed
auto_install = true,
highlight = { enable = true },
indent = { enable = true },