Skip to content

johnarumemi/nvim

BranchesTags

Repository files navigation

NVIM config

This is just a repo that stores my nvim configuration

TODO: update this for use with Lazy.

TODO Items

Useful links

Uninstall

See lazyvim github for uninstall instructions.

You can also delete directories via:

rm -rf ~/.local/share/nvim
rm -rf ~/.cache/nvim
rm -rf ~/.local/state/nvim

or move them instead (backups):

mv ~/.local/share/nvim{,.bak}
mv ~/.cache/nvim{,.bak}
mv ~/.local/state/nvim{,.bak}

Swap files

These can be found at:

cd ~/.local/state/nvim/swap/

Installation

Requirements

  • Yarn
npm install --global yarn
  • Luarocks
brew install luarocks
  • Stylua
brew install stylua

Alternatively Mason should install it for you.

Manual Steps / Caveats

Add mason/bin to your $PATH environment variable. This is to enable finding executables installed by Mason.

# .zprofile

# Neovim Mason bin directory
export PATH="$HOME/.local/share/nvim/mason/bin:$PATH"

Tagbar plugin

For this plugin to work (especially with rust) you should install the universal ctags binary. It conflicts with exuberant ctags and should be installed using the instructions below.

https://github.com/universal-ctags/homebrew-universal-ctags

See wiki for how to set this up.

Note that if you have exuberant-ctags etc installed, this conflicts with universal-ctags, since installing universal-ctags creates / aliases $(brew --prefix)/bin/ctags.

brew uninstall ctags 
brew install universal-ctags

Fonts

https://www.nerdfonts.com/font-downloads

https://gist.github.com/davidteren/898f2dcccd42d9f8680ec69a3a5d350e?permalink_comment_id=4058108#gistcomment-4058108

brew tap homebrew/cask-fonts && \
brew install --cask font-inconsolata-nerd-font && \
brew install --cask font-inconsolata-lgc-nerd-font && \
brew install --cask font-roboto-mono-nerd-font && \
brew install --cask font-droid-sans-mono-nerd-font && \
brew install --cask font-hack-nerd-font && \
brew install --cask font-jetbrains-mono-nerd-font

VS Code Integration

Disabled Plugins

The following plugins are disabled when using Neovim within VS Code:

UI Plugins:

  • bufferline: Tab management is handled by VS Code's interface
  • dashboard-nvim: Start screen is redundant with VS Code
  • lualine: Status line is not needed as VS Code has its own
  • nvim-notify: Notifications are handled by VS Code
  • nvim-tree: File explorer is provided by VS Code

Editor Plugins:

  • gitsigns.nvim: Git decorations are managed by VS Code
  • telescope: File searching is handled by VS Code
  • which-key: Conflicts with VS Code's keyboard shortcuts
  • markdown-preview.nvim: VS Code has built-in markdown preview
  • markdown-toc.nvim: Not needed in VS Code
  • nvim-treesitter: VS Code has its own syntax highlighting

LSP & Completion:

  • nvim-lspconfig: VS Code has its own LSP implementation
  • mason.nvim & mason-lspconfig.nvim: LSP server management not needed
  • nvim-cmp: Conflicts with VS Code's IntelliSense
  • conform.nvim: VS Code has its own formatters

Language-Specific Plugins:

  • rustaceanvim: VS Code has rust-analyzer extension
  • crates.nvim: VS Code has Cargo extension support
  • clangd_extensions.nvim: VS Code has C++ LSP support
  • cmake-tools.nvim: VS Code has CMake extension
  • typescript-tools.nvim: VS Code has TypeScript LSP support

Development Tools:

  • nvim-dap: VS Code has its own debugger
  • neotest: VS Code has its own testing framework

AI Plugins (currently disabled everywhere):

  • copilot.lua, copilot-cmp, copilot-lualine: Disabled globally
  • CopilotChat.nvim: Disabled globally

What's Still Active in VS Code Mode

When using Neovim within VS Code, only core editing features remain active:

Active:

  • ✅ Core Neovim keybindings and motions
  • ✅ Text editing plugins (autopairs, comments, etc.)
  • ✅ mini.indentscope: Visual indent guides

Provided by VS Code:

  • Syntax highlighting (TextMate grammars / Treesitter)
  • LSP features (completion, diagnostics, go-to-definition, etc.)
  • Formatting and linting
  • Debugging (DAP)
  • Testing frameworks
  • File navigation and search
  • Git integration
  • Terminal functionality
  • UI elements (statusline, tabs, notifications)

Copilot

See :help copilot for further information.

NOTE: This plugin qequires node >= v18.

Other resources:

CopilotChat

Commands:

:CopilotChat <input>? - Open chat window with optional input
:CopilotChatOpen - Open chat window
:CopilotChatClose - Close chat window
:CopilotChatToggle - Toggle chat window
:CopilotChatStop - Stop current copilot output
:CopilotChatReset - Reset chat window
:CopilotChatSave <n>? - Save chat history to file
:CopilotChatLoad <n>? - Load chat history from file
:CopilotChatDebugInfo - Show debug information

Commands coming from default prompts:

:CopilotChatExplain - Write an explanation for the active selection as paragraphs of text
:CopilotChatReview - Review the selected code
:CopilotChatFix - There is a problem in this code. Rewrite the code to show it with the bug fixed
:CopilotChatOptimize - Optimize the selected code to improve performance and readability
:CopilotChatDocs - Please add documentation comment for the selection
:CopilotChatTests - Please generate tests for my code
:CopilotChatFixDiagnostic - Please assist with the following diagnostic issue in file
:CopilotChatCommit - Write commit message for the change with commitizen convention
:CopilotChatCommitStaged - Write commit message for the change with commitizen convention

DAP

Mason

This is a package manager that is used for managing various development tools: it can be installed and managed via Lazy. Development tools can include LSP servers, which perform static analysis on the code sent into it by an LSP client.

nvim-lspconfig

Neovim natively supports LSP clients, and provides a framework called vim.lsp for developing LSP clients to communicate with an LSP server. nvim-lspconfig is simply a plugin that holds the configurations for the neovim lsp client to communicate with various lsp servers. The key word, as highlighted, is that it is configuring the inbuilt native lsp client to communicate with specific lsp servers: it is not the nvim lsp client itself!

mason-lspconfig

So we have mason that can install various LSP servers, Neovim with an in-built LSP client for communicating with a server and finally, nvim-lspconfig for actually holding configurations for how the inbuilt LSP client can be configured to communicate with a specific LSP server. mason-lspconfig acts as a bridge between mason and nvim-lspconfig. It says "Hey! nvim-lspconfig has been configured to communicate with the rust-analyzer lsp server! lets use mason to ensure this server is installed, if it is not installed, we can install it with mason!".

package names

Now mason might have a package name for a given server, and then lspconfig will have a config for a given server. The names between of the actual server may differ between the lspconfig server name and the mason package name for the server to be installed / communicated with. mason-lspconfig will translate between the server names provided by lspconfig to the mason package names (e.g. sumneko_lua <-> lua-language-server = lspconfig name <-> mason package name)

In the api's that mason-lspconfig uses, you should specify configurations against an lsp client config or lsp server using the lspconfig name, not the mason package name.

useful help docs

:h mason-lspconfig-automatic-server-setup
:h mason-lspconfig-settings
:h mason-lspconfig-server-map

How-to

General helpful guidance.

Finding file type

You can find the filetype ("dapui_watches", "dapui_breakpoints", etc.) by moving the cursor to the window in question and running :echo &ft

Changing highlights

Move your cursor under the text you want to alter the highlight. Enter command mode and use :Inspect to get the name of group.

Example:

:Inspect

# Output

Treesitter
  - @spell.markdown links to @spell markdown
  - @markup.italic.markdown links to @markup.italic markdown
  • group name = @markup.italic.markdown
  • highlight group linked to = @markup.italic

So if we want to create a new custom highlight group we can use the following:

vim.cmd([[ highlight CustomItalic guifg=cyan gui=italic ]])

Above creates a highlight group called CustomItalic.

We now need to link the treesitter group to it:

vim.cmd([[
  autocmd FileType markdown
  highlight link @markup.italic.markdown CustomItalic
]])

Above creates an autocommand triggered on entering a markdown file. The autocommand will then call the following command: :highlight link @markup.italic.markdown CustomItalic

Troubleshooting

Corrupted Sessions

Sometimes sessions are corrupted, and while there might be better ways of resolving this; for now the best way is to just delete sessions found in ~/.local/share/nvim/sessions/

rust-analyzer issues

Rust-analyzer only supports the stable toolchain. If you have an override in place from using rustup default <some-non-stable-toolchain> then it will fail to understand the rust source. See docs link below for further information.

The only way I know to fix this is to explicitly set the below environment variable:

RUSTUP_TOOLCHAIN=stable nvim

About

Custom neovim configuration

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages