diff --git a/.github/workflows/stylua.yml b/.github/workflows/stylua.yml
new file mode 100644
index 00000000..75db6c33
--- /dev/null
+++ b/.github/workflows/stylua.yml
@@ -0,0 +1,21 @@
+# Check Lua Formatting
+name: Check Lua Formatting
+on: pull_request_target
+
+jobs:
+ stylua-check:
+ if: github.repository == 'nvim-lua/kickstart.nvim'
+ name: Stylua Check
+ runs-on: ubuntu-latest
+ 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:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ version: latest
+ args: --check .
+
diff --git a/.gitignore b/.gitignore
index 4c1a99df..c6dfcb3f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,4 +3,6 @@ tags
test.sh
.luarc.json
nvim
+
+spell/
lazy-lock.json
diff --git a/README.md b/README.md
index 4a312bc9..6d48c18e 100644
--- a/README.md
+++ b/README.md
@@ -1,67 +1,113 @@
# 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.
+
+## Installation
+
+### Install Neovim
+
+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 External Dependencies
+
+> **NOTE**
+> [Backup](#FAQ) your previous configuration (if any exists)
+
+External Requirements:
+- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`)
+- [ripgrep](https://github.com/BurntSushi/ripgrep#installation)
+- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons
+ - if you have it set `vim.g.have_nerd_font` in `init.lua` to true
+- 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, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
+| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
+| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
+
+### Install Kickstart
+
+Clone kickstart.nvim:
+
+ Linux and Mac
+
+```sh
+git clone https://github.com/nvim-lua/kickstart.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
+```
+
+ Windows
+
+If you're using `cmd.exe`:
+
+```
+git clone https://github.com/nvim-lua/kickstart.nvim.git %userprofile%\AppData\Local\nvim\
+```
-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.
+If you're using `powershell.exe`
-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.
+```
+git clone https://github.com/nvim-lua/kickstart.nvim.git $env:USERPROFILE\AppData\Local\nvim\
+```
+
+
+ Adding autopairs
+
+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:
@@ -85,10 +131,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:
@@ -110,28 +157,31 @@ 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:
+ ```
+ alias nvim-kickstart='NVIM_APPNAME="nvim-kickstart" nvim'
+ ```
+ 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.
+ 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
@@ -147,3 +197,20 @@ 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' }
```
+Alternatively one can install gcc and make which don't require changing the config,
+the easiest way is to use choco:
+
+1. install [chocolatey](https://chocolatey.org/install)
+either follow the instructions on the page or use winget,
+run in cmd as **admin**:
+```
+winget install --accept-source-agreements chocolatey.chocolatey
+```
+
+2. install all requirements using choco, exit previous cmd and
+open a new one so that choco path is set, run in cmd as **admin**:
+```
+choco install -y neovim git ripgrep wget fd unzip gzip mingw make
+```
+
+Then continue with the [Install Kickstart](#Install-Kickstart) step.
diff --git a/init.lua b/init.lua
index c50b043f..d778a174 100644
--- a/init.lua
+++ b/init.lua
@@ -3,81 +3,270 @@
=====================================================================
==================== 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.
-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.
+ 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.
+
+ 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 = ' '
-vim.g.python3_host_prog = os.getenv 'HOME' .. '/.virtualenvs/neovim3/bin/python'
-vim.g.python_host_prog = os.getenv 'HOME' .. '/.virtualenvs/neovim3/bin/python3.10'
+vim.g.python3_host_prog = os.getenv 'HOME' .. '/.pyenv/virtualenvs/neovim3/bin/python'
+vim.g.python_host_prog = os.getenv 'HOME' .. '/.pyenv/virtualenvs/neovim3/bin/python3.10'
-- The line beneath this is called `modeline`. See `:help modeline`
-- vim: ts=2 sts=2 sw=2 et
-- Install package manager
-- https://github.com/folke/lazy.nvim
-- `:help lazy.nvim.txt` for more info
+-- Set to true if you have a Nerd Font installed
+vim.g.have_nerd_font = false
+
+-- [[ 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 all buffer
+vim.keymap.set('n', 'wa', ':wall', { noremap = true, desc = '[W]rite [A]ll' })
+vim.keymap.set('n', 'wf', ':w', { noremap = true, desc = '[W]rite [F]ile' })
+
+-- Create command do save with qw
+vim.api.nvim_command 'cmap qw wq'
+vim.api.nvim_command 'cmap WQ wq'
+vim.api.nvim_command 'cmap QW wq'
+
+-- Navigate buffers
+vim.keymap.set('n', '', ':bp', { noremap = true, desc = '[G]oto [P]previous Buffer' })
+vim.keymap.set('n', '', ':bn', { noremap = true, desc = '[G]oto [N]ext Buffer' })
+
+vim.keymap.set('n', '[c', function()
+ require('treesitter-context').go_to_context(vim.v.count1)
+end, { silent = 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
+
+-- Decrease mapped sequence wait time
+-- Displays which-key popup sooner
+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' })
+
+-- [[ 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()
+ end,
+})
+
+-- [[ Install `lazy.nvim` plugin manager ]]
+-- See `:help lazy.nvim.txt` or https://github.com/folke/lazy.nvim for more info
local lazypath = vim.fn.stdpath 'data' .. '/lazy/lazy.nvim'
if not vim.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)
--- 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 press `?` in this menu for help. Use `:q` to close the window
--
--- You can also configure plugins after the setup call,
--- as they will be available in your neovim runtime.
+-- 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
+ -- python import
+ { 'stevanmilic/nvim-lspimport' },
+
+ -- NOTE: Plugins can be added with a link (or for a github repo: 'owner/repo' link).
+ 'tpope/vim-sleuth', -- Detect tabstop and shiftwidth automatically
- -- Git related plugins
- 'tpope/vim-fugitive',
- 'tpope/vim-rhubarb',
+ -- 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({})
- -- Detect tabstop and shiftwidth automatically
- 'tpope/vim-sleuth',
+ -- "gc" to comment visual regions/lines
+ { 'numToStr/Comment.nvim', opts = {} },
-- NOTE: This is where your plugins related to LSP can be installed.
-- The configuration is done below. Search for lspconfig to find it below.
@@ -140,9 +329,14 @@ require('lazy').setup({
{ 'folke/which-key.nvim', opts = {} },
{
-- Adds git related signs to the gutter, as well as utilities for managing changes
+ -- 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 = {
- -- See `:help gitsigns.txt`
signs = {
add = { text = '+' },
change = { text = '~' },
@@ -159,72 +353,113 @@ require('lazy').setup({
},
},
- {
- -- Theme inspired by Atom
- 'navarasu/onedark.nvim',
- priority = 1000,
- config = function()
- vim.cmd.colorscheme 'onedark'
+ -- NOTE: Plugins can also be configured to run lua code when they are loaded.
+ --
+ -- This is often very useful to both group configuration, as well as handle
+ -- lazy loading plugins that don't need to be loaded immediately at startup.
+ --
+ -- For example, in the following configuration, we use:
+ -- event = 'VimEnter'
+ --
+ -- which loads which-key before all the UI elements are loaded. Events can be
+ -- normal autocommands events (`:help autocmd-events`).
+ --
+ -- Then, because we use the `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 = 'VimEnter', -- Sets the loading event to 'VimEnter'
+ 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' },
+ ['t'] = { name = '[T]oggle', _ = 'which_key_ignore' },
+ ['h'] = { name = 'Git [H]unk', _ = 'which_key_ignore' },
+ }
+ -- visual mode
+ require('which-key').register({
+ ['h'] = { 'Git [H]unk' },
+ }, { mode = 'v' })
end,
},
- {
- -- Set lualine as statusline
- 'nvim-lualine/lualine.nvim',
- -- See `:help lualine.txt`
- opts = {
- options = {
- icons_enabled = false,
- theme = 'onedark',
- component_separators = '|',
- section_separators = '',
- },
- },
- },
-
- {
- -- Add indentation guides even on blank lines
- 'lukas-reineke/indent-blankline.nvim',
- -- Enable `lukas-reineke/indent-blankline.nvim`
- -- See `:help indent_blankline.txt`
- opts = {
- char = '┊',
- show_trailing_blankline_indent = false,
- },
- },
-
- -- "gc" to comment visual regions/lines
- { 'numToStr/Comment.nvim', opts = {} },
+ -- 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)
- {
+ { -- Fuzzy Finder (files, lsp, etc)
'nvim-telescope/telescope.nvim',
+ event = 'VimEnter',
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.
- {
+ { -- If encountering errors, see telescope-fzf-native README for install instructions
'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` 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' },
- {
- -- Highlight, edit, and navigate code
- 'nvim-treesitter/nvim-treesitter',
- dependencies = {
- 'nvim-treesitter/nvim-treesitter-textobjects',
+ -- Useful for getting pretty icons, but requires a Nerd Font.
+ { 'nvim-tree/nvim-web-devicons', enabled = vim.g.have_nerd_font },
},
- build = ':TSUpdate',
- },
+ 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(),
+ },
+ },
+ }
-- 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.
@@ -240,13 +475,40 @@ require('lazy').setup({
-- For additional information see: https://github.com/folke/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
+ -- 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' })
-- Make line numbers default
vim.wo.number = true
@@ -609,42 +871,736 @@ cmp.setup {
snippet = {
expand = function(args)
luasnip.lsp_expand(args.body)
+ -- 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,
},
- 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,
+
+ { -- LSP Configuration & Plugins
+ 'neovim/nvim-lspconfig',
+ dependencies = {
+ -- 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.
+ -- NOTE: `opts = {}` is the same as calling `require('fidget').setup({})`
+ { 'j-hui/fidget.nvim', opts = {} },
+
+ -- `neodev` configures Lua LSP for your Neovim config, runtime and plugins
+ -- used for completion, annotations and signatures of Neovim apis
+ { 'folke/neodev.nvim', opts = {} },
},
- [''] = 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()
+ 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.
+ --
+ -- 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 entire 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')
+
+ -- Signature hel
+ -- For example, in C this would take you to the header.
+ map('', vim.lsp.buf.signature_help, '[G]oto [S]signature [H]elp')
+
+ -- workspace add folder
+ map('wa', vim.lsp.buf.add_workspace_folder, '[W]orkspace [A]add folder')
+
+ -- workspace remove folder
+ map('wr', vim.lsp.buf.remove_workspace_folder, '[W]orkspace [R]emove folder')
+
+ -- workspace list folder
+ map('wl', vim.lsp.buf.list_workspace_folders, '[W]orkspace [L]ist folder')
+
+ -- 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
+ local highlight_augroup = vim.api.nvim_create_augroup('kickstart-lsp-highlight', { clear = false })
+ vim.api.nvim_create_autocmd({ 'CursorHold', 'CursorHoldI' }, {
+ buffer = event.buf,
+ group = highlight_augroup,
+ callback = vim.lsp.buf.document_highlight,
+ })
+
+ vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, {
+ buffer = event.buf,
+ group = highlight_augroup,
+ callback = vim.lsp.buf.clear_references,
+ })
+
+ vim.api.nvim_create_autocmd('LspDetach', {
+ group = vim.api.nvim_create_augroup('kickstart-lsp-detach', { clear = true }),
+ callback = function(event2)
+ vim.lsp.buf.clear_references()
+ vim.api.nvim_clear_autocmds { group = 'kickstart-lsp-highlight', buffer = event2.buf }
+ end,
+ })
+ end
+
+ -- The following autocommand is used to enable inlay hints in your
+ -- code, if the language server you are using supports them
+ --
+ -- This may be unwanted, since they displace some of your code
+ if client and client.server_capabilities.inlayHintProvider and vim.lsp.inlay_hint then
+ map('th', function()
+ vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled())
+ end, '[T]oggle Inlay [H]ints')
+ 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 = {},
+ ruff = {},
+ 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 },
+ },
+ completion = {
+ callSnippet = 'Replace',
+ },
+ -- 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, {
+ 'azure-pipelines-language-server',
+ 'autoflake',
+ 'autopep8',
+ 'awk-language-server',
+ 'azure-pipelines-language-server',
+ 'bash-debug-adapter',
+ 'bash-language-server',
+ 'bicep-lsp',
+ 'black',
+ 'codelldb',
+ 'codespell',
+ 'debugpy',
+ 'dockerfile-language-server',
+ 'helm-ls',
+ 'html-lsp',
+ 'jq',
+ 'json-lsp',
+ 'jsonlint',
+ 'jsonnet-language-server',
+ 'lua-language-server',
+ 'markdownlint',
+ 'mypy',
+ 'powershell-editor-services',
+ 'prettier',
+ 'pyright',
+ 'ruff-lsp', -- linter for python (includes flake8, pep8, etc.)
+ 'debugpy', -- debugger
+ 'black', -- formatter
+ 'isort', -- organize imports
+ 'taplo', -- LSP for toml (for pyproject.toml files)
+ 'ruff',
+ 'rust-analyzer',
+ 'shellcheck',
+ 'stylua', -- Used to format lua code
+ 'terraform-ls',
+ 'tflint',
+ 'tree-sitter-cli',
+ 'trivy',
+ 'yaml-language-server',
+ 'yamlfix',
+ 'yamlfmt',
+ 'yamllint',
+ 'yq',
+ })
+ require('mason-tool-installer').setup { ensure_installed = ensure_installed }
+
+ require('mason-lspconfig').setup {
+ handlers = {
+ function(server_name)
+ local server = servers[server_name] or {}
+ -- This handles overriding only values explicitly passed
+ -- by the server configuration above. Useful when disabling
+ -- certain features of an LSP (for example, turning off formatting for tsserver)
+ server.capabilities = vim.tbl_deep_extend('force', {}, capabilities, server.capabilities or {})
+ require('lspconfig')[server_name].setup(server)
+ end,
+ },
+ }
+ end,
+ },
+
+ { -- Autoformat
+ 'stevearc/conform.nvim',
+ lazy = false,
+ keys = {
+ {
+ 'f',
+ function()
+ require('conform').format { async = true, lsp_fallback = true }
+ end,
+ mode = '',
+ desc = '[F]ormat buffer',
+ },
+ },
+ opts = {
+ notify_on_error = false,
+ format_on_save = function(bufnr)
+ -- Disable "format_on_save lsp_fallback" for languages that don't
+ -- have a well standardized coding style. You can add additional
+ -- languages here or re-enable it for the disabled ones.
+ local disable_filetypes = { c = true, cpp = true }
+ return {
+ timeout_ms = 500,
+ lsp_fallback = not disable_filetypes[vim.bo[bufnr].filetype],
+ }
+ end,
+ formatters_by_ft = {
+ go = { 'goimports', 'gofmt' },
+ javascript = { { 'prettierd', 'prettier' } },
+ json = { 'jsonlint' },
+ lua = { 'stylua' },
+ markdown = { 'inject' },
+ python = function(bufnr)
+ if require('conform').get_formatter_info('ruff_format', bufnr).available then
+ return { 'ruff_format' }
+ else
+ return { 'isort', 'black' }
+ end
+ end,
+ yaml = { 'yamllint' },
+ -- Use the "_" filetype to run formatters on filetypes that don't
+ -- have other formatters configured.
+ ['_'] = { 'trim_whitespace' },
+ },
+ },
+ },
+
+ { -- Autocompletion
+ 'hrsh7th/nvim-cmp',
+ event = 'InsertEnter',
+ dependencies = {
+ -- Snippet Engine & its associated nvim-cmp source
+ {
+ '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 or vim.fn.executable 'make' == 0 then
+ return
+ end
+ return 'make install_jsregexp'
+ end)(),
+ dependencies = {
+ 'friendly-snippets', --contains a variety of premade snippets.
+ -- See the README about individual language/framework/plugin snippets:
+ -- https://github.com/rafamadriz/friendly-snippets
+ {
+ 'rafamadriz/friendly-snippets',
+ config = function()
+ require('luasnip.loaders.from_vscode').lazy_load()
+ end,
+ },
+ },
+ },
+ 'saadparwaiz1/cmp_luasnip',
+
+ -- 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-buffer',
+ 'hrsh7th/cmp-cmdline',
+ 'hrsh7th/cmp-path',
+
+ -- 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',
+ },
+ config = function()
+ -- 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(),
+
+ -- Scroll the documentation window [b]ack / [f]orward
+ [''] = cmp.mapping.scroll_docs(-4),
+ [''] = cmp.mapping.scroll_docs(4),
+
+ -- 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 },
+
+ -- If you prefer more traditional completion keymaps,
+ -- you can uncomment the following lines
+ --[''] = cmp.mapping.confirm { select = true },
+ --[''] = cmp.mapping.select_next_item(),
+ --[''] = cmp.mapping.select_prev_item(),
+
+ -- 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' }),
+
+ -- For more advanced Luasnip keymaps (e.g. selecting choice nodes, expansion) see:
+ -- https://github.com/L3MON4D3/LuaSnip?tab=readme-ov-file#keymaps
+ },
+ sources = {
+ { name = 'nvim_lsp' },
+ { name = 'bufer' },
+ { name = 'luasnip' },
+ { name = 'path' },
+ },
+ }
+ end,
+ },
+
+ -----------------------------------------------------------------------------
+ -- PYTHON REPL
+ -- A basic REPL that opens up as a horizontal split
+ -- - use `i` to toggle the REPL
+ -- - use `I` to restart the REPL
+ -- - `+` serves as the "send to REPL" operator. That means we can use `++`
+ -- to send the current line to the REPL, and `+j` to send the current and the
+ -- following line to the REPL, like we would do with other vim operators.
+ {
+ 'Vigemus/iron.nvim',
+ keys = {
+ { 'i', vim.cmd.IronRepl, desc = ' Toggle REPL' },
+ { 'I', vim.cmd.IronRestart, desc = ' Restart REPL' },
+
+ -- these keymaps need no right-hand-side, since that is defined by the
+ -- plugin config further below
+ { '+', mode = { 'n', 'x' }, desc = ' Send-to-REPL Operator' },
+ { '++', desc = ' Send Line to REPL' },
+ },
+
+ -- since irons's setup call is `require("iron.core").setup`, instead of
+ -- `require("iron").setup` like other plugins would do, we need to tell
+ -- lazy.nvim which module to via the `main` key
+ main = 'iron.core',
+ opts = {
+ keymaps = {
+ send_line = '++',
+ visual_send = '+',
+ send_motion = '+',
+ },
+ config = {
+ -- this defined how the repl is opened. Here we set the REPL window
+ -- to open in a horizontal split to a bottom, with a height of 10
+ -- cells.
+ repl_open_cmd = 'horizontal bot 10 split',
+
+ -- since the python repl does not play well with indents, it's
+ -- preferable to use `ipython` or `bypython` here.
+ -- (see: https://github.com/Vigemus/iron.nvim/issues/348)
+ repl_definition = {
+ python = {
+ command = function()
+ local ipythonAvailable = vim.fn.executable 'ipython' == 1
+ local binary = ipythonAvailable and 'ipython' or 'python3'
+ return { binary }
+ end,
+ },
+ },
+ },
+ },
+ },
+
+ { -- 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',
+ priority = 1000, -- Make sure to load this before all the other start plugins.
+ init = function()
+ -- Load the colorscheme here.
+ -- Like many other themes, this one has different styles, and you could load
+ -- any other, such as 'tokyonight-storm', 'tokyonight-moon', or 'tokyonight-day'.
+ vim.cmd.colorscheme 'tokyonight-night'
+
+ -- You can configure highlights by doing something like
+ vim.cmd.hi 'Comment gui=none'
+ end,
+ },
+
+ -- Highlight todo, notes, etc in comments
+ { 'folke/todo-comments.nvim', event = 'VimEnter', dependencies = { 'nvim-lua/plenary.nvim' }, opts = { signs = false } },
+
+ { -- Collection of various small independent plugins/modules
+ 'echasnovski/mini.nvim',
+ config = function()
+ -- Better Around/Inside textobjects
+ --
+ -- Examples:
+ -- - va) - [V]isually select [A]round [)]paren
+ -- - 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
+ local statusline = require 'mini.statusline'
+ -- set use_icons to true if you have a Nerd Font
+ statusline.setup { use_icons = vim.g.have_nerd_font }
+
+ -- You can configure sections in the statusline by overriding their
+ -- default behavior. For example, here we set the section for
+ -- cursor location to LINE:COLUMN
+ ---@diagnostic disable-next-line: duplicate-set-field
+ statusline.section_location = function()
+ return '%2l:%-2v'
end
- end, { 'i', 's' }),
+
+ -- ... and there is more!
+ -- Check out: https://github.com/echasnovski/mini.nvim
+ end,
+ },
+
+ { -- Highlight, edit, and navigate code
+ 'nvim-treesitter/nvim-treesitter',
+ build = ':TSUpdate',
+ opts = {
+ ensure_installed = {
+ 'awk',
+ 'bash',
+ 'bicep',
+ 'c',
+ 'comment',
+ 'css',
+ 'dockerfile',
+ 'go',
+ 'hcl',
+ 'html',
+ 'javascript',
+ 'jq',
+ 'json',
+ 'jsonnet',
+ 'lua',
+ 'markdown',
+ 'markdown_inline',
+ 'python',
+ 'query',
+ 'rust',
+ 'terraform',
+ 'tsx',
+ 'typescript',
+ 'vim',
+ 'vimdoc',
+ 'yaml',
+ },
+ -- Autoinstall languages that are not installed
+ auto_install = true,
+ highlight = {
+ enable = true,
+ -- Some languages depend on vim's regex highlighting system (such as Ruby) for indent rules.
+ -- If you are experiencing weird indenting issues, add the language to
+ -- the list of additional_vim_regex_highlighting and disabled languages for indent.
+ additional_vim_regex_highlighting = { 'ruby' },
+ },
+ indent = { enable = true, disable = { 'ruby' } },
+ },
+ config = function(_, opts)
+ -- [[ Configure Treesitter ]] See `:help nvim-treesitter`
+
+ -- Prefer git instead of curl in order to improve connectivity in some environments
+ require('nvim-treesitter.install').prefer_git = true
+ ---@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
+ 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,
},
- sources = {
- { name = 'nvim_lsp' },
- { name = 'luasnip' },
+
+ -- 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',
+ require 'kickstart.plugins.lint',
+ require 'kickstart.plugins.autopairs',
+ require 'kickstart.plugins.neo-tree',
+ require 'kickstart.plugins.gitsigns', -- adds gitsigns recommend keymaps
+
+ -- NOTE: The import below can automatically add your own plugins, configuration, etc from `lua/custom/plugins/*.lua`
+ -- This is the easiest way to modularize your config.
+ --
+ -- 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' },
+}, {
+ ui = {
+ -- If you are using a Nerd Font: set icons to an empty table which will use the
+ -- default lazy.nvim defined Nerd Font icons, otherwise define a unicode icons table
+ icons = vim.g.have_nerd_font and {} or {
+ cmd = '⌘',
+ config = '🛠',
+ event = '📅',
+ ft = '📂',
+ init = '⚙',
+ keys = '🗝',
+ plugin = '🔌',
+ runtime = '💻',
+ require = '🌙',
+ source = '📄',
+ start = '🚀',
+ task = '📌',
+ lazy = '💤 ',
+ },
},
-}
+})
+
+-- Create group to assign commands
+-- "clear = true" must be set to prevent loading an
+-- auto-command repeatedly every time a file is resourced
+local autocmd_group = vim.api.nvim_create_augroup('Custom auto-commands', { clear = true })
+
+-- vim.api.nvim_create_autocmd({ 'BufWritePost' }, {
+-- pattern = { '*.yaml', '*.yml' },
+-- desc = 'Auto-format YAML files after saving',
+-- callback = function()
+-- local fileName = vim.api.nvim_buf_get_name(0)
+-- vim.cmd(':!yamlfmt ' .. fileName)
+-- end,
+-- group = autocmd_group,
+-- })
+
+-- BASIC PYTHON-RELATED OPTIONS
+
+-- The filetype-autocmd runs a function when opening a file with the filetype
+-- "python". This method allows you to make filetype-specific configurations. In
+-- there, you have to use `opt_local` instead of `opt` to limit the changes to
+-- just that buffer. (As an alternative to using an autocmd, you can also put those
+-- configurations into a file `/after/ftplugin/{filetype}.lua` in your
+-- nvim-directory.)
+vim.api.nvim_create_autocmd('FileType', {
+ pattern = 'python', -- filetype for which to run the autocmd
+ callback = function()
+ -- use pep8 standards
+ vim.opt_local.expandtab = true
+ vim.opt_local.shiftwidth = 4
+ vim.opt_local.tabstop = 4
+ vim.opt_local.softtabstop = 4
+
+ -- folds based on indentation https://neovim.io/doc/user/fold.html#fold-indent
+ -- if you are a heavy user of folds, consider using `nvim-ufo`
+ -- vim.opt_local.foldmethod = 'indent'
+
+ -- automatically capitalize boolean values. Useful if you come from a
+ -- different language, and lowercase them out of habit.
+ vim.cmd.inoreabbrev ' true True'
+ vim.cmd.inoreabbrev ' false False'
+
+ -- in the same way, we can fix habits regarding comments or None
+ vim.cmd.inoreabbrev ' -- #'
+ vim.cmd.inoreabbrev ' null None'
+ vim.cmd.inoreabbrev ' none None'
+ vim.cmd.inoreabbrev ' nil None'
+ end,
+})
+
+-- lspimport keymap
+vim.keymap.set('n', 'a', require('lspimport').import, { noremap = true, desc = '[L]sp [I]mport' })
-- 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..04df77b3
--- /dev/null
+++ b/lua/kickstart/health.lua
@@ -0,0 +1,52 @@
+--[[
+--
+-- This file is not required for your own configuration,
+-- but helps people determine if their system is setup correctly.
+--
+--]]
+
+local check_version = function()
+ local verstr = string.format('%s.%s.%s', vim.version().major, vim.version().minor, vim.version().patch)
+ if not vim.version.cmp then
+ vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", verstr))
+ return
+ end
+
+ if vim.version.cmp(vim.version(), { 0, 9, 4 }) >= 0 then
+ vim.health.ok(string.format("Neovim version is: '%s'", verstr))
+ else
+ vim.health.error(string.format("Neovim out of date: '%s'. Upgrade to latest stable or nightly", verstr))
+ 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/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 = {},
+ },
+}