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
+ Linux and Mac
+
```sh
git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
-- on Windows (cmd)
+ Windows
+
+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\
```
+
+ Adding autopairs
-#### 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 {
}
```
+
+
+ Adding a file tree 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).
-
-#### 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.
+
### 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 ".
-
-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:
+ -
+ - :
+ - Tutor
+ -
+
+ (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 "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 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 in normal mode
+vim.opt.hlsearch = true
+vim.keymap.set('n', '', 'nohlsearch')
+
+-- 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', 'e', vim.diagnostic.open_float, { desc = 'Show diagnostic [E]rror messages' })
+vim.keymap.set('n', 'q', vim.diagnostic.setloclist, { desc = 'Open diagnostic [Q]uickfix list' })
+
+-- Exit terminal mode in the builtin terminal with a shortcut that is a bit easier
+-- for people to discover. Otherwise, you normally need to press , which
+-- is not what someone will guess without a bit more experience.
+--
+-- NOTE: This won't work in all terminal emulators/tmux/etc. Try your own mapping
+-- or just use to exit terminal mode
+vim.keymap.set('t', '', '', { desc = 'Exit terminal mode' })
+
+-- TIP: Disable arrow keys in normal mode
+-- vim.keymap.set('n', '', 'echo "Use h to move!!"')
+-- vim.keymap.set('n', '', 'echo "Use l to move!!"')
+-- vim.keymap.set('n', '', 'echo "Use k to move!!"')
+-- vim.keymap.set('n', '', 'echo "Use j to move!!"')
+
+-- Keybinds to make split navigation easier.
+-- Use CTRL+ to switch between windows
+--
+-- See `:help wincmd` for a list of all window commands
+vim.keymap.set('n', '', '', { desc = 'Move focus to the left window' })
+vim.keymap.set('n', '', '', { desc = 'Move focus to the right window' })
+vim.keymap.set('n', '', '', { desc = 'Move focus to the lower window' })
+vim.keymap.set('n', '', '', { desc = 'Move focus to the upper window' })
+
+-- 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 {
+ ['c'] = { name = '[C]ode', _ = 'which_key_ignore' },
+ ['d'] = { name = '[D]ocument', _ = 'which_key_ignore' },
+ ['r'] = { name = '[R]ename', _ = 'which_key_ignore' },
+ ['s'] = { name = '[S]earch', _ = 'which_key_ignore' },
+ ['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:
+ -- - Normal mode: ?
+ --
+ -- This opens a window that shows you all of the keymaps for the current
+ -- telescope picker. This is really useful to discover what Telescope can
+ -- do as well as how to actually do it!
+
+ -- [[ Configure Telescope ]]
+ -- See `:help telescope` and `:help telescope.setup()`
+ require('telescope').setup {
+ -- You can put your default mappings / updates / etc. in here
+ -- All the info you're looking for is in `:help telescope.setup()`
+ --
+ -- defaults = {
+ -- mappings = {
+ -- i = { [''] = 'to_fuzzy_refine' },
+ -- },
+ -- },
+ -- pickers = {}
+ extensions = {
+ ['ui-select'] = {
+ require('telescope.themes').get_dropdown(),
+ },
+ },
+ }
+
+ -- Enable telescope extensions, if they are installed
+ pcall(require('telescope').load_extension, 'fzf')
+ pcall(require('telescope').load_extension, 'ui-select')
+
+ -- See `:help telescope.builtin`
+ local builtin = require 'telescope.builtin'
+ vim.keymap.set('n', 'sh', builtin.help_tags, { desc = '[S]earch [H]elp' })
+ vim.keymap.set('n', 'sk', builtin.keymaps, { desc = '[S]earch [K]eymaps' })
+ vim.keymap.set('n', 'sf', builtin.find_files, { desc = '[S]earch [F]iles' })
+ vim.keymap.set('n', 'ss', builtin.builtin, { desc = '[S]earch [S]elect Telescope' })
+ vim.keymap.set('n', 'sw', builtin.grep_string, { desc = '[S]earch current [W]ord' })
+ vim.keymap.set('n', 'sg', builtin.live_grep, { desc = '[S]earch by [G]rep' })
+ vim.keymap.set('n', 'sd', builtin.diagnostics, { desc = '[S]earch [D]iagnostics' })
+ vim.keymap.set('n', 'sr', builtin.resume, { desc = '[S]earch [R]esume' })
+ vim.keymap.set('n', 's.', builtin.oldfiles, { desc = '[S]earch Recent Files ("." for repeat)' })
+ vim.keymap.set('n', '', builtin.buffers, { desc = '[ ] Find existing buffers' })
+
+ -- Slightly advanced example of overriding default behavior and theme
+ vim.keymap.set('n', '/', 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', 's/', function()
+ builtin.live_grep {
+ grep_open_files = true,
+ prompt_title = 'Live Grep in Open Files',
+ }
+ end, { desc = '[S]earch [/] in Open Files' })
+
+ -- Shortcut for searching your neovim configuration files
+ vim.keymap.set('n', 'sn', function()
+ builtin.find_files { cwd = vim.fn.stdpath 'config' }
+ end, { desc = '[S]earch [N]eovim files' })
+ 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 .
+ 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('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('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('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('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('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 ''
- 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 ''
- end, { expr = true, desc = 'Jump to previous hunk' })
-
- -- Actions
- -- visual mode
- map('v', 'hs', function()
- gs.stage_hunk { vim.fn.line '.', vim.fn.line 'v' }
- end, { desc = 'stage git hunk' })
- map('v', 'hr', function()
- gs.reset_hunk { vim.fn.line '.', vim.fn.line 'v' }
- end, { desc = 'reset git hunk' })
- -- normal mode
- map('n', 'hs', gs.stage_hunk, { desc = 'git stage hunk' })
- map('n', 'hr', gs.reset_hunk, { desc = 'git reset hunk' })
- map('n', 'hS', gs.stage_buffer, { desc = 'git Stage buffer' })
- map('n', 'hu', gs.undo_stage_hunk, { desc = 'undo stage hunk' })
- map('n', 'hR', gs.reset_buffer, { desc = 'git Reset buffer' })
- map('n', 'hp', gs.preview_hunk, { desc = 'preview git hunk' })
- map('n', 'hb', function()
- gs.blame_line { full = false }
- end, { desc = 'git blame line' })
- map('n', 'hd', gs.diffthis, { desc = 'git diff against index' })
- map('n', 'hD', function()
- gs.diffthis '~'
- end, { desc = 'git diff against last commit' })
-
- -- Toggles
- map('n', 'tb', gs.toggle_current_line_blame, { desc = 'toggle git blame line' })
- map('n', 'td', gs.toggle_deleted, { desc = 'toggle git show deleted' })
-
- -- Text object
- map({ 'o', 'x' }, 'ih', ':Gitsigns select_hunk', { 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
+ [''] = cmp.mapping.select_next_item(),
+ -- Select the [p]revious item
+ [''] = 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.
+ [''] = 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.
+ [''] = cmp.mapping.complete {},
+
+ -- Think of as moving to the right of your snippet expansion.
+ -- So if you have a snippet that's like:
+ -- function $name($args)
+ -- $body
+ -- end
+ --
+ -- will move you to the right of each of the expansion locations.
+ -- is similar, except moving you backwards.
+ [''] = cmp.mapping(function()
+ if luasnip.expand_or_locally_jumpable() then
+ luasnip.expand_or_jump()
+ end
+ end, { 'i', 's' }),
+ [''] = 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' }, '', '', { 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', 'e', vim.diagnostic.open_float, { desc = 'Open floating diagnostic message' })
-vim.keymap.set('n', '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 = {
- [''] = false,
- [''] = 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', '?', require('telescope.builtin').oldfiles, { desc = '[?] Find recently opened files' })
-vim.keymap.set('n', '', require('telescope.builtin').buffers, { desc = '[ ] Find existing buffers' })
-vim.keymap.set('n', '/', 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', 's/', telescope_live_grep_open_files, { desc = '[S]earch [/] in Open Files' })
-vim.keymap.set('n', 'ss', require('telescope.builtin').builtin, { desc = '[S]earch [S]elect Telescope' })
-vim.keymap.set('n', 'gf', require('telescope.builtin').git_files, { desc = 'Search [G]it [F]iles' })
-vim.keymap.set('n', 'sf', require('telescope.builtin').find_files, { desc = '[S]earch [F]iles' })
-vim.keymap.set('n', 'sh', require('telescope.builtin').help_tags, { desc = '[S]earch [H]elp' })
-vim.keymap.set('n', 'sw', require('telescope.builtin').grep_string, { desc = '[S]earch current [W]ord' })
-vim.keymap.set('n', 'sg', require('telescope.builtin').live_grep, { desc = '[S]earch by [G]rep' })
-vim.keymap.set('n', 'sG', ':LiveGrepGitRoot', { desc = '[S]earch by [G]rep on Git Root' })
-vim.keymap.set('n', 'sd', require('telescope.builtin').diagnostics, { desc = '[S]earch [D]iagnostics' })
-vim.keymap.set('n', '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 = '',
- node_incremental = '',
- scope_incremental = '',
- node_decremental = '',
- },
- },
- 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 = {
- ['a'] = '@parameter.inner',
- },
- swap_previous = {
- ['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('rn', vim.lsp.buf.rename, '[R]e[n]ame')
- nmap('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('D', require('telescope.builtin').lsp_type_definitions, 'Type [D]efinition')
- nmap('ds', require('telescope.builtin').lsp_document_symbols, '[D]ocument [S]ymbols')
- nmap('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('', vim.lsp.buf.signature_help, 'Signature Documentation')
-
- -- Lesser used LSP functionality
- nmap('gD', vim.lsp.buf.declaration, '[G]oto [D]eclaration')
- nmap('wa', vim.lsp.buf.add_workspace_folder, '[W]orkspace [A]dd Folder')
- nmap('wr', vim.lsp.buf.remove_workspace_folder, '[W]orkspace [R]emove Folder')
- nmap('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 {
- ['c'] = { name = '[C]ode', _ = 'which_key_ignore' },
- ['d'] = { name = '[D]ocument', _ = 'which_key_ignore' },
- ['g'] = { name = '[G]it', _ = 'which_key_ignore' },
- ['h'] = { name = 'Git [H]unk', _ = 'which_key_ignore' },
- ['r'] = { name = '[R]ename', _ = 'which_key_ignore' },
- ['s'] = { name = '[S]earch', _ = 'which_key_ignore' },
- ['t'] = { name = '[T]oggle', _ = 'which_key_ignore' },
- ['w'] = { name = '[W]orkspace', _ = 'which_key_ignore' },
-}
--- register which-key VISUAL mode
--- required for visual hs (hunk stage) to work
-require('which-key').register({
- [''] = { name = 'VISUAL ' },
- ['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 {
- [''] = cmp.mapping.select_next_item(),
- [''] = cmp.mapping.select_prev_item(),
- [''] = cmp.mapping.scroll_docs(-4),
- [''] = cmp.mapping.scroll_docs(4),
- [''] = cmp.mapping.complete {},
- [''] = cmp.mapping.confirm {
- behavior = cmp.ConfirmBehavior.Replace,
- select = true,
- },
- [''] = 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' }),
- [''] = 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 = {},
+ },
+}