Awesome

Table of Contents <!-- omit in toc -->

• Screenshots 📷
• Installation ⚡
  • LaTeX
  • Language Servers
• Update 🚀
• Features 📃
  • General
  • LaTeX
  • Folder Structure
  • Plugins Used
  • Mappings
• Todo ✔

Screenshots 📷

Installation ⚡

The following instructions are for Windows (powershell). An admin prompt is required.

1. Install chocolatey.

   Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
   

2. Install main dependencies.

   choco install -y git.install --params "/GitAndUnixToolsOnPath /NoGitLfs /SChannel /NoShellIntegration";
   choco install -y neovim python SumatraPDF.install miktex.install;
   # Needed for various plugins
   choco install -y universal-ctags strawberryperl make SQLite ripgrep fd golang; refreshenv; exit
   

3. Install python dependencies.

   pip install pynvim neovim-remote
   

4. Clone the repository and open nvim-qt or nvim.

   For fresh installation:

   git clone https://github.com/Neelfrost/nvim-config.git "$HOME\Appdata\Local\nvim"; nvim-qt.exe
   

   For existing config:

   ren "$HOME\Appdata\Local\nvim" 'nvim-old'; git clone https://github.com/Neelfrost/nvim-config.git "$HOME\Appdata\Local\nvim"; nvim-qt.exe
   

LaTeX

Formatting (latexindent)

latexindent is now included with miktex, so downloading it separately is no longer necessary. Moreover, null-ls is pre-configured to run latexindent on save for tex files. Global formatting rules can be changed by:

1. Creating $HOME/indentconfig.yaml:

   paths:
     - C:\Users\<username>\defaultSettings.yaml
   

2. Creating $HOME/defaultSettings.yaml, followed by copying and overriding defaultSettings.

For further reading refer: docs.

Viewing PDF

To launch SumatraPDF using VimTeX (<kbd>\lv</kbd>), ensure SumatraPDF.exe is added to environment path.

Set-ItemProperty -Path 'Registry::HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment' -Name path -Value $((Get-ItemProperty -Path 'Registry::HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment' -Name path).path + ";" + "$HOME\AppData\Local\SumatraPDF" + ";"); refreshenv; exit

Inverse Search

For inverse search, open SumatraPDF then go to Settings -> Options and set inverse search command-line to:

cmd /c start /min nvim --headless -c "PackerLoad vimtex" -c "VimtexInverseSearch %l '%f'"

Use :checkhealth to check for errors if any.

Language Servers

Python (pyright)

1. Install npm.

   choco install -y nodejs.install; refreshenv; exit
   

2. Install pyright.

   npm install -g pyright
   

3. Install black, isort, and flake for formatting and linting.

   pip install flake8 black isort
   

4. Use :checkhealth to check for errors if any.

Lua (LuaLs)

1. Install dependencies.

   choco install -y 7zip.install; refreshenv; exit
   

2. cd into install directory. For example:

   cd C:\tools
   

3. Install LuaLs.

   curl.exe -L $(curl.exe -s https://api.github.com/repos/LuaLS/lua-language-server/releases/latest | findstr.exe "win32-x64" | %{"$($_.Split('"')[3])"} | findstr.exe "github") -o luals.zip; 7z.exe x .\luals.zip -olua-language-server; rm luals.zip
   

4. Add LuaLs to environment path.

   Set-ItemProperty -Path 'Registry::HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment' -Name path -Value $((Get-ItemProperty -Path 'Registry::HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment' -Name path).path + ";" + "C:\tools\lua-language-server\bin" + ";"); refreshenv; exit
   

5. Install stylua for formatting.

   curl.exe -L $(curl.exe -s https://api.github.com/repos/JohnnyMorganz/StyLua/releases/latest | findstr.exe "win64.zip" | %{"$($_.Split('"')[3])"} | findstr.exe "github") -o stylua-win64.zip; 7z.exe x -oC:\tools\stylua .\stylua-win64.zip; rm .\stylua-win64.zip;
   # Add stylua to environment path:
   Set-ItemProperty -Path 'Registry::HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment' -Name path -Value $((Get-ItemProperty -Path 'Registry::HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment' -Name path).path + ";" + "C:\tools\stylua" + ";"); refreshenv; exit
   

6. Use :checkhealth to check for errors if any.

C# (omnisharp)

1. Install dotnet-sdk.

   choco install dotnet-sdk -y
   

2. Install omnisharp-roslyn.

   curl.exe -L $(curl.exe -s https://api.github.com/repos/OmniSharp/omnisharp-roslyn/releases/latest | findstr.exe "omnisharp-win-x64-net6.0.zip" | %{"$($_.Split('"')[3])"} | findstr.exe "github") -o omnisharp-win-x64-net6.0.zip; 7z.exe x -oC:\tools\omnisharp .\omnisharp-win-x64-net6.0.zip; rm .\omnisharp-win-x64-net6.0.zip;
   

3. Use :checkhealth to check for errors if any.

HTML, CSS, Javascript (vscode-langservers-extracted)

1. Install dependencies.

   npm i -g vscode-langservers-extracted
   

2. Install prettierd for formatting.

   npm i -g @fsouza/prettierd
   

3. Use :checkhealth to check for errors if any.

Update 🚀

1. Pull changes.

   cd "$HOME\Appdata\Local\nvim"; git pull
   

2. Open nvim-qt or nvim and update plugins:

   :PackerSync
   

Features 📃

General

• Smart display line movement.
• Resume cursor position when re-opening a file.
• Auto update file if changed outside of neovim.
• Fix mixed indents (tabs are converted to spaces).
• Persistent cursor positions when switching buffers.
• Ability to search custom directories in telescope.nvim.
• Ability to reload specific modules using telescope.nvim.
• Automatically trim trailing whitespaces and newlines on save.
• Search and replace selection (automatically escape special chars).
• Open windows terminal, vscode, explorer at current directory using <kbd>\\t</kbd>, <kbd>\\c</kbd>, <kbd>\\e</kbd> respectively.

LaTeX

• Extensive snippets for LaTeX.
• Better auxiliary file cleaner.
• Null-ls: latexindent, chktex support.
• Automatically substitute \ in imports (include, input) with / on save.
• Keybinds for bold, underline, math, chemical formula environments.
• Start newline with \item (or \task) if inside a list environment when pressing <kbd>Enter</kbd>, <kbd>o</kbd> or <kbd>O</kbd>.

Folder Structure

nvim
├── after
│   └── ftplugin         # filetype specific options, settings, mappings
├── lua                  # .lua config files
│   └── user
│       └── mappings.lua # keybinds
│       └── options.lua  # vim options
│       └── utils.lua    # utility functions
│       └── plugins
│           ├── config   # plugin config
│           └── init.lua # plugin definition file
├── ultisnips            # snippets
│   └── tex              # latex snippets
└── viml                 # .vim config files

Plugins

• Plugin manager: lazy.nvim

LSP

• LSP: nvim-lspconfig
  • Diagnostics, formatting LSP: null-ls.nvim
  • Python language server: pyright
  • C# language server: omnisharp
  • Lua language server: LuaLs
  • HTML, CSS, Javascript language server: (vscode-langservers-extracted)
  • Function signature when typing: lsp_signature.nvim
  • Refactor functionality: refactoring.nvim
  • Backup code formatting: neoformat

File navigation

• File explorer: neo-tree.nvim
• Fuzzy finder: telescope.nvim
  • Telescope frecency picker: telescope-frecency.nvim
  • Telescope fzf sorter: telescope-fzf-native.nvim
  • Telescope ultisnips viewer: telescope-ultisnips.nvim

Code completion

• Code completion: nvim-cmp
  • Ultisnips source: cmp-nvim-ultisnips
  • LSP source: cmp-nvim-lsp
  • Buffer source: cmp-buffer
  • Path source: cmp-path
  • Cmdline source: cmp-cmdline
  • Omni source (for vimtex): cmp-omni

LaTeX

• LaTeX support: vimtex
• Snippet engine: ultisnips
• Tag management: vim-gutentags

Looks

• Theme support: themer.lua
• Indent lines: indent-blankline.nvim
• Thin virtual column: virt-column.nvim
• Icons support: nvim-web-devicons
• Syntax highlighting: nvim-treesitter
• Colored matching brackets: nvim-ts-rainbow2
• Color preview: vim-hexokinase
• Prettier folds: pretty-fold.nvim

Buffer, Status

• Bufferline: cokeline.nvim
• Statusline: heirline.nvim

QOL

• Repeat actions: vim-repeat
• Faster navigation: hop.nvim
• Better quickfix: nvim-pqf
• Aligning: vim-easy-align
• Commenting: nvim-comment
• Toggle booleans & more: alternate-toggler
• Multiple cursors: vim-visual-multi
• Title Case: vim-titlecase
• Start screen: alpha-nvim
• Auto pair brackets: auto-pairs
• Bracket operations: nvim-surround
• Startup time: vim-startuptime
• Fix cursorhold autocmd: FixCursorHold.nvim
• Fast expr folds: FastFold
• Markdown preview: markdown-preview.nvim
• Run commands asynchronously: asyncrun.vim
• Session manager: neovim-session-manager
• Annotation generator: neogen

Mappings

Todo ✔

• Improve mappings table
• Document snippets
• Automatic install script
• Create video to showcase snippets