https://github.com/niksingh710/nvim-tips
A readme projects with tips that i and the community feels to be passed on.
https://github.com/niksingh710/nvim-tips
Last synced: 2 months ago
JSON representation
A readme projects with tips that i and the community feels to be passed on.
- Host: GitHub
- URL: https://github.com/niksingh710/nvim-tips
- Owner: niksingh710
- License: mit
- Created: 2023-09-06T09:00:19.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-09-06T16:58:13.000Z (over 1 year ago)
- Last Synced: 2024-12-26T14:12:18.575Z (4 months ago)
- Size: 1.07 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tips for nvim native users.
- [Lua](#lua)
- [Vim Api](#vim-api)
- [Telescope](#telescope-tips)
- [Cmdline](#cmdline)
- [Tmux](#tmux)
- [Mappings](#mapping)
- [Telescope and NvimTree](#telescope-and-nvimtree)
- [Plugins](#plugins)
## Lua
Lua is the primary configuration language of Neovim, so some basic knowledge is a prerequisite. A good place to start is the guide from the [NvChad Docs](https://nvchad.com/docs/quickstart/learn-lua).
## Vim Api
Understanding some of the internal functions and variables in Vim can be quite helpful for enhancing your productivity. One particularly powerful function is `vim.inspect`.
This function allows you to neatly display Lua tables in a well-formatted manner.
This makes it significantly easier to comprehend the contents and values within the table, aiding you in gaining a clearer understanding of the data structure.
```lua
local tbl = {
name = "sid",
age = 20,
isAlive = true,
colors = { "red", "green", "blue" },
}
vim.inspect(tbl)
-- output
--[[
{
age = 20,
colors = {
1 = "red",
2 = "green",
3 = "blue",
},
isAlive = true,
name = "sid",
}
]]--
```
## Telescope Tips
Let's make our telescope look like a bit nicer (NvChad and Nyoom do this)
here we will do it for our nvim config.
| Before | After |
| -------------------------------------------------- | ------------------------------------------------ |
|  |  |
This has been done by changing nvim highlight groups.
I love using `tokyodark.nvim` theme you can find it [here](https://github.com/tiagovla/tokyodark.nvim)
I will be using this theme to change the highlight groups.
```lua
-- I used vim.inspect to get color palette from tokyodark.nvim
-- vim.inspect(require("tokyodark.palette"))
local colors = require("tokyodark.palette")
local TelescopeColor = {
TelescopeMatching = { fg = colors.orange },
TelescopeSelection = { fg = colors.fg, bg = colors.bg1, bold = true },
TelescopePromptPrefix = { bg = colors.bg1 },
TelescopePromptNormal = { bg = colors.bg1 },
TelescopeResultsNormal = { bg = colors.bg0 },
TelescopePreviewNormal = { bg = colors.bg0 },
TelescopePromptBorder = { bg = colors.bg1, fg = colors.bg1 },
TelescopeResultsBorder = { bg = colors.bg0, fg = colors.bg0 },
TelescopePreviewBorder = { bg = colors.bg0, fg = colors.bg0 },
TelescopePromptTitle = { bg = colors.purple, fg = colors.bg0 },
TelescopeResultsTitle = { fg = colors.bg0 },
TelescopePreviewTitle = { bg = colors.green, fg = colors.bg0 },
}
for hl, col in pairs(TelescopeColor) do
vim.api.nvim_set_hl(0, hl, col)
end
```
Putting this much in your config will change your telescope look completly.
If you want this to be a theme independent you can define your own colors and use them.
```lua
local colors = {
bg = "#282c34",
fg = "#abb2bf",
yellow = "#e0af68",
cyan = "#56b6c2",
darkblue = "#081633",
green = "#98c379",
orange = "#d19a66",
violet = "#a9a1e1",
magenta = "#c678dd",
blue = "#61afef",
red = "#e86671",
}
local TelescopeColor = {
TelescopeMatching = { fg = colors.orange },
TelescopeSelection = { fg = colors.fg, bg = colors.bg, bold = true },
TelescopePromptPrefix = { bg = colors.bg },
TelescopePromptNormal = { bg = colors.bg },
TelescopeResultsNormal = { bg = colors.bg },
TelescopePreviewNormal = { bg = colors.bg },
TelescopePromptBorder = { bg = colors.bg, fg = colors.bg },
TelescopeResultsBorder = { bg = colors.bg, fg = colors.bg },
TelescopePreviewBorder = { bg = colors.bg, fg = colors.bg },
TelescopePromptTitle = { bg = colors.purple, fg = colors.bg },
TelescopeResultsTitle = { fg = colors.bg },
TelescopePreviewTitle = { bg = colors.green, fg = colors.bg },
}
for hl, col in pairs(TelescopeColor) do
vim.api.nvim_set_hl(0, hl, col)
end
```
This is from an comment on reddit [post](https://www.reddit.com/r/neovim/comments/xcsatv/how_can_i_configure_telescope_to_look_like_this/)
## Cmdline
You can use [noice.nvim](https://github.com/folke/noice.nvim) from folke.
But if you want a minimal feel with full vim like editing in cmdline.
try `q:` this will open a buffer with all your history and you can edit it like a normal buffer.
and pressing `` on the line hovered will execute it.
if you like `q:` then below are a few mappings and options you may like
```lua
vim.opt.cmdwinheight = 1,
vim.opt.cmdheight = 0,
vim.opt.wildcharm = ("\t"):byte() -- so that tab key can be remapped
vim.keymap.set("c", ":", "q:", {})
vim.keymap.set("n", ":", "q:i", {})
vim.keymap.set("c", "", "", {})
vim.keymap.set("c", "", "", {})
```
## Tmux
You use tmux then there are a few tips that may enhance your experience.
[vim-tmux-navigator](https://github.com/christoomey/vim-tmux-navigator) is a plugin that allows you to navigate between vim and tmux panes seamlessly.
Mappings in `tmux.conf`
```tmux
# christoomey Mappings {{{
# Smart pane switching with awareness of vim and fzf
forward_programs="view|n?vim?|fzf|lvim"
should_forward="ps -o state= -o comm= -t '#{pane_tty}' |\
grep -iqE '^[^TXZ ]+ +(\\S+\\/)?g?($forward_programs)(diff)?$'"
bind -n C-h if-shell "$should_forward" "send-keys C-h" "select-pane -L"
bind -n C-j if-shell "$should_forward" "send-keys C-j" "select-pane -D"
bind -n C-k if-shell "$should_forward" "send-keys C-k" "select-pane -U"
bind -n C-l if-shell "$should_forward" "send-keys C-l" "select-pane -R"
bind -n C-\\ if-shell "$should_forward" "send-keys C-\\" "select-pane -l"
# }}}
```
Now you can switch focus between panes using `c-h,c-j,c-k,c-l`
## Mapping
```lua
-- This fn will allow you to map easily
map = function(mode, mappings, opts)
-- enabled easy mapping syntax
-- local mapping = {
-- ["jk"] = "",
-- [""] = { ":w", "Save" },
-- }
-- map( "n", mapping, {})
for k, v in pairs(mappings) do
opts = opts or {}
local default = {
noremap = true,
silent = true,
}
opts = vim.tbl_deep_extend("force", default, opts)
local value = v
local desc = ""
if type(v) == "table" then
value, desc = v[1], v[2]
end
opts["desc"] = desc
vim.keymap.set(mode, k, value, opts)
end
end
-- Some Mappings you may find usefull.
local normal = {
[""] = { "w", "Save the file" },
[""] = { "h", "Focus on right split" },
[""] = { "j", "Focus on below split" },
[""] = { "k", "Focus on up split" },
[""] = { "l", "Focus on left split" },
[""] = { ":resize -1", "Resize down" },
[""] = { ":resize +1", "Resize up" },
[""] = { ":vertical resize -1", "Resize right" },
[""] = { ":vertical resize +1", "Resize left" },
[""] = { "", "Increase Number" }, [""] = { "", "Decrease Number" },
[""] = { ":m .+1==", "Move line Down" },
[""] = { ":m .-2==", "Move line up" },
[""] = { ":bprevious", "Buffer Previous" },
[""] = { ":bnext", "Buffer Next" },
["q"] = { ":quit!", "Quit!" },
-- ["c"] = { ":bd!", "Close!" },
["c"] = { "lua utils.close_buffer()", "Close!" }, -- Custom fn to ensure if this is the last buffer then quit nvim
["h"] = { ":nohl", "No Highlight!" },
["a"] = { "gg0vG$", "Select All" },
["vv"] = { "vsplit", "vertical split" },
["vs"] = { "split", "horizontal split" },
["tj"] = { "tabn", "Next Tab" },
["tk"] = { "tabp", "Previous Tab" },
["tl"] = { "tabn", "Next Tab" },
["th"] = { "tabp", "Previous Tab" },
["tq"] = { "tabclose", "Close Tab" },
["tn"] = { "tabnew", "New Tab" },
---@diagnostic disable-next-line: undefined-global
[""] = { utils.filetypeSet, "Set Filetype" },
-- highlight are in center
["n"] = "nzzzv",
["N"] = "Nzzzv",
["x"] = '"_x',
}
local insert = { -- as these are insert mode mapping they don't need descriptions
["jk"] = "",
-- ["kj"] = "",
[""] = "", -- Copilot unmaps esc in insert mode
[""] = ":w",
[""] = ":m .+1==gi",
[""] = ":m .-2==gi",
}
local visual = {
[""] = ":w",
[""] = "",
[""] = ":m '>+1gv-gv",
[""] = ":m '-2gv-gv",
["<"] = ""] = ">gv",
[""] = "",
["x"] = '"_x',
["p"] = '"_dP',
["P"] = '"_dP',
["y"] = '"+y',
["d"] = '"+d',
["Y"] = 'gg"+yG',
["D"] = 'gg"+dG',
["x"] = '"+x',
["X"] = '"+',
}
map("n", normal)
map("i", insert)
map("x", visual)
```
## Telescope and Nvimtree
If you use these two plugins you may be finding it annoying when opening your file from home directory.
And then using `Telescope find_files` to find out it is searching in home dir instead of the buffer path.
The solution i came up with is a fn that will change the dir to the current buffer.
```lua
local set_currdir = function()
local curdir = vim.fn.expand("%:p:h")
vim.api.nvim_set_current_dir(curdir)
end
vim.keymap.set("", set_currdir, {})
```
Now i just press `leader` and location of Telescope and nvim tree changes to current buffer
## Plugins
Not mentioning plugins like lsp, null-ls (rn Archieved), telescope, treesitter, etc. as you will eventully face them.
- [nvim-surround](https://github.com/kylechui/nvim-surround) At first will fea like a gimmick but once you get used to it you will love it.
- [firenvim](https://github.com/glacambre/firenvim) Brwoser and nvim integration. I use it for editing text in browser. Get your neovim config in browser text boxes.
- [vimium-c](https://github.com/gdh1995/vimium-c) Browser extension to use vim like keys in browser.