NvChad

https://nvchad.com/docs/
Admin
NvChad is a highly performant and feature-rich Neovim configuration framework with built-in theming,...
Tokens:7,593
Snippets:136
Trust Score:8.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Automating Mason Installation

Source: https://nvchad.com/docs/features

Example of how to configure lspconfig for multiple language servers. Running `MasonInstallAll` will automatically install the corresponding mason packages for these configurations.

```lua
require("lspconfig").html.setup{}
require("lspconfig").clangd.setup{}
```

--------------------------------

### Configure Plugins with lazy.nvim

Source: https://nvchad.com/docs/config/plugins

Example of how to manage NvChad's default plugins and configure custom ones using lazy.nvim. Use `enabled = false` to disable a default plugin. The `opts` table can extend default configurations or be a function for dynamic setup.

```lua
return {
  { "folke/which-key.nvim",  enabled = false }, -- disable a default nvchad plugin

  -- this opts will extend the default opts 
  {
    "nvim-treesitter/nvim-treesitter",
    opts = { ensure_installed = {"html", "css", "bash"} },
  }, 

  -- If your opts uses a function call ex: require*, then make opts spec a function
  -- Then modify the opts arg
  {
    "nvim-telescope/telescope.nvim",
    opts = function(_, conf) 
      conf.defaults.mappings.i = {
        ["<C-j>"] = require("telescope.actions").move_selection_next,
        ["<Esc>"] = require("telescope.actions").close,
      }

     -- or 
     -- table.insert(conf.defaults.mappings.i, your table)
      return conf
    end,
  }
}



```

--------------------------------

### Base46 Cache Example

Source: https://nvchad.com/docs/features

Example of how to use the Base46 cache to load integration files. This is useful for lazy-loading highlight groups.

```lua
dofile(vim.g.base46_cache .. "cmp")
```

--------------------------------

### Lua Dictionary Tables

Source: https://nvchad.com/docs/quickstart/learn-lua

Demonstrates creating and accessing Lua dictionaries (key-value pairs) using both bracket notation and dot notation. Includes an example of iterating through dictionary elements using pairs.

```lua
local info = { 
   name = "sid",
   age = 20,
   isAlive = true
}

-- both print sid
print(info["name"])
print(info.name)

-- Loop by pairs
for key, value in pairs(info) do
   print(key .. " " .. tostring(value))
end

-- prints name sid, age 20 etc



```

--------------------------------

### Lua Nested Tables

Source: https://nvchad.com/docs/quickstart/learn-lua

Provides examples of creating and iterating through nested lists and nested dictionaries in Lua.

```lua
-- Nested lists
local data = {
    { "sid", 20 },
    { "tim", 90 },
}

for i = 1, #data do
  print(data[i][1] .. " is " .. data[i][2] .. " years old")
end

-- Nested dictionaries
local data = {
    sid = { age = 20 },
    tim = { age = 90 },
}



```

--------------------------------

### Lua Array Tables

Source: https://nvchad.com/docs/quickstart/learn-lua

Explains how to create and access elements in Lua arrays (lists) using numerical indices. Includes examples of iterating through arrays using a numeric for loop and ipairs.

```lua
local colors = { "red", "green", "blue" }

print(colors[1]) -- red

-- Different ways to loop through lists
-- #colors is the length of the table, #tablename is the syntax

for i = 1, #colors do
  print(colors[i])
end

-- ipairs 
for index, value in ipairs(colors) do
   print(colors[index])
   -- or
   print(value)
end

-- If you dont use index or value here then you can replace it with _ 
for _, value in ipairs(colors) do
   print(value)
end



```

--------------------------------

### Dynamic Terminal Padding

Source: https://nvchad.com/docs/recipes

Dynamically adjust terminal padding based on whether Neovim is entering or leaving. This example is tailored for the Kitty terminal but can be adapted for others.

```lua
local autocmd = vim.api.nvim_create_autocmd

autocmd("VimEnter", {
  command = ":silent !kitty @ set-spacing padding=0 margin=0",
})

autocmd("VimLeavePre", {
  command = ":silent !kitty @ set-spacing padding=20 margin=10",
})



```

--------------------------------

### Uninstall NvChad on Flatpak (Linux)

Source: https://nvchad.com/docs/quickstart/install

Remove NvChad configuration and state files for Flatpak installations.

```bash
# Flatpak (linux)
rm -rf ~/.var/app/io.neovim.nvim/config/nvim
rm -rf ~/.var/app/io.neovim.nvim/data/nvim
rm -rf ~/.var/app/io.neovim.nvim/.local/state/nvim

```

--------------------------------

### Lua Scope Example

Source: https://nvchad.com/docs/quickstart/learn-lua

Illustrates variable scope in Lua, showing that variables declared within a function are not accessible outside of it.

```lua
function foo()
  local n = 10
end

print(n) -- nil , n isn't accessible outside foo()



```

--------------------------------

### Clone NvChad Starter

Source: https://nvchad.com/docs/quickstart/install

Use this command to clone the NvChad starter configuration to your Neovim config directory and then launch Neovim.

```bash
git clone https://github.com/NvChad/starter ~/.config/nvim && nvim

```

--------------------------------

### Basic LSP Server Configuration

Source: https://nvchad.com/docs/config/lsp

Configure basic LSP settings by enabling specific language servers. Further configuration details can be found by running `:h vim.lsp.config` in Neovim.

```lua
require("nvchad.configs.lspconfig").defaults()

local servers = { "html", "cssls" }
vim.lsp.enable(servers)

-- to configure lsps further read :h vim.lsp.config

```

--------------------------------

### Lua Comments

Source: https://nvchad.com/docs/quickstart/learn-lua

Demonstrates single-line and multi-line comment syntax in Lua.

```lua
-- comment
print("Hi") -- comment

--[[ 
 multi-line 
 comment
]]



```

--------------------------------

### Lua While Loop

Source: https://nvchad.com/docs/quickstart/learn-lua

Demonstrates the syntax and usage of a 'while' loop in Lua, executing code as long as a condition is true.

```lua
local i = 1

while i <= 3 do
   print("hi")
   i = i + 1
end



```

--------------------------------

### Add nvim-lspconfig Plugin

Source: https://nvchad.com/docs/config/lsp

Add the `nvim-lspconfig` plugin to your Neovim configuration. This is a prerequisite for managing LSP servers.

```lua
{
  "neovim/nvim-lspconfig",
   config = function()
      require "configs.lspconfig"
   end,
},


```

--------------------------------

### Clean Lspconfig Syntax

Source: https://nvchad.com/docs/recipes

Configure multiple LSP servers efficiently by storing them in a table and iterating through it. This approach cleans up repetitive configuration code.

```lua
local servers = {
  html = {},
  awk_ls = {},
  bashls = {},

  pyright = {
    settings = {
      python = {
        analysis = {
          autoSearchPaths = true,
          typeCheckingMode = "basic",
        },
      },
    },
  },
}

for name, opts in pairs(servers) do
  vim.lsp.config(name, opts)
  vim.lsp.enable(name)
end

-- if you dont want to call the enable method in the loop, just pass a table.
-- vim.lsp.enable(vim.tbl_keys(servers))
-- vim.lsp.enable({"pyright", "clangd"})



```

--------------------------------

### Clipboard Integration in WSL

Source: https://nvchad.com/docs/recipes

Configure Neovim to use the Windows clipboard for '+' and '*' registers within WSL. This bypasses the need for 'xclip' and uses 'clip.exe' and PowerShell.

```lua
vim.g.clipboard = {
  name = 'WslClipboard',
  copy = {
    ['+'] = 'clip.exe',
    ['*'] = 'clip.exe',
  },
  paste = {
    ['+'] = 'pwsh.exe -c [Console]::Out.Write($(Get-Clipboard -Raw).tostring().replace("`r", ""))',
    ['*'] = 'pwsh.exe -c [Console]::Out.Write($(Get-Clipboard -Raw).tostring().replace("`r", ""))',
  },
  cache_enabled = 0,
}



```

--------------------------------

### Configure LSP Mappings on Attach

Source: https://nvchad.com/docs/config/mappings

Define LSP-specific mappings within the `on_attach` function. These mappings are buffer-local and applied after the LSP client is attached.

```lua
local ooo = function(client, bufnr)
  nvlsp.on_attach(client, bufnr)
  -- map HERE
  vim.keymap.set("n", "gd", "<cmd> Telescope<cr>", { buffer = bufnr })
end

for _, lsp in ipairs(servers) do
  lspconfig[lsp].setup {
    on_attach = ooo,
    on_init = nvlsp.on_init,
    capabilities = nvlsp.capabilities,
  }
end
```

--------------------------------

### Lua For Loop

Source: https://nvchad.com/docs/quickstart/learn-lua

Shows the basic 'for' loop syntax in Lua for iterating a specific number of times.

```lua
for i = 1, 3 do
   print("hi")
end
-- Both print "hi" 3 times



```

--------------------------------

### Lua Variables

Source: https://nvchad.com/docs/quickstart/learn-lua

Shows how to declare and use variables of different types (number, string, boolean, nil) and demonstrates string concatenation.

```lua
local x = 10 -- number
local name = "sid" -- string
local isAlive = true -- boolean
local a = nil --no value or invalid value

-- increment in numbers
local n = 1
n = n + 1
print(n) -- 2

-- strings
-- Concatenate strings
local phrase = "I am"
local name = "Sid"

print(phrase .. " " .. name) -- I am Sid
print("I am " .. "Sid")



```

--------------------------------

### Define Basic and Multi-Mode Mappings

Source: https://nvchad.com/docs/config/mappings

Use `vim.keymap.set` to define mappings for single or multiple modes. The `desc` option is used for documentation purposes.

```lua
local map = vim.keymap.set

map("n", "<leader>ff", "<cmd> Telescope <cr>")

-- multiple modes 
map({ "i", "n" }, "<C-k>", "<Up>", { desc = "Move up" })
map({ "i", "n" }, "<C-j>", "<Down>", { desc = "Move down" })
```

--------------------------------

### Lua Modules

Source: https://nvchad.com/docs/quickstart/learn-lua

Explains how to import code from other files using the 'require' function in Lua, detailing how file paths are resolved.

```lua
require("path")

-- for example in ~/.config/nvim/lua , all dirs and files are accessable via require
-- Do note that all files in that lua folder are in path!
-- ~/.config/nvim/lua/abc.lua 
-- ~/.config/nvim/lua/abc/init.lua

 require "abc"

-- both do the same thing



```

--------------------------------

### Lua Conditional Statements

Source: https://nvchad.com/docs/quickstart/learn-lua

Illustrates the use of if, elseif, and else statements for conditional logic with number, boolean, and string comparisons.

```lua
-- Number comparisons
local age = 10

if age > 18 then
  print("over 18") -- this will not be executed
end

-- elseif and else
age = 20

if age > 18 then
  print("over 18")
elseif age == 18 then
  print("18 huh")
else
  print("kiddo")
end

-- Boolean comparison
local isAlive = true

if isAlive then
    print("Be grateful!")
end

-- String comparisons
local name = "sid"

if name ~= "sid" then
  print("not sid")
end



```

--------------------------------

### Neovim vim.tbl_deep_extend Function

Source: https://nvchad.com/docs/quickstart/learn-lua

Demonstrates the use of Neovim's `vim.tbl_deep_extend` function for recursively merging tables. Shows how the 'force' option overwrites values and notes that list tables without keys are not merged.

```lua
-- table 1
local person = {
    name = "joe",
    age = 19,
    skills = {"python", "html"},
}

-- table 2
local someone = {
    name = "siduck",
    skills = {"js", "lua"},
}

-- "force" will overwrite equal values from the someone table over the person table
local result = vim.tbl_deep_extend("force", person, someone)

-- result : 
{
    name = "siduck",
    age = 19,
    skills = {"js", "lua"},
}

-- The list tables wont merge cuz they dont have keys 



```

--------------------------------

### Configure VSCode Snippets Path

Source: https://nvchad.com/docs/config/snippets

Set the global variable `vim.g.vscode_snippets_path` to point to your VSCode snippet extension directory. This is useful for integrating snippets from VSCode extensions.

```lua
vim.g.vscode_snippets_path = "path to your vscode snippet extension directory"
```

--------------------------------

### Configure Snipmate Snippets Path

Source: https://nvchad.com/docs/config/snippets

Set the global variable `vim.g.snipmate_snippets_path` to specify the directory for your snipmate-formatted snippets.

```lua
vim.g.snipmate_snippets_path = "your snippets path"
```

--------------------------------

### Lua Comparison Operators

Source: https://nvchad.com/docs/quickstart/learn-lua

Lists common comparison operators used in Lua for evaluating conditions.

```lua
 == equal
 < less than
 > greater than
 <= less than or equal to
 >= greater than or equal to
 ~= not equal



```

--------------------------------

### Configure Lua Snippets Path

Source: https://nvchad.com/docs/config/snippets

Set the global variable `vim.g.lua_snippets_path` to the configuration directory for your lua-formatted snippets. `vim.fn.stdpath "config"` dynamically retrieves the NvChad config folder path.

```lua
vim.g.lua_snippets_path = vim.fn.stdpath "config" .. "/lua/lua_snippets"
```

--------------------------------

### Lua Functions

Source: https://nvchad.com/docs/quickstart/learn-lua

Defines and calls functions in Lua using both the 'local function' syntax and the 'local function_name = function()' syntax. Also shows functions with multiple parameters and return values.

```lua
local function print_num(a)
  print(a)
end

-- or

local print_num = function(a)
  print(a)
end

print_num(5) -- prints 5 

-- multiple parameters
function sum(a, b)
  return a + b
end



```

--------------------------------

### Lua Combining Conditional Statements

Source: https://nvchad.com/docs/quickstart/learn-lua

Shows how to combine conditions using 'and' and 'or' operators within if-elseif-else statements.

```lua
local age = 22

if age == 10 and x > 0 then -- both should be true
  print("kiddo!")
elseif x == 18 or x > 18 then -- 1 or more are true
  print("over 18")
end

-- result: over 18



```

--------------------------------

### Map with Lua Function

Source: https://nvchad.com/docs/config/mappings

Define a mapping that executes a Lua function. This allows for more complex actions than simple command execution.

```lua
map("n", "<A-i>", function()
   -- do something
end, { desc = "Terminal toggle floating" })
```

--------------------------------

### Uninstall NvChad on Windows CMD

Source: https://nvchad.com/docs/quickstart/install

Remove NvChad configuration and state files using Windows Command Prompt.

```cmd
# Windows CMD
rd -r ~'AppData\Local\nvim
rd -r ~'AppData\Local\nvim-data

```

--------------------------------

### Configure Alacritty Key Binding for Ctrl+I

Source: https://nvchad.com/docs/faq

This configuration is for the Alacritty terminal emulator and maps the Control+I key combination. It's relevant when dealing with key mapping conflicts in NvChad, particularly with the Tab key.

```yaml
key_bindings:
   - { key: I, mods: Control, chars: "\x1b[105;6u" }

```

--------------------------------

### Show Nvdash When All Buffers Are Closed

Source: https://nvchad.com/docs/recipes

Automatically trigger the 'Nvdash' command when the last buffer is closed. This uses a 'BufDelete' autocmd to check the number and name of remaining buffers.

```lua
vim.api.nvim_create_autocmd("BufDelete", {
  callback = function() 
    local bufs = vim.t.bufs
    if #bufs == 1 and vim.api.nvim_buf_get_name(bufs[1]) == "" then
      vim.cmd "Nvdash"
    end
  end,
})



```

--------------------------------

### Uninstall NvChad on Linux/MacOS

Source: https://nvchad.com/docs/quickstart/install

Remove NvChad configuration and state files from your system.

```bash
# Linux / MacOS (unix)
rm -rf ~/.config/nvim
rm -rf ~/.local/state/nvim
rm -rf ~/.local/share/nvim

```

--------------------------------

### Restore Cursor Position on File Open

Source: https://nvchad.com/docs/recipes

Automatically restore the cursor's position when reopening a file. This autocmd is configured to ignore specific file types like 'commit', 'xxd', and 'gitrebase'.

```lua
local autocmd = vim.api.nvim_create_autocmd

autocmd("BufReadPost", {
  pattern = "*",
  callback = function() 
    local line = vim.fn.line "'"
    if
      line > 1
      and line <= vim.fn.line "$"
      and vim.bo.filetype ~= "commit"
      and vim.fn.index({ "xxd", "gitrebase" }, vim.bo.filetype) == -1
    then
      vim.cmd 'normal! g`"'
    end
  end,
})



```

--------------------------------

### Lua Invert Value with not

Source: https://nvchad.com/docs/quickstart/learn-lua

Demonstrates how to invert a boolean value using the 'not' keyword in conditional statements.

```lua
local isAlive = true

if not isAlive then
  print(" ye ded!")
end



```

--------------------------------

### Enable CursorLine Highlight in Neovim

Source: https://nvchad.com/docs/faq

This Lua configuration enables the CursorLine highlight in Neovim by setting the cursorlineopt to 'both'. This is useful when the CursorLine highlight is not showing by default.

```lua
vim.o.cursorlineopt = "both"

```

--------------------------------

### Uninstall NvChad on Windows PowerShell

Source: https://nvchad.com/docs/quickstart/install

Remove NvChad configuration and state files using Windows PowerShell.

```powershell
# Windows PowerShell
rm -Force ~'AppData\Local\nvim
rm -Force ~'AppData\Local\nvim-data

```

--------------------------------

### Disable Mappings

Source: https://nvchad.com/docs/config/mappings

Use `vim.keymap.del` to remove existing key mappings in specified modes.

```lua
local nomap = vim.keymap.del

nomap("i", "<C-k>")
nomap("n", "<C-k>")
```

--------------------------------

### Disable Tab Key Mapping in NvChad

Source: https://nvchad.com/docs/faq

This Lua snippet disables the default mapping for the Tab key in Neovim, which is often necessary to resolve conflicts when customizing key mappings in NvChad.

```lua
-- Disable mappings
local nomap = vim.keymap.del

nomap("n", "<tab>")

```
Tokens:
Raw