235 lines
9.3 KiB
Markdown
235 lines
9.3 KiB
Markdown
[](https://github.com/marketplace/actions/super-linter)
|
|
|
|
An attempt to make neovim (cli version) as functional as an IDE while being very eyecandy.
|
|
|
|
# Screenshots -
|
|
|
|
<img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/initialNvim.png"><hr>
|
|
<kbd><img src ="https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimRice2.png"></kbd><hr>
|
|
|
|
# Very Useful lua plugins used in my config -
|
|
|
|
#### lspkind-nvim
|
|
|
|
This tiny plugin adds vscode-like pictograms to neovim built-in lsp completion items :
|
|
|
|
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/lspkind.png"></kbd><hr>
|
|
|
|
#### nvim-tree.lua
|
|
|
|
fast file tree :
|
|
|
|
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvimtree.png"></kbd><hr>
|
|
|
|
### telescope-nvim -
|
|
|
|
A fuzzy file finder, picker, sorter, previewer and much more:
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/tel.png"></kbd>
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/telmedia.png"></kbd><hr>
|
|
|
|
### indent-blankline.nvim -
|
|
|
|
adds indentline :
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineNvim.png"></kbd>
|
|
|
|
using indenLine plugin on left and blanklineNvim on right
|
|
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/blanklineVSindentline.png"></kbd>
|
|
|
|
### galaxyline -
|
|
|
|
fastest statusline plugin I've used so far:
|
|
<kbd><img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/statusline.png"></kbd><hr>
|
|
|
|
### gitsigns.nvim -
|
|
|
|
Shows git signs of a repo on the signcolumn to indicate diffs/changes etc (needs plenary.nvim)
|
|
|
|
<hr>
|
|
|
|
### nvim-bufferline.lua -
|
|
|
|
As a top bufferline like thing which lets me handle tabs like switching, closing tabs.
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/bufferline.png"></kbd>
|
|
|
|
<hr>
|
|
|
|
### nvim-web-devicons -
|
|
Lua fork of vim devicons which lets me change icons of filetypes
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/image.png"></kbd><hr>
|
|
|
|
### nvim-treesitter
|
|
Better syntax highlighting for programming languages ( my config just has html,css,js support for now ).
|
|
|
|
without / with Treesitter :
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/woTree.png"></kbd>
|
|
|
|
### nvim-base16 -
|
|
|
|
contains a collection of all base16 themes for vim , plugin written in lua (comparison of base16-vim and nvim-base16):
|
|
|
|
nvim-base16 doesnt even take time to load unlike base16-vim which was eating half of the loadup time! ( the below screenshot was taken and tested on my old pentium laptop , so results might differ)
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvim-base16.png"></kbd><hr>
|
|
|
|
(neovim loads pretty fast on ssds)
|
|
|
|
<kbd> <img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/nvim-startup.png"></kbd><hr>
|
|
|
|
# Config structure
|
|
|
|
```
|
|
nvim
|
|
├──init.lua
|
|
└──lua
|
|
└──anything.lua
|
|
```
|
|
|
|
- The init.lua is used instead of init.vim.
|
|
- The lua folder contains modules ( config files ) , in the example above anything.lua file in lua folder could be considered as a module.
|
|
- The anything.lua file is supposed to have any neovim config written in lua , its like splitting the overall config into small bits and make it more organized , like one module for highlights and colors , another one for statusline and so on!.
|
|
- To load or source that "anything" module (like making it load with init.lua ) ,add this is in init.lua : require "anything".
|
|
|
|
# Features
|
|
|
|
- File navigation with Nvimtree
|
|
- mouse works
|
|
- managing tabs with bufferline
|
|
- autosave
|
|
- icons on nvimtree , telescope , bufferline/statusline and almost everywhere! with nvim-web-devicons
|
|
- minimal status line ( galaxyline)
|
|
- gitsigns (colored bars in my config)
|
|
- using nvim-lsp
|
|
- nvim-lspconfig for nvim-lps configuration
|
|
- nvim-compe for autocompletion
|
|
- lspkind to show pictograms on autocompletion items
|
|
- telescope for file finding , picking , previewing (files and even images)
|
|
- nvim-treesitter for syntax highlighting
|
|
- nvim-autopairs , for autolosing braces and stuffs
|
|
- neoformat for prettifying / formatting code
|
|
- packer.nvim as package manager
|
|
- indent-blankline.Nvim for indentlines
|
|
- smooth scrolling
|
|
- Snip support from VSCode through vsnip supporting custom and predefined snips (friendly-snippets)
|
|
|
|
# Guides to migrate your nvim configs to init.lua -
|
|
|
|
- https://github.com/nanotee/nvim-lua-guide
|
|
|
|
- https://alpha2phi.medium.com/neovim-init-lua-e80f4f136030
|
|
|
|
- https://oroques.dev/notes/neovim-init/
|
|
|
|
- https://icyphox.sh/blog/nvim-lua/
|
|
|
|
- https://github.com/rafamadriz/friendly-snippets/wiki
|
|
|
|
# Clone my setup -
|
|
|
|
- Install neovim-nightly , also use a nerdfont on your terminal.
|
|
- Use these [colors](https://github.com/siduck76/dotfiles/blob/master/thinkpad/.Xresources) for your terminal , Its in xresources format so it'd would be easier to use a terminal that supports xresources like st , urxvt , xterm , My [st build](https://github.com/siduck76/st).
|
|
- run the install.sh (this might work only on nix systems),this opens neovim (press enter or y to skip the errors , the errors will only show once).
|
|
- Install ripgrep , fd , ueberzug for telescope media extension to work.
|
|
|
|
- Manual installation , incase the install.sh doesnt work for you :
|
|
|
|
- Install packer.nvim
|
|
|
|
```
|
|
|
|
git clone https://github.com/wbthomason/packer.nvim\
|
|
~/.local/share/nvim/site/pack/packer/start/packer.nvim
|
|
|
|
```
|
|
|
|
- copy lua folder and init.lua into ~/.config/nvim
|
|
- Open neovim and install all plugins , :PackerInstall (let treesitter install all its extensionsm
|
|
- Install language servers and prettier ( for autocompletion etc and code formatting , nodejs should be installed too!) , this usually depends on the language support you want to add in your neovim config.
|
|
|
|
```
|
|
npm config set prefix=~/.node_modules
|
|
npm install -g vscode-html-languageserver-bin typescript typescript-language-server vscode-css-languageserver-bin prettier
|
|
|
|
(ADD ~/.node_modules/bin at your PATH)
|
|
```
|
|
|
|
To setup any language server , follow this guide https://github.com/neovim/nvim-lspconfig/blob/master/CONFIG.md and search up the needed LSP. For example if I needed clangd's lsp server :
|
|
|
|
<kbd>
|
|
<img src = "https://raw.githubusercontent.com/siduck76/dotfiles/master/rice%20flex/clang.png">
|
|
</kbd>
|
|
|
|
I'd install it first and add its setup line :
|
|
`` -- in /lua/nvim-lspconfig/lua.lua file
|
|
|
|
require'lspconfig'.clangd.setup{} ``
|
|
|
|
# Default Mappings
|
|
|
|
<kbd> space </kbd> is the **leader** key.
|
|
|
|
- Opening terminals!
|
|
- <kbd> Ctrl </kbd> <kbd> l </kbd> Open terminal vertically over right
|
|
- <kbd> Ctrl </kbd> <kbd> x </kbd> Open terminal horizontally below the current window
|
|
|
|
- **File tree (nvim-tree)**
|
|
|
|
- <kbd> Ctrl </kbd> <kbd> n </kbd> toggle neovim tree
|
|
|
|
- <kbd> Shift </kbd> <kbd> h </kbd> show hidden files (use these keybinds when cursor's in the filetree, same for the keybinds below).
|
|
- <kbd> Ctrl </kbd> + <kbd> v </kbd> open files in vertical split
|
|
- <kbd> Ctrl </kbd> + <kbd> x </kbd> open files in horizontal split
|
|
|
|
- **Toggling stuffs**
|
|
|
|
- leader + <kbd> n </kbd> toggle line number
|
|
- leader + <kbd> z </kbd> toggle truezen.nvim's Ataraxis mode
|
|
- leader + <kbd> m </kbd> toggle truezen.nvim's minimalistic mode
|
|
|
|
- **Copy text**
|
|
|
|
- <kbd> Ctrl </kbd> <kbd> a </kbd> copies everything in the current file
|
|
- select any text + <kbd> y </kbd> copies the selected text
|
|
|
|
- **Telescope**
|
|
|
|
- leader + <kbd> f </kbd> <kbd> b </kbd> open all buffers
|
|
- leader + <kbd> f </kbd> <kbd> f </kbd> find files in the current DIR
|
|
- leader + <kbd> f </kbd> <kbd> o </kbd> open recently edited files
|
|
- leader + <kbd> f </kbd> <kbd> h </kbd> opens up a help page like thing
|
|
- <kbd> Ctrl </kbd> + <kbd> v </kbd> open files in vertical split
|
|
- <kbd> Ctrl </kbd> + <kbd> x </kbd> open files in horizontal split
|
|
|
|
- **Formatting code**
|
|
|
|
- leader + <kbd> f </kbd> <kbd> m </kbd> formats or beautifies the code in current window via neoformat
|
|
(currently only html ,css , js can be formatted . To be able to use this keybind you need to install the formatter locally for your language , in my case prettier was required only so I installed it. check (this)[https://github.com/sbdchd/neoformat].
|
|
|
|
- **Neoscroll**
|
|
|
|
- `<C-u>`, `<C-d>`, `<C-b>`, `<C-f>`, `<C-y>` and `<C-e>` : Smooth scrolling for window movement commands.
|
|
|
|
- **Managing tabs with bufferline!**
|
|
|
|
- <kbd> TAB </kbd> or <kbd> Shift TAB </kbd> cycle through opened tabs
|
|
- <kbd> Shift </kbd> <kbd> x </kbd> close current tab
|
|
- <kbd> Shift </kbd> <kbd> t </kbd> open new tab
|
|
|
|
**Nvim-lspconfig (major ones)**
|
|
- <kbd> K </kbd> hover and show the definition
|
|
- <kbd> gd </kbd> jumps to the definition (works for user and language definitions)
|
|
- <kbd> [d </kbd> jumps to the previous error
|
|
- <kbd> ]d </kbd> jumps to the next error
|
|
- leader <kbd> D </kbd> jumps to the definition
|
|
- leader <kbd> w </kbd> + <kbd> q </kbd>list all the errors in a new buffer
|
|
- leader <kbd> r </kbd> + <kbd> n </kbd> rename all instances of this definition (user functions and declaration)
|
|
-
|
|
# TODO
|
|
|
|
- Make the statusline more elegant.
|
|
- Add more themes.
|
|
|
|
# Contact -
|
|
|
|
- My linux / unix related ricing community: https://t.me/DE_WM (telegram)
|
|
- Me: @siduck (telegram)
|