feat(wrapperModules.neovim): init (#180)

a wrapper module which hopes to capture all the good parts of nixCats,
nvf, and mnw in a general implementation module system

Also comes with a starter template

Author: BirdeeHub

templates/default.nix

@@ -3,4 +3,8 @@
     path = ./flake;
     description = "An example flake wrapping a package with a module";
   };
+  neovim = {
+    path = ./neovim;
+    description = "An example flake showing basic usage of the neovim module";
+  };
 }

templates/neovim/flake.nix

@@ -0,0 +1,46 @@
+{
+  description = "Flake exporting a configured package using wlib.evalModule";
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+  inputs.wrappers.url = "github:BirdeeHub/nix-wrapper-modules";
+  inputs.wrappers.inputs.nixpkgs.follows = "nixpkgs";
+  inputs.nvim-treesitter-textobjects = {
+    url = "github:nvim-treesitter/nvim-treesitter-textobjects/main";
+    flake = false;
+  };
+  outputs =
+    {
+      self,
+      nixpkgs,
+      wrappers,
+      ...
+    }@inputs:
+    let
+      forAllSystems = nixpkgs.lib.genAttrs nixpkgs.lib.platforms.all;
+      module = nixpkgs.lib.modules.importApply ./module.nix inputs;
+      wrapper = wrappers.lib.evalModule module;
+    in
+    {
+      overlays = {
+        default = final: prev: { neovim = wrapper.config.wrap { pkgs = final; }; };
+        neovim = self.overlays.default;
+      };
+      wrapperModules = {
+        default = module;
+        neovim = self.wrapperModules.default;
+      };
+      wrappedModules = {
+        default = wrapper.config;
+        neovim = self.wrappedModules.default;
+      };
+      packages = forAllSystems (
+        system:
+        let
+          pkgs = import nixpkgs { inherit system; };
+        in
+        {
+          default = wrapper.config.wrap { inherit pkgs; };
+          neovim = self.packages.${system}.default;
+        }
+      );
+    };
+}

templates/neovim/ftplugin/README.md

@@ -0,0 +1,3 @@
+These files are ran on the filetype corresponding to their name.
+
+see [`:h 'rtp'`](https://neovim.io/doc/user/options.html#'rtp')

templates/neovim/ftplugin/lua.lua

@@ -0,0 +1,9 @@
+-- NOTE: Lazydev will make your Lua LSP stronger for Neovim config
+-- we are also using this as an opportunity to show you how to lazy load plugins!
+-- This plugin was added to the optionalPlugins section of the main nix file of this template.
+-- Thus, it is not loaded and must be packadded.
+-- NOTE: Use `=require(vim.g.nix_info_plugin_name).plugins.lazy` to see the names of all lazy plugins downloaded via Nix for packadd.
+vim.cmd.packadd('lazydev.nvim')
+require('lazydev').setup({
+  library = { },
+})

templates/neovim/init.lua

@@ -0,0 +1,117 @@
+-- NOTE: init.lua gets ran before anything else.
+
+-- NOTE: These 2 need to be set up before any plugins are loaded.
+vim.g.mapleader = ' '
+vim.g.maplocalleader = ' '
+
+-- [[ Setting options ]]
+-- See `:help vim.o`
+
+-- Sets how neovim will display certain whitespace characters in the editor.
+--  See `:help 'list'`
+--  and `:help 'listchars'`
+vim.opt.list = true
+vim.opt.listchars = { tab = '» ', trail = '·', nbsp = '␣' }
+
+-- Set highlight on search
+vim.opt.hlsearch = true
+vim.keymap.set('n', '<Esc>', '<cmd>nohlsearch<CR>')
+
+-- Preview substitutions live, as you type!
+vim.opt.inccommand = 'split'
+
+-- Minimal number of screen lines to keep above and below the cursor.
+vim.opt.scrolloff = 10
+
+-- Make line numbers default
+vim.wo.number = true
+
+-- Enable mouse mode
+vim.o.mouse = 'a'
+
+-- Indent
+-- vim.o.smarttab = true
+vim.opt.cpoptions:append('I')
+vim.o.expandtab = true
+-- vim.o.smartindent = true
+-- vim.o.autoindent = true
+-- vim.o.tabstop = 4
+-- vim.o.softtabstop = 4
+-- vim.o.shiftwidth = 4
+
+-- stops line wrapping from being confusing
+vim.o.breakindent = true
+
+-- Save undo history
+vim.o.undofile = true
+
+-- Case-insensitive searching UNLESS \C or capital in search
+vim.o.ignorecase = true
+vim.o.smartcase = true
+
+-- Keep signcolumn on by default
+vim.wo.signcolumn = 'yes'
+vim.wo.relativenumber = true
+
+-- Decrease update time
+vim.o.updatetime = 250
+vim.o.timeoutlen = 300
+
+-- Set completeopt to have a better completion experience
+vim.o.completeopt = 'menu,preview,noselect'
+
+-- NOTE: You should make sure your terminal supports this
+vim.o.termguicolors = true
+
+vim.g.netrw_liststyle=0
+vim.g.netrw_banner=0
+-- [[ Disable auto comment on enter ]]
+-- See :help formatoptions
+vim.api.nvim_create_autocmd("FileType", {
+  desc = "remove formatoptions",
+  callback = function()
+    vim.opt.formatoptions:remove({ "c", "r", "o" })
+  end,
+})
+-- [[ Highlight on yank ]]
+-- See `:help vim.highlight.on_yank()`
+local highlight_group = vim.api.nvim_create_augroup('YankHighlight', { clear = true })
+vim.api.nvim_create_autocmd('TextYankPost', {
+  callback = function()
+    vim.highlight.on_yank()
+  end,
+  group = highlight_group,
+  pattern = '*',
+})
+
+-- Keymaps for better default experience
+-- See `:help vim.keymap.set()`
+vim.keymap.set("v", "J", ":m '>+1<CR>gv=gv", { desc = 'Moves Line Down' })
+vim.keymap.set("v", "K", ":m '<-2<CR>gv=gv", { desc = 'Moves Line Up' })
+vim.keymap.set("n", "<C-d>", "<C-d>zz", { desc = 'Scroll Down' })
+vim.keymap.set("n", "<C-u>", "<C-u>zz", { desc = 'Scroll Up' })
+vim.keymap.set("n", "n", "nzzzv", { desc = 'Next Search Result' })
+vim.keymap.set("n", "N", "Nzzzv", { desc = 'Previous Search Result' })
+vim.keymap.set("n", "<leader><leader>[", "<cmd>bprev<CR>", { desc = 'Previous buffer' })
+vim.keymap.set("n", "<leader><leader>]", "<cmd>bnext<CR>", { desc = 'Next buffer' })
+vim.keymap.set("n", "<leader><leader>l", "<cmd>b#<CR>", { desc = 'Last buffer' })
+vim.keymap.set("n", "<leader><leader>d", "<cmd>bdelete<CR>", { desc = 'delete buffer' })
+
+-- Remap for dealing with word wrap
+vim.keymap.set('n', 'k', "v:count == 0 ? 'gk' : 'k'", { expr = true, silent = true })
+vim.keymap.set('n', 'j', "v:count == 0 ? 'gj' : 'j'", { expr = true, silent = true })
+
+-- Diagnostic keymaps
+vim.keymap.set('n', '<leader>e', vim.diagnostic.open_float, { desc = 'Open floating diagnostic message' })
+vim.keymap.set('n', '<leader>q', vim.diagnostic.setloclist, { desc = 'Open diagnostics list' })
+
+-- Sync clipboard between OS and Neovim.
+-- But it constantly clobbers your system clipboard whenever you delete anything.
+--  See `:help 'clipboard'`
+-- vim.o.clipboard = 'unnamedplus'
+-- You should instead use these keybindings to use the clipboard so that they are still easy to use, but dont conflict
+vim.keymap.set({"v", "x", "n"}, '<leader>y', '"+y', { noremap = true, silent = true, desc = 'Yank to clipboard' })
+vim.keymap.set({"n", "v", "x"}, '<leader>Y', '"+yy', { noremap = true, silent = true, desc = 'Yank line to clipboard' })
+vim.keymap.set({'n', 'v', 'x'}, '<leader>p', '"+p', { noremap = true, silent = true, desc = 'Paste from clipboard' })
+vim.keymap.set('i', '<C-p>', '<C-r><C-p>+', { noremap = true, silent = true, desc = 'Paste from clipboard from within insert mode' })
+vim.keymap.set("x", "<leader>P", '"_dP', { noremap = true, silent = true, desc = 'Paste over selection without erasing unnamed register' })

templates/neovim/module.nix

@@ -0,0 +1,124 @@
+inputs:
+{
+  config,
+  wlib,
+  lib,
+  pkgs,
+  ...
+}:
+{
+  imports = [ wlib.wrapperModules.neovim ];
+  # choose a directory for your config.
+  # this can be a string, for if you don't want nix to manage it right now.
+  # but be careful, it also doesn't get provisioned by nix if it isnt in the store.
+  config.settings.config_directory = ./.;
+
+  # The makeWrapper options are available
+  config.extraPackages = with pkgs; [
+    lazygit
+    lua-language-server
+    tree-sitter
+    stylua
+    nixd
+    alejandra
+  ];
+  # your config/plugin specifications
+  # a set of plugins or specs, which can contain a list of plugins or specs if desired.
+  config.specs.general = with pkgs.vimPlugins; [
+    {
+      # These can be specs too!
+      data = snacks-nvim;
+      # maybe you want to do something like this?
+
+      # lazy = false | true;
+      # type = "lua" | "fnl" | "vim";
+      # info = { /* some opts from nix to the config */ };
+      # config = ''
+      #   local info, pname, lazy = ...
+      #   -- run snacks bigfile or something
+      # '';
+
+      # before = [ "INIT_MAIN" ];
+      # putting before = [ "INIT_MAIN" ] here will run this before the main init
+
+      # things can target any spec that has a name.
+      name = "snacks-spec";
+      # now something else can be after = [ "snacks-spec" ]
+      # the spec name is not the plugin name.
+      # to override the plugin name, use `pname`
+    }
+    onedark-nvim
+    vim-sleuth
+    mini-ai
+    mini-icons
+    mini-pairs
+    nvim-lspconfig
+    vim-startuptime
+    blink-cmp
+    lualine-nvim
+    lualine-lsp-progress
+    gitsigns-nvim
+    which-key-nvim
+    nvim-lint
+    conform-nvim
+    nvim-dap-ui
+    nvim-dap-virtual-text
+    # building a plugin from a source outside of nixpkgs
+    (config.nvim-lib.mkPlugin "treesitter-textobjects" inputs.nvim-treesitter-textobjects)
+    # treesitter + grammars
+    nvim-treesitter.withAllGrammars
+    # This is for if you only want some of the grammars
+    # (nvim-treesitter.withPlugins (
+    #   plugins: with plugins; [
+    #     nix
+    #     lua
+    #   ]
+    # ))
+  ];
+
+  # you can name these whatever you want. These ones are named `general` and `lazy`
+  # You can use the before and after fields to run them before or after other specs or spec of lists of specs
+  config.specs.lazy = {
+    # this `lazy = true` definition will transfer to specs in the contained DAL, if there is one.
+    # This is because the definition of lazy in `config.specMods` checks `parentSpec.lazy or false`
+    # the submodule type for `config.specMods` gets `parentSpec` as a `specialArg`.
+    # you can define options like this too!
+    lazy = true;
+    # here we chose a DAL of plugins, but we can also pass a single plugin, or null
+    # plugins are of type wlib.types.stringable
+    data = with pkgs.vimPlugins; [
+      lazydev-nvim
+    ];
+    # top level specs don't need to declare their dag name to be targetable.
+    # so we can target general here, without adding name = "general" in the `general` spec above.
+    # in fact, we didn't even need to give `general` a spec, its just a list!
+    after = [ "general" ];
+  };
+
+  # These specMods are modules which modify your specs in config.specs
+  # you can override defaults, or make your own options.
+  config.specMods =
+    { parentSpec, ... }:
+    {
+      config.collateGrammars = lib.mkDefault (parentSpec.collateGrammars or true);
+    };
+  # or, if you dont care about propagating parent values:
+  # config.specMods.collateGrammars = lib.mkDefault true;
+
+  # There are some default hosts!
+  # python, ruby, and node are enabled by default
+  # perl and neovide are not.
+
+  # To add a wrapped $out/bin/${config.binName}-neovide to the resulting neovim derivation
+  # config.hosts.neovide.nvim-host.enable = true;
+
+  # If you want to install multiple neovim derivations via home.packages or environment.systemPackages
+  # in order to prevent path collisions:
+
+  # set this to false:
+  # config.settings.dont_link = true;
+
+  # and make sure these dont share values:
+  # config.binName = "nvim";
+  # config.settings.aliases = [ ];
+}

templates/neovim/plugin/README.md

@@ -0,0 +1,3 @@
+all files in this directory get ran at startup
+
+see [`:h 'rtp'`](https://neovim.io/doc/user/options.html#'rtp')

templates/neovim/plugin/completion.lua

@@ -0,0 +1,23 @@
+require("blink.cmp").setup({
+  -- 'default' (recommended) for mappings similar to built-in completions (C-y to accept)
+  -- See :h blink-cmp-config-keymap for configuring keymaps
+  keymap = { preset = 'default' },
+  appearance = {
+    nerd_font_variant = 'mono'
+  },
+  signature = { enabled = true, },
+  sources = {
+    default = { 'lsp', 'path', 'snippets', 'buffer' },
+    providers = {
+      path = {
+        score_offset = 50,
+      },
+      lsp = {
+        score_offset = 40,
+      },
+      snippets = {
+        score_offset = 40,
+      },
+    },
+  },
+})