shyun3/nvimrc

My Neovim files

Neovim configs

Last used with Neovim v0.10.2 on WSL Ubuntu.

Installation

These instructions assume that dotfiles have been setup on Windows and Ubuntu.

1. Clone this repo to the proper directory:

   git clone https://github.com/shyun3/nvimrc ~/.config/nvim

2. Start Neovim. Plugins should start automatically installing.

3. Run :checkhealth and resolve any issues.

4. Restart Neovim. Installation should now be complete.

Example configuration files

See the corresponding README.

Tips

clangd

• The example clangd config contains hints for cross-compiling and resolving system header issues. The clangd system headers documentation is also helpful.
• When specifying paths with embedded spaces in compile_flags.txt, do not introduce quotes or backslashes to escape as this will be handled by clangd. For example:

  -Ipath with spaces
  

Python

• Formatter options may be specified through a project top-level pyproject.toml, for example:

  [tool.black]
  unstable = true
  
  [tool.isort]
  profile = "black"
  

  Using the unstable option for black may be useful to have it break long strings, see the future style docs. isort can also be configured for black compatibility by specifying the profile (see docs).
• Pyright can read type stubs placed in the typings directory. This can be customized using the stubPath option in the pyrightconfig.json. See also Generating Type Stubs.

UltiSnips

• Add snippets under the UltiSnips/specific directory for snippets that are meant to be machine-specific and not saved in the repo, see the UltiSnips plugin setup.