My personal (Neo)Vim config

Love it or hate it but this is my personal neovim config. This is tailor made to me so if you're looking for a fully featured vim config where everything is done for you, try SpaceVim.

Install

Install the latest NVIM

This config requires neo nightly.

Please refer to the official Neovim installation documentation for platform-specific installation instructions.

Run Make

To install to nvim run

make install-nvim

This command will remove any old config

Docker Container

You can also build and run this Neovim configuration within a Docker container. This provides a consistent environment regardless of your host operating system.

Building the Docker Image

To build the Docker image, navigate to the directory containing the Dockerfile and run:

docker build -t warpcode-nvim .

Custom User ID and Group ID

For better integration with your host system (e.g., for file permissions when mounting volumes), you can build the image with your host user's UID and GID. This ensures that files created by Neovim inside the container have the correct ownership on your host.

To find your current user's UID and GID on Linux/macOS, use:

id -u  # for UID
id -g  # for GID

Then, build the image using the --build-arg flag:

docker build \
  --build-arg USER_UID=$(id -u) \
  --build-arg USER_GID=$(id -g) \
  -t warpcode-nvim .

You can also specify a custom username if desired (default is dev):

docker build \
  --build-arg USER_UID=$(id -u) \
  --build-arg USER_GID=$(id -g) \
  --build-arg USER_NAME=myuser \
  -t warpcode-nvim .

Running the Docker Container

Once built, you can run the container. To use Neovim with your current working directory, you'll typically mount it as a volume:

docker run -it --rm -v "$(pwd):/home/dev/workspace" warpcode-nvim nvim /home/dev/workspace

Replace /home/dev/workspace with the appropriate path if you changed the USER_NAME build argument.

Dependencies

Core Dependencies (All Platforms)

These are required for basic functionality:

• Git - Version control and plugin management
• Node.js - Language server support and some plugins
• Ripgrep - Fast file searching (used by Telescope)
• GitHub CLI (gh) - For GitHub integration (e.g., CopilotChat features)

Platform-Specific Dependencies

Ubuntu/Debian (apt-based)

sudo apt update
sudo apt install build-essential git curl php nodejs ripgrep
# Install GitHub CLI (gh)
type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y)
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
&& sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
&& sudo apt update \
&& sudo apt install gh -y

macOS (using Homebrew)

# Install Homebrew if you don't have it
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install dependencies
brew install git curl php node ripgrep
brew install --cask github-cli  # for gh command

Windows (using Chocolatey)

# Install Chocolatey if you don't have it
# Run PowerShell as Administrator and execute:
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

# Install dependencies
choco install git curl php nodejs ripgrep github-cli

Arch Linux (pacman-based)

sudo pacman -S base-devel git curl php nodejs ripgrep github-cli

Fedora/RHEL/CentOS (dnf/yum-based)

sudo dnf install gcc gcc-c++ make git curl php nodejs ripgrep github-cli
# or for older versions
sudo yum groupinstall "Development Tools"
sudo yum install git curl php nodejs ripgrep github-cli

Optional Dependencies

These enhance the experience but aren't required:

• Python 3 - Additional language support
• Lua - Some advanced plugin features
• Cargo (Rust) - Some Rust-based tools
• Go - Go language support

Installing Optional Dependencies

Ubuntu/Debian:

sudo apt install python3 python3-pip lua5.4 cargo golang-go

macOS:

brew install python lua rust go

Windows:

choco install python lua rust golang

Arch Linux:

sudo pacman -S python lua rust go

Fedora/RHEL/CentOS:

sudo dnf install python3 python3-pip lua cargo golang

Font Requirements

For the best experience, install a Nerd Font:

• Ubuntu/Debian: sudo apt install fonts-nerd-fonts-hack
• macOS: brew install --cask font-hack-nerd-font
• Windows: Download from Nerd Fonts
• Arch Linux: sudo pacman -S nerd-fonts-hack

Verification

After installation, verify your setup:

# Check Neovim version (should be 0.9.0+)
nvim --version

# Check other dependencies
git --version
node --version
rg --version
php --version
gh --version

Troubleshooting

Common Issues

Neovim version too old:

• Ensure you're using the nightly/unstable version
• On Ubuntu, the stable PPA only provides older versions

Missing ripgrep:

• Telescope plugin requires ripgrep for live grep functionality
• Alternative: install fd and configure Telescope to use it

Node.js issues:

• Ensure Node.js version 16+ is installed
• Some language servers require specific Node.js versions

Font issues:

• Set vim.g.have_nerd_font = true in your config if using Nerd Fonts
• Or set vim.g.have_nerd_font = false if not using them

Platform-Specific Issues

macOS:

• If using M1/M2 Mac, ensure you have the ARM64 versions of dependencies
• Some plugins may require Xcode Command Line Tools: xcode-select --install

Windows:

• Ensure WSL2 is used for better compatibility
• Some Unix tools may not work natively on Windows

Linux:

• Ensure you have the latest package versions
• Some distributions may require enabling additional repositories