README.md

CAPE's Neovim Configuration

A Neovim configuration based on the AstroNvim distribution for development within the CAPE organization and to set up all of the languages and common tooling used.

⚡ Requirements

• Neovim v0.9.5+
• Git v2.19.0+
• A C compiler in your path and libstdc++ installed (Ex. gcc, clang, zig, Windows users please read this!)
• A Nerd Font
• A Terminal with true color support¹
• Requirements to install tools (must be in $PATH):
  • curl - Used by Mason in general to download files
  • pip - isort, black, pyright, debugpy, sqlfluff
  • npm - prettier, json-language-server, yaml-language-server, bash-language-server
  • go - regols
  • opa (optional) - opa_check

🛠️ Usage (Unix/Mac Instructions)

1. Clone the repository to the folder ~/.config/cape

git clone https://github.com/cape-ph/nvim.git ~/.config/cape

2. Run the configuration using the NVIM_APPNAME environment variable

NVIM_APPNAME=cape nvim

Tip

You can make this default by exporting NVIM_APPNAME=cape in a terminal session or in your shell configuration

export NVIM_APPNAME=cape
nvim

🐳 Test in Docker

docker run -w /root -it --rm alpine:edge sh -uelic '
  apk add bash curl git npm python3 go neovim alpine-sdk --update
  git clone --depth 1 https://github.com/cape-ph/nvim ~/.config/nvim
  nvim
'

Footnotes

1. Note when using default theme: For MacOS, the default terminal does not have true color support. You will need to use iTerm2, Kitty, WezTerm, or another terminal emulator that has true color support. ↩