jirafey / mnw

Minimal Neovim Wrapper

Minimal NeoVim Wrapper

This flake exists because the nixpkgs neovim wrapper is a pain

and I conceptually disagree with nixvim

About

Based off the nixpkgs wrapper but:

• in one place
• more error checking
• a sane interface
• evalModules "type" checking
• more convenience options
• doesn't take two functions to wrap

There are no flake inputs.

Usage

Add the flake input

mnw.url = "github:Gerg-L/mnw";

or import the base of this repo using

to use flake-compat

Then use one of the modules or mnw.lib.wrap

Wrapper function

The wrapper takes two arguments pkgs and then an attribute set of config options

let
  neovim = mnw.lib.wrap pkgs {
    #config options
  };
in {
...

then add it to environment.systemPackages or users.users.<name>.packages or anywhere you can add a package

Modules

Import {nixosModules,darwinModules,homeManagerModules}.mnw into your respective config

and use the programs.mnw options

programs.mnw = {
  enable = true;
#other config

and it'll the wrapped neovim to environment.systemPackages or home.packages

to not install by default use the .dontInstall module instead and add config.programs.mnw.finalPackage where you want

Config Options

# The neovim package to wrap
# Ensure you're using the -unwrapped variant
neovim = pkgs.neovim-unwrapped;

plugins = [
  # You can pass a directory
  # and use it just like it's
  # ~/.config/nvim
  ./myNeovimConfig
  # and you can pass vimPlugins from nixpkgs
  pkgs.vimPlugins.fzf-lua
];
# I recommend using plugins from a npins source
# to track the newest commits of a plugin
# check my config for an example

# Lsps and fzf/rg go here and get appended to PATH
extraBinPath = [ pkgs.nil ];

# Sets NVIMAPP_NAME
appName = "nvim";

# Extra arguments passed to makeWrapper
wrapperArgs = [ ];

# Whether to load ~/.config/nvim/init.lua
loadDefaultRC = false;

# Lua init files to load
luaFiles = [ ];
# Lua init string to load
initLua = "";
# VimL init files to load
vimlFiles = [ ];
# VimLinit string to load
initViml = "";

# Symlink vi/vim to nvim
viAlias = false;
vimAlias = false;

# Setup and enable providers
withRuby = true;
withNodeJs = false;
withPerl = false;
withPython3 = true;
extraPython3Packages = p: [ ];

# Extra luaPackages which may be needed by plugins
extraLuaPackages = _: [ ];

Full usage examples

Mine

NotAShelf

If you would like your example here PR it