• Features
  • Modern Devtools Integration
  • Powerful Text Edit Plugins
  • Tailored for Data Science
  • Seamless Integration with Vscode
  • Be Wild
• Showcase
• Dependencies
  • python deps
  • r deps
  • lua deps
  • vimscript deps
  • markdown deps
  • sql deps
  • bash deps
  • latex deps
  • cpp deps
  • general purpose deps
• Keymaps
  • Builtin keymaps
    • Builtin movement keymaps
    • Builtin window keymaps
    • Builtin tab keymaps
    • Builtin buffer keymaps
    • Builtin navigation keymaps
  • Builtin miscellenous keymaps
  • UI keymaps
    • Pretty quickfix list keymaps
  • Utils keymaps
    • File explorer keymaps
    • Window layout keymaps
  • Text Edit keymaps
    • Align text keymaps
    • Comment keymaps
    • Text objects for functions keymaps
    • Quick navigation keymaps
    • Text objects enhancement keymaps
    • Block text movement
    • Surround pairs keymaps
    • substitution keymaps
    • Other text objects keymaps
  • Integration with other tools
    • Terminal emulator keymaps
    • Git keymaps
    • Ripgrep keymaps
    • Copilot keymaps
  • REPL keymaps
  • Treesitter keymaps
    • Syntax based text objects keymaps
    • Syntaxa based navigations keymaps
    • Miscellenous
  • Searcher keymaps
  • Language Server Protocol keymaps
  • Autocompletion keymaps
  • Debugger Adapter Protocol keymaps
  • orgmode keymaps
  • Filetype Specific Keymaps
    • R keymaps
      • Builtin keymaps for R
      • REPL keymaps for R
    • Python keymaps
      • Builtin keymaps for Python
    • REPL keymaps for Python
    • Rmarkdown keymaps
      • Builtin keymaps for Rmarkdown
      • Text objects keymaps for Rmarkdown
      • REPL keymaps for Rmarkdown
      • Rmarkdown preview keymaps
    • Markdown keymaps
    • Latex keymaps
• Other Notes
• Discussion

#Features

#Modern Devtools Integration

Built on modern devtools including LSP and treesitter. Treesitter delivers AST-level highlighting, text objects, and navigations, while LSP offers features like auto completion, go to definition and reference, and code diagnostics. By harnessing the power of both Ctags and LSP, this configuration brings a harmonic blend of old-school and modern development tools.

#Powerful Text Edit Plugins

Vim's exceptional text editing capabilities are further amplified by a host of powerful plugins focusing on text editing. (Remember it is pure text editing makes vim vim.)

#Tailored for Data Science

This configuration is specifically tailored toward data science toolsets, including python, R, SQL, Latex, rmarkdown, and quarto.

#Seamless Integration with Vscode

Curated configuration working together with vscode thanks to vscode-neovim. Access all the familiar neovim keybindings, including translations of equivalent commands in vscode, even when working with complex graphical content like Jupyter notebooks. And many neovim plugins, such as treesitter, can be embedded seamlessly in vscode, allowing for a smooth and uninterrupted workflow.

NOTE: If you plan to use this configuration with vscode-neovim, please use the windows/vscode branch. If you wish to use neovim both in the terminal and in vscode, we suggest creating two folders in ~/.config or your specified $XDG_CONFIG path. One is ~/.config/nvim, which uses the default configuration in the master branch, and the other is ~/.config/vscode-neovim, which uses the configuration in the windows/vscode branch. This takes advantage of the NVIM_APPNAME feature in nvim 0.9.

There are two ways to ask vscode-neovim to use the configuration from the ~/.config/vscode-neovim folder as opposed to the default folder. Select the method that suits your preference best:

1. Create a bash script like the following:

#!bin/bash
NVIM_APPNAME=vscode-neovim nvim "$@"

Then, in vscode, set vscode-neovim.neovimExecutablePaths.darwin to your_path/to_the/bash_script, changing darwin to match your system.

1. Set vscode-neovim.NVIM_APPNAME to vscode-neovim in vscode settings.

#Be Wild

Randomly select a theme from a curated list each time you start up and automatically switches between day and night themes at scheduled time. Additionally, the displayed verses on the welcome screen is also randomized with each launch. With neovim, you can have a fresh experience every time. Be casual and wild!

#Showcase

• The welcome screen displays two verses randomly selected from my curated collection. You can select new verses and color schemes at random or access frequently used commands from this screen.

• This screenshot showcases writing Lua code with smart autocompletion through both language server (LSP) and universal-ctags (ctags). This combination seamlessly blends old-school and modern tools. The bottom window shows the occurrence of referenced symbols that you specify (via lsp find references), while the right window shows the symbol outline of the current file (via lsp document symbols).

• This screenshot demonstrates the use of literate programming in neovim, which is highly beneficial for data science workflows. You can write code in both Python and R with intelligent autocompletion from both LSP and Ctags in quarto or markdown files. Moreover, you can send your code to both R and Python REPL simultaneously.

• This screenshot demonstrates how to debug Python program in neovim. Stepping through the code and watching variables and stack frames, just like in vscode.

#Dependencies

You are responsible for installing the dependencies, but most of them are optional. They consist mainly of language servers and linters that correspond to their respective languages. You can choose the ones you need and leave out the others. Even if certain dependencies are absent, neovim will still operate and display notifications instead of halting completely.

If your system lacks a proper package manager, such as with Windows, or if the packages are out of date, as with Debian, you can use Mason.nvim, a neovim plugin specifically to install some of the dependencies. Dependencies marked with a * can be installed through Mason.nvim. To install these packages within neovim, enter :Mason in the prompt, and a popup window will appear with the intuitive interface of Mason. From there, you can easily install packages.

This configuration relies on an external tool called efm-langserver, which can be installed via mason. However, it needs to be separately configured outside of neovim. An example configuration for efm is provided in the dist folder. To use this example configuration, simply copy the folder to ~/.config/.

#python deps

1. python.
2. debugpy: this module should be included by the python at the top of your $PATH.
3. ipython
4. black*
5. efm-langserver*
6. pyright*

#r deps

1. r-language-server: this is a R package that should be installed by the r at the top of your $PATH
2. radian

#lua deps

1. lua-language-server*
2. stylua*
3. selene*
4. efm-langserver*

#vimscript deps

1. vim-language-server*

#markdown deps

1. prettierd*
2. vale*
3. efm-langserver*

#sql deps

1. sqls*
2. sql-formatter*

#bash deps

1. bash-language-server*
2. shellcheck*

#latex deps

1. texlab*
2. latexindent*: while this package is shipped with texlive, perl shipped by macOS cannot run this program, so I use a homebrew installed latexindent instead.

#cpp deps

1. clangd*: Apple's xcode command line tools ship this for you.

#general purpose deps

1. universal-ctags

#Keymaps

NOTE: this only includes keymaps defined by myself, and some of the default plugins keymaps that I used frequently.

The <Leader> key is <Space>, the <LocalLeader> key is <Space><Space> or <Backslash>.

In case you forget the keymaps you can always use <Leader>fk (:Telescope keymaps) to find all keymaps.

#Builtin keymaps

#Builtin movement keymaps

#Builtin window keymaps

#Builtin tab keymaps

#Builtin buffer keymaps

#Builtin navigation keymaps

#Builtin miscellenous keymaps

#UI keymaps

#Pretty quickfix list keymaps

The following keymaps rely on Trouble.nvim

#Utils keymaps

#File explorer keymaps

The following keymaps rely on nvim-tree.lua

#Window layout keymaps

The following keymaps rely on winshift.nvim

#Text Edit keymaps

#Align text keymaps

The following keymaps rely on vim-easy-align

#Comment keymaps

The following keymaps rely on mini.comment

#Text objects for functions keymaps

The following keymaps rely on dsf.vim

#Quick navigation keymaps

The following keymaps rely on vim-sneak

#Text objects enhancement keymaps

The following keymaps rely on mini.ai

#Block text movement

The following keymaps rely on mini.move

#Surround pairs keymaps

The following keymaps rely on mini.surround

#substitution keymaps

The following keymaps rely on substitute.nvim

#Other text objects keymaps

The following keymaps rely on vim-textobj-beween

The following keymaps rely on vim-textobj-chainmember

#Integration with other tools

#Terminal emulator keymaps

The following keymaps rely on toggleterm.nvim

#Git keymaps

The following keymaps rely on gitsigns.nvim

The following keymaps rely on neogit

The following keymaps rely on diffview.nvim

#Ripgrep keymaps

The following keymaps rely on nvim-spectre

#Copilot keymaps

The following keymaps rely on copilot.lua

#REPL keymaps

Note: with no numerical argument, the REPL is default for the first REPL.

#Treesitter keymaps

#Syntax based text objects keymaps

#Syntaxa based navigations keymaps

#Miscellenous

#Searcher keymaps

The following keymaps rely on

telescope.nvim, nvim-notify, project.nvim

#Language Server Protocol keymaps

The following keymaps rely on nvim-lspconfig

The following keymaps rely on telescope.nvim

The following keymaps rely on lspsaga.nvim

The following keymaps rely on lsp_signature.nvim

The following keymaps rely on aerial.nvim

#Autocompletion keymaps

The following keymaps rely on nvim-cmp

#Debugger Adapter Protocol keymaps

#orgmode keymaps

#Filetype Specific Keymaps

#R keymaps

#Builtin keymaps for R

#REPL keymaps for R

The following keymaps rely on Nvim-R

#Python keymaps

#Builtin keymaps for Python

#REPL keymaps for Python

The following keymaps rely on iron.nvim

#Rmarkdown keymaps

#Builtin keymaps for Rmarkdown

#Text objects keymaps for Rmarkdown

The following keymaps rely on dsf.vim

#REPL keymaps for Rmarkdown

The following keymaps rely on Nvim-R

The same as in section R REPL keymaps

#Rmarkdown preview keymaps

The following keymaps rely on markdown-previem.nvim

#Markdown keymaps

The following keymaps rely on markdown-previem.nvim

#Latex keymaps

The following keymaps rely on vimtex

#Other Notes

1. vim-sneak defines relatively inconsistent behavior: in normal mode, use s/S, in operator pending mode, use z/Z, in visual mode, use s/Z. In normal mode, default mapping s is replaced. In op mode, use z/Z is to be compatible with vim-surround (mappings: ys/ds/cs), in visual mode, use s/Z is to be compatible with folding (mapping: zf) and vim-surround (mapping: S)

2. You need to define your leader key before defining any keymaps. Otherwise, keymap will not be correctly mapped with your leader key.

3. Note that tree-sitter will turn syntax off, and pandoc-syntax and pandoc-rmarkdown relies on the builtin syntax, so we need to load config.pandoc before we load config.treesitter

4. vim-matchup will (intentionally) hide the status-line if the matched pair are spanned over entire screen to show the other side of the pair.

#Discussion

1. It is recommended to use the mailing list ~northyear/nvim-devel@lists.sr.ht.
2. Alternatively, you are also welcome to open a Github issue.