My personal neovim as container configuration

I made this public so I can easily clone without authentication,
but since I treat this as a personal use only stuff,
there can be some(read "a lot of") messy stuff.

Much of this might have been selectively copy pasted from plugin repos. Those repos are obviously listed in plugin setup part.

Basic usage of this config

**Tested only with rootless podman, docker might require additional setup, or proper in-container user setup**

Host system Setup

Installing host system stuff, currently just fonts (Fedora example):

sudo dnf install -y \
    dejavu-fonts-all \
    gnu-free-mono-fonts

Image management:

build:

git clone https://github.com/Szwendacz99/nvim && \
podman build -t neovim ./nvim

pack to file with high compression:

podman save localhost/neovim:latest -o /dev/stdout | xz -z -9 -e -c > neovim.tar.xz

import file back to local registry:

podman load -i ./neovim.tar.xz

Image usage examples

basic startup for editing current folder:

podman run --privileged -it --rm \
    -e XDG_RUNTIME_DIR=/runtime_dir \
    -e WAYLAND_DISPLAY=$WAYLAND_DISPLAY \
    -v $XDG_RUNTIME_DIR/$WAYLAND_DISPLAY:/runtime_dir/$WAYLAND_DISPLAY \
    --workdir /data \
    -v "./:/data:rw" \
    	neovim:latest

function to run neovim container easily,
allowing passing parameters and mounting files:

function nvim() {
    if [ $1 ] && [ -f $1 ]; then
        MOUNT_FILE="-v "$1:$1"";
        echo "mounting file $1";
   	else
        MOUNT_FOLDER="--workdir /data -v ./:/data:rw"
    fi
    podman run --privileged -it --rm \
      -e XDG_RUNTIME_DIR=/runtime_dir \
      -e WAYLAND_DISPLAY=$WAYLAND_DISPLAY \
      -v $XDG_RUNTIME_DIR/$WAYLAND_DISPLAY:/runtime_dir/$WAYLAND_DISPLAY \
      -v ~/.local/share/nvim/sessions:/root/.local/share/nvim/sessions \
      $MOUNT_FILE \
      $MOUNT_FOLDER \
          neovim:latest "$@"
}

Inside vim

# manage plugins:
:Lazy

There is need to make sure your system can display (almost) any unicode character. Hacked fonts may be needed for filetype icons but there is also need for a dedicated package with unicode fonts (like unifont-fonts.noarch) that will have every character missing from default font used in Neovim editor. Link to hacked fonts:
https://www.nerdfonts.com/font-downloads

General info

Mason:

Mason installs stuff in .local/share/nvim/mason/packages so they are independent from system stuff, like pip installed python packages. All that is saved in image, so that is why image is so heavy.

Usage

root perms when editing

# Re-open a current file with sudo
:SudaRead
# Open /etc/sudoers with sudo
:SudaRead /etc/sudoers

# Forcedly save a current file with sudo
:SudaWrite
# Write contents to /etc/profile
:SudaWrite /etc/profile

General

<leader>l

disable (search) highlighting

Opened files navigation:

<leader> m m	open minimap
<leader> m c	close minimap
<leader> m f	focus minimap
Ctrl w w	Move to next splitted frame
Ctrl w <arrow>	moving throught splitted frame
Ctrl w c	close split
Ctrl w v	split vertically
Ctrl w s	split horizontally
Ctrl w x	swap places of two splits
gt	next tab
gT	previous tab
:tabnew	Create new tab
Ctrl+g Ctrl+t	(when in file tree) open selected file in new tab
:bd	close buffer
:bnext	next buffer
:b3	switch to buffer 3
:buffers	list buffers and their numbers

File explorer:

Ctrl+t	Toggle file explorer when not focused on it
f	Toggle filtering when focused on explorer
<leader> n	Move focus to explorer
d	Delete selected file
rn	Rename file
c	add file to clipboard
p	paste (file) from clipboard

File searching / Telescope

<leader>ff	Find files
<leader>fg	Live grep
<leader>fb	Buffers
<leader>fh	Help tags
Ctrl+q	Open search result list as a dedicated split (quickfix list) (will overwrite previous one created this way in current tab)
Ctrl+u	Scroll preview up
Ctrl+d	Scroll preview down
Ctrl+x	Open selection as a split
Ctrl+v	Open selection as a vsplit
Ctrl+t	Open selection in new tab

Git stuff

Ctrl+g	show current code chunk changes
<leader>hb	show full git blame of current line (double use to enter displayed diff)
<leader>hD	show splitted blame diff (double use to enter displayed diff)
<leader>hd	show splitted diff
<leader>hr	reset hunk
<leader>hR	reset whole buffer
<leader>td	toggle deleted

Genreal git commands:

:Git <command>

#Commands with dedicated display
:Git # show nice interactive summary of whole git project state
:Git mergetool, :Git difftool # load their changesets into the quickfix list
:Git blame # this will nicely show \
		   # for every line in separate split
           # Useful shortcuts for blame mode:
           # o - jump to patch or blob in horizontal split
           # A, C, D - different display (lenght) modes
           # g? - other keybindings

#other examples:
:Git add .
:Git commit

Nice single file diff viewer:

:Gdiffsplit

GitSings provides some commands for displaying git stuff:

:Gitsigns *

#examples:
:Gitsigns toggle_word_diff
:Gitsigns toggle_linehl
:Gitsigns toggle_numhl
:Gitsigns toggle_signs

Code editing stuff

w	jump forward by one word
b	jump backward by one word
:%s/^original.\*/replacement/gc	regex replacing (c is for choice prompt, its optional)
Ctrl+q	Visual block select mode

LSP usage

<space>q	open list with diagnostics postions
<space>e	open diagnostics floating window
\[d	next diagnostic
\]	previous diagnostic
<leader>k	open hoover box and enter it
<leader>rn	rename element (function name, etc):
<leader>f	format file
gd	go to definition
gD	go to declaration
<space>D	go to type definition
gi	go to implementation
gr	go to references
Ctrl+f	scroll down popup with docstring
Ctrl+b	scroll up popup with docstring
<leader>wa	add workspace folder
<leader>wr	remove workspace folder
<leader>wl	list workspace folders

LSP diagnostics, etc:

<leader>xx	Open diagnostics window
<leader>xw	workspace diagnostics
<leader>xd	document diagnostics
<leader>xl	loclist
<leader>xq	quickfix
gR	lsp references

Sessions

To save new session on specific path, just use :SaveSession, then when opening nvim there, without arguments, the session will be restored.

Notifications

:Notifications	show recent notifications
:Telescope notify	show recent notifications in telescope gui