diff --git a/README.md b/README.md
index 9ed19123..e9d31703 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,8 @@ External Requirements:
- etc.
> **NOTE**
-> See [Windows Installation](#Windows-Installation) to double check any additional Windows notes
+> See [Install Recipes](#Install-Recipes) for additional Windows and Linux specific notes
+> and quick install snippets
Neovim's configurations are located under the following paths, depending on your OS:
@@ -140,8 +141,7 @@ This will install the tree plugin and add the command `:Neotree` for you. For mo
In the file: `lua/custom/plugins/filetree.lua`, add:
```lua
--- Unless you are still migrating, remove the deprecated commands from v1.x
-vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])
+-- File: lua/custom/plugins/filetree.lua
return {
"nvim-neo-tree/neo-tree.nvim",
@@ -183,8 +183,15 @@ return {
* [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
+### Install Recipes
+Below you can find OS specific install instructions for Neovim and dependencies.
+
+After installing all the dependencies continue with the [Install Kickstart](#Install-Kickstart) step.
+
+#### Windows Installation
+
+Windows with Microsoft C++ Build Tools and CMake
Installation may require installing build tools and updating the run command for `telescope-fzf-native`
See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)
@@ -196,7 +203,8 @@ 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' }
```
-
+
+Windows with gcc/make using chocolatey
Alternatively, one can install gcc and make which don't require changing the config,
the easiest way is to use choco:
@@ -212,5 +220,41 @@ open a new one so that choco path is set, and run in cmd as **admin**:
```
choco install -y neovim git ripgrep wget fd unzip gzip mingw make
```
+
+WSL (Windows Subsystem for Linux)
+
+```
+wsl --install
+wsl
+sudo add-apt-repository ppa:neovim-ppa/unstable -y
+sudo apt update
+sudo apt install make gcc ripgrep unzip neovim
+```
+
+
+#### Linux Install
+Ubuntu Install Steps
+
+```
+sudo add-apt-repository ppa:neovim-ppa/unstable -y
+sudo apt update
+sudo apt install make gcc ripgrep unzip neovim
+```
+
+Debian Install Steps
+
+```
+sudo apt update
+sudo apt install make gcc ripgrep unzip git
+echo "deb https://deb.debian.org/debian unstable main" | sudo tee -a /etc/apt/sources.list
+sudo apt update
+sudo apt install -t unstable neovim
+```
+
+Fedora Install Steps
+
+```
+sudo dnf install -y gcc make git ripgrep fd-find neovim
+```
+
-Then, continue with the [Install Kickstart](#Install-Kickstart) step.
diff --git a/init.lua b/init.lua
index f4edc1a6..7861a21d 100644
--- a/init.lua
+++ b/init.lua
@@ -44,6 +44,9 @@ 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
@@ -336,6 +339,10 @@ require('lazy').setup({
-- 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 = {} },
},
config = function()
-- Brief Aside: **What is LSP?**
@@ -382,7 +389,7 @@ require('lazy').setup({
-- 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 .
+ -- To jump back, press .
map('gd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')
-- Find references for the word under your cursor.
@@ -477,18 +484,6 @@ require('lazy').setup({
-- 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',
},
@@ -534,10 +529,16 @@ require('lazy').setup({
'stevearc/conform.nvim',
opts = {
notify_on_error = false,
- format_on_save = {
- timeout_ms = 500,
- lsp_fallback = true,
- },
+ 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 = {
lua = { 'stylua' },
-- Conform can also run multiple formatters sequentially
@@ -566,6 +567,17 @@ require('lazy').setup({
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',
@@ -574,12 +586,6 @@ require('lazy').setup({
-- into multiple repos for maintenance purposes.
'hrsh7th/cmp-nvim-lsp',
'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`
@@ -605,6 +611,10 @@ require('lazy').setup({
-- 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.
@@ -633,6 +643,9 @@ require('lazy').setup({
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' },
@@ -705,17 +718,24 @@ require('lazy').setup({
{ -- Highlight, edit, and navigate code
'nvim-treesitter/nvim-treesitter',
build = ':TSUpdate',
- config = function()
+ opts = {
+ ensure_installed = { 'bash', 'c', 'html', 'lua', 'markdown', 'vim', 'vimdoc' },
+ -- 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`
---@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 },
- }
+ require('nvim-treesitter.configs').setup(opts)
-- 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: