neovim [wiki.dlma]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== neovim ======

My notes on nvim.

===== Installation =====

**tl;dr**: Prefer the tarball to snap or default package manager.

The regular ''apt-get'' repo is too out-of-date. When 0.9.5 was stable, Ubuntu 20.04 was providing 0.3 or 0.4.

[[https://github.com/cli/cli/blob/trunk/docs/install_linux.md#snap-do-not-use|GitHub recommends against snap for gh]], and in WSL2, although I had ''snap'', it didn't work, so I [[https://github.com/neovim/neovim/blob/master/INSTALL.md#install-from-download|downloaded the tarball]]. (If you click Linux, it'll download the tarball. Otherwise [[https://github.com/neovim/neovim/releases|scroll down and find/expand "Assets"]].) Then I extracted it into $HOME/.local/bin/.

  uname -m  # x86_64
  cd ~/.local/bin/
  wget https://github.com/neovim/neovim/releases/download/stable/nvim-linux-x86_64.tar.gz
  tar -xvf nvim-linux64.tar.gz.1
  ln -s nvim-linux64/bin/nvim nvim

===== Copilot =====

You need Node for the Copilot plugin ([[https://github.com/github/copilot.vim?tab=readme-ov-file#getting-started|Getting Started]] instructions). It also works with Vim 9.0.0.0185+.

  - Install [[https://nodejs.org/en/download/package-manager|Node]].
  - Get nvim (see above)
  - [[https://github.com/github/copilot.vim?tab=readme-ov-file|Install plugin]] (used ''--filter=blob:none'')
    - ''%%git clone --filter=blob:none https://github.com/github/copilot.vim.git ~/.config/nvim/pack/github/start/copilot.vim%%''
  - Assure you're logged in to GitHub with the profile you want to connect. The next step's setup will launch the browser.
  - Start nvim and run '':Copilot setup''
  - read [[https://docs.github.com/en/copilot/using-github-copilot/getting-started-with-github-copilot?tool=vimneovim#about-github-copilot-and-vimneovim|docs]].
 
===== Copilot Chat =====

See [[https://github.com/CopilotC-Nvim/CopilotChat.nvim?tab=readme-ov-file#manual|Manual installation of CopilotChat]].

<code bash>
mkdir -p ~/.config/nvim/pack/copilotchat/start
cd ~/.config/nvim/pack/copilotchat/start
# (Done as part of CoPilot installation) git clone --filter=blob:none --single-branch https://github.com/github/copilot.vim
git clone --filter=blob:none --single-branch https://github.com/nvim-lua/plenary.nvim
git clone --filter=blob:none --single-branch https://github.com/CopilotC-Nvim/CopilotChat.nvim
</code>

==== macOS tweak ====

On macOS, I initially had trouble with diffs of the form ''[file:main.cpp](#file:main.cpp-context)'', so I edited [[https://github.com/CopilotC-Nvim/CopilotChat.nvim/blob/main/lua/CopilotChat/client.lua#L25|~/.config/nvim/pack/copilotchat/start/CopilotChat.nvim/lua/CopilotChat/client.lua:25]].

<code bash>
sed -i 's/(#file:%s-context)/(%s)/' ~/.config/nvim/pack/copilotchat/start/CopilotChat.nvim/lua/CopilotChat/client.lua
</code>

==== WSL tweak ====

WSL sets ''$XDG_RUNTIME_DIR'' to a path that cannot be written to. So either:

  - ''export XDG_RUNTIME_DIR=/tmp''
  - or modify plenary's curl.lua to not find it. (Mangle it.) (See ''sed'' below.)
  - or ''[[https://github.com/microsoft/WSL/issues/10846#issuecomment-1840548054|sudo chown 1000:1000 /mnt/wslg/run/user/1000]]'' (untested)

<code bash>
sed -i 's/XDG_RUNTIME_DIR/DXB_HIDDEN_XDG_RUNTIME_DIR/' ~/.config/nvim/pack/copilotchat/start/plenary.nvim/lua/plenary/curl.lua
</code>

==== Optional Settings ====

Optional, [[https://github.com/CopilotC-Nvim/CopilotChat.nvim/wiki/Examples-and-Tips#markdown-rendering|MarkDown rendering]]:


<code bash>
git clone --filter=blob:none --single-branch https://github.com/nvim-treesitter/nvim-treesitter \
          ~/.config/nvim/pack/nvim-treesitter/start/
</code>

Add ''require'nvim-treesitter.configs'.setup...'' to .config/nvim/init.vim. Test CopilotChat like this, with treesitter, but not render-markdown.

See what you think of this first. (Rainbow parentheses may be gone. Might have to add something like [[https://github.com/HiPhish/rainbow-delimiters.nvim|rainbow-delimiters.nvim]]).

<code bash>
git clone --filter=blob:none --single-branch https://github.com/MeanderingProgrammer/render-markdown.nvim \
          ~/.config/nvim/pack/render-markdown.nvim/start/
</code>
===== taglist =====

The old taglist I have isn't working as expected in tmux. Opening the window would wrap neovim windows. The fix is to disable auto-resizing the winwidth.

  let Tlist_Inc_Winwidth = 0

Along the way, I tried getting the latest release (since head auto runs tests). Maybe I should keep it.

  git clone --filter=blob:none -b v4.6 https://github.com/yegappan/taglist ~/.local/share/nvim/site/plugin/

===== cscope =====

Cscope has been removed from neovim. If you want it back, install [[https://github.com/dhananjaylatkar/cscope_maps.nvim|dhananjaylatkar/cscope_maps.nvim]] into ''.config/nvim/pack/cscope_maps/start/''. (This //may// also work in ''~/.local/share/nvim/site/pack/cscope_maps/start/'', but you have to get the path right.)

Your hierarchy would look something like:
<code>
~/.config/nvim/pack/cscope_maps/
└── start
    └── cscope_maps.nvim
        └── lua
            ├── cscope
            │   └── pickers
            └── utils
</code>

Run the following commands:

  mkdir -p ~/.config/nvim/pack/cscope_maps/start/
  cd ~/.config/nvim/pack/cscope_maps/start/
  git clone --filter=blob:none https://github.com/dhananjaylatkar/cscope_maps.nvim.git

Then in your init.vim, add the following snippet:

<file lua init.vim>
lua << EOF
  require('cscope_maps').setup({
    disable_maps = true, -- Mapping C-] to :Cstag <cword> worse than :tag <cword>
-- Alternatively, if we liked the mappings, then customise these two:
--    skip_input_prompt = true,
--    cscope = { skip_picker_for_single_result = true },
  })
EOF
</file>

===== Mappings =====

The easiest way to find out where a mapping came from is to run this command:

    :verbose imap <key sequence>