refactor(nvim): move config out of module

home/modules/nvim/config/lua/base.lua

@@ -0,0 +1,29 @@
+vim.cmd([[
+" Tip: acronyms for overview, use `:h` for a quick lookup.
+set nocp                               " Disable vi incompatibility
+filetype plugin indent on              " Filetype recognition
+set enc=utf8                           " Default to UTF-8 encoding
+set hid                                " Allow hiding unsaved buffers
+set tf                                 " Fast tty
+set ut=300                             " 300ms for update time
+set to tm=200 ttm=5                    " Timeouts
+set shm+=c                             " ...
+set ul=500 hi=500                      " History and undo
+set nu rnu scl=number                  " Line numbers & signs
+set nowrap
+set bs=indent,eol,start                " Indentation
+set ai ts=2 sts=2 sw=2 et              " Indentation
+set is ic scs hls                      " Search
+set lz                                 " Only essential redraws
+set nobk nowb noswf                    " No backups
+set vi='20,\"101                       " Max 100 lines in registers
+set novb                               " Bell
+set cole=0 cocu=""                     " Conceal
+set cb=unnamedplus                     " Clipboard
+set fcs+=vert:│                        " Cleaner split separator (tmux style)
+set list
+set lcs=trail:·,tab:→\ ,nbsp:␣         " Whitespace rendering
+set ar                                 " Autoread
+set spellsuggest+=5                    " Limit spell suggestions
+set wildignore+=*/node_modules/*,*/tmp/*,*.so,*.swp,*.zip
+]])

home/modules/nvim/config/lua/cursor.lua

@@ -0,0 +1,16 @@
+vim.cmd([[
+" Taken from /usr/share/vim/vim90/defaults.vim
+augroup vimStartup
+  au!
+
+  " When editing a file, always jump to the last known cursor position.
+  " Don't do it when the position is invalid, when inside an event handler
+  " (happens when dropping a file on gvim) and for a commit message (it's
+  " likely a different one than last time).
+  autocmd BufReadPost *
+    \ if line("'\"") >= 1 && line("'\"") <= line("$") && &ft !~# 'commit'
+    \ |   exe "normal! g`\""
+    \ | endif
+
+augroup END
+]])

home/modules/nvim/config/lua/diagnostic.lua

@@ -0,0 +1,10 @@
+-- Source: <https://vonheikemen.github.io/devlog/tools/neovim-lsp-client-guide/>
+vim.diagnostic.config({
+  signs = true,
+  underline = false,
+  severity_sort = true,
+})
+
+vim.keymap.set("n", "<leader>dl", vim.diagnostic.open_float)
+vim.keymap.set("n", "<leader>dj", vim.diagnostic.goto_prev)
+vim.keymap.set("n", "<leader>dk", vim.diagnostic.goto_next)

home/modules/nvim/config/lua/fold.lua

@@ -0,0 +1,26 @@
+vim.cmd([[
+" Folds {{{
+set foldmethod=marker
+
+augroup filetype_vim
+    autocmd!
+    autocmd FileType vim setlocal foldmethod=marker
+augroup END
+
+augroup filetype_python
+    autocmd!
+    autocmd FileType python setlocal foldmethod=indent
+augroup END
+
+augroup filetype_sh
+    autocmd!
+    autocmd FileType sh setlocal foldmethod=marker
+augroup END
+
+augroup filetype_snippets
+    autocmd!
+    autocmd FileType snippets setlocal foldmethod=marker
+augroup END
+
+" }}}
+]])

home/modules/nvim/config/lua/ftdetect.lua

@@ -0,0 +1,14 @@
+vim.filetype.add({
+  filename = {
+    [".lintstagedrc"] = "json",
+  },
+  pattern = {
+    ["tsconfig.*.json"] = "jsonc",
+    [".*/%.vscode/.*%.json"] = "jsonc",
+    [".*/%.ssh/config%.d/.*"] = "sshconfig",
+    ["%.env.*"] = "dotenv",
+    ["%.pl$"] = "prolog",
+    [".*.containerfile.*"] = "dockerfile",
+    ["%.hydra$"] = "javascript",
+  },
+})

home/modules/nvim/config/lua/highlight.lua

@@ -0,0 +1,14 @@
+local autocmd = vim.api.nvim_create_autocmd
+local augroup = vim.api.nvim_create_augroup
+
+local function yank_highlight()
+  vim.highlight.on_yank({ higroup = "Visual", timeout = 150 })
+end
+
+-- Yanked text highlight feedback (source: https://github.com/nvim-lua/kickstart.nvim/blob/master/init.lua)
+augroup("YankHighlight", { clear = true })
+autocmd("TextYankPost", {
+  desc = "Highlight when yanking (copying) text",
+  group = "YankHighlight",
+  callback = yank_highlight,
+})

home/modules/nvim/config/lua/keymaps.lua

@@ -0,0 +1,55 @@
+vim.g.mapleader = " "
+vim.g.maplocalleader = ";"
+
+local set = vim.keymap.set
+
+-- splits & navigation
+set("n", "s", "<c-w>", { desc = "window prefix" })
+set("n", "ss", ":sp<CR><c-w>w", { desc = "split horizontal" })
+set("n", "sv", ":vs<CR><c-w>w", { desc = "split vertical" })
+set("n", "sw", "<c-w>w", { desc = "navigate splits" })
+set("n", "sh", "<c-w>h", { desc = "focus left split" })
+set("n", "sj", "<c-w>j", { desc = "focus below split" })
+set("n", "sk", "<c-w>k", { desc = "focus above split" })
+set("n", "sl", "<c-w>l", { desc = "focus right split" })
+set("n", "sH", "<c-w>8<", { desc = "shrink split left" })
+set("n", "sJ", "<c-w>8-", { desc = "shrink split down" })
+set("n", "sK", "<c-w>8+", { desc = "grow split up" })
+set("n", "sL", "<c-w>8>", { desc = "grow split right" })
+set("n", "s=", "<c-w>=", { desc = "equalize splits" })
+
+-- open
+set("n", "sb", ":Lex<cr>", { desc = "file tree" })
+set("n", "<leader><leader>", ":noh<cr>", { desc = "clear highlights" })
+set("n", "<leader>t", ":term<cr>", { desc = "open terminal" })
+set("n", "<leader>w", "<cmd>w<cr>", { desc = ":w" })
+
+-- remaps
+set("i", "jj", "<esc>", { nowait = true, desc = "exit insert mode" })
+set("n", "<left>", "<nop>")
+set("n", "<down>", "<nop>")
+set("n", "<up>", "<nop>")
+set("n", "<right>", "<nop>")
+set("i", "<left>", "<nop>")
+set("i", "<down>", "<nop>")
+set("i", "<up>", "<nop>")
+set("i", "<right>", "<nop>")
+
+-- line numbers
+set("n", "<leader>n", ":set nu! rnu!<cr>", { desc = "toggle line numbers" })
+
+-- vim configuration
+set("n", "<leader>ec", ":vs $MYVIMRC<cr>", { desc = "edit vimrc" })
+set("n", "<leader>so", ":so %<cr>", { desc = "source current file" })
+
+set("n", "<leader>cx", "<cmd>!chmod +x %<CR>", { silent = true, desc = "run `chmod +x` on current file" })
+set("n", "yp", "<cmd>let @+ = expand('%r')<CR>:p<CR>", { silent = true, desc = "yank path" })
+
+-- remap native NeoVim comment keymaps
+set({ "n", "x" }, "<leader>c", "gc", { remap = true, desc = "toggle comment" })
+set("n", "<leader>cc", "gcc", { remap = true, desc = "toggle comment line" })
+set("o", "<leader>c", "gc", { remap = true, desc = "comment textobject" })
+
+-- move lines
+set("v", "K", ": '<,'>move '<-2<cr>gv", { desc = "move selection up" })
+set("v", "J", ": '<,'>move '>+1<cr>gv", { desc = "move selection down" })

home/modules/nvim/config/lua/netrw.lua

@@ -0,0 +1,5 @@
+vim.cmd([[
+let g:netrw_winsize = 30
+let g:netrw_liststyle=3
+let g:netrw_banner = 0
+]])

home/modules/nvim/config/lua/nixCatsUtils/init.lua

@@ -0,0 +1,136 @@
+-- Source: https://github.com/BirdeeHub/nixCats-nvim/blob/main/templates/example/lua/nixCatsUtils/init.lua
+--[[
+  This directory is the luaUtils template.
+  You can choose what things from it that you would like to use.
+  And then delete the rest.
+  Everything in this directory is optional.
+--]]
+
+local M = {}
+
+--[[
+  This file is for making your config still work WITHOUT nixCats.
+  When you don't use nixCats to load your config,
+  you wont have the nixCats plugin.
+
+  The setup function defined here defines a mock nixCats plugin when nixCats wasnt used to load the config.
+  This will help avoid indexing errors when the nixCats plugin doesnt exist.
+
+  NOTE: If you only ever use nixCats to load your config, you don't need this file.
+--]]
+
+---@type boolean
+M.isNixCats = vim.g[ [[nixCats-special-rtp-entry-nixCats]] ] ~= nil
+
+---@class nixCatsSetupOpts
+---@field non_nix_value boolean|nil
+
+---This function will setup a mock nixCats plugin when not using nix
+---It will help prevent you from running into indexing errors without a nixCats plugin from nix.
+---If you loaded the config via nix, it does nothing
+---non_nix_value defaults to true if not provided or is not a boolean.
+---@param v nixCatsSetupOpts
+function M.setup(v)
+  if not M.isNixCats then
+    local nixCats_default_value
+    if type(v) == "table" and type(v.non_nix_value) == "boolean" then
+      nixCats_default_value = v.non_nix_value
+    else
+      nixCats_default_value = true
+    end
+    local mk_with_meta = function(tbl)
+      return setmetatable(tbl, {
+        __call = function(_, attrpath)
+          local strtable = {}
+          if type(attrpath) == "table" then
+            strtable = attrpath
+          elseif type(attrpath) == "string" then
+            for key in attrpath:gmatch("([^%.]+)") do
+              table.insert(strtable, key)
+            end
+          else
+            print("function requires a table of strings or a dot separated string")
+            return
+          end
+          return vim.tbl_get(tbl, unpack(strtable))
+        end,
+      })
+    end
+    package.preload["nixCats"] = function()
+      local ncsub = {
+        get = function(_)
+          return nixCats_default_value
+        end,
+        cats = mk_with_meta({
+          nixCats_config_location = vim.fn.stdpath("config"),
+          wrapRc = false,
+        }),
+        settings = mk_with_meta({
+          nixCats_config_location = vim.fn.stdpath("config"),
+          configDirName = os.getenv("NVIM_APPNAME") or "nvim",
+          wrapRc = false,
+        }),
+        petShop = mk_with_meta({}),
+        extra = mk_with_meta({}),
+        pawsible = mk_with_meta({
+          allPlugins = {
+            start = {},
+            opt = {},
+          },
+        }),
+        configDir = vim.fn.stdpath("config"),
+        packageBinPath = os.getenv("NVIM_WRAPPER_PATH_NIX") or vim.v.progpath,
+      }
+      return setmetatable(ncsub, {
+        __call = function(_, cat)
+          return ncsub.get(cat)
+        end,
+      })
+    end
+    _G.nixCats = require("nixCats")
+  end
+end
+
+---allows you to guarantee a boolean is returned, and also declare a different
+---default value than specified in setup when not using nix to load the config
+---@overload fun(v: string|string[]): boolean
+---@overload fun(v: string|string[], default: boolean): boolean
+function M.enableForCategory(v, default)
+  if M.isNixCats or default == nil then
+    if nixCats(v) then
+      return true
+    else
+      return false
+    end
+  else
+    return default
+  end
+end
+
+---if nix, return value of nixCats(v) else return default
+---Exists to specify a different non_nix_value than the one in setup()
+---@param v string|string[]
+---@param default any
+---@return any
+function M.getCatOrDefault(v, default)
+  if M.isNixCats then
+    return nixCats(v)
+  else
+    return default
+  end
+end
+
+---for conditionally disabling build steps on nix, as they are done via nix
+---I should probably have named it dontAddIfCats or something.
+---@overload fun(v: any): any|nil
+---Will return the second value if nix, otherwise the first
+---@overload fun(v: any, o: any): any
+function M.lazyAdd(v, o)
+  if M.isNixCats then
+    return o
+  else
+    return v
+  end
+end
+
+return M

home/modules/nvim/config/lua/pandoc.lua

@@ -0,0 +1,12 @@
+vim.cmd([[
+fu! Compile()
+  if expand('%:e') == "md" 
+    :silent exec "!pandoc % -s -o /tmp/op.pdf &"
+  endif
+endfu
+
+fu! Preview()
+  :call Compile()
+  :silent exec "!zathura /tmp/op.pdf &"
+endfu
+]])

home/modules/nvim/config/lua/reload.lua

@@ -0,0 +1,7 @@
+vim.cmd([[
+augroup Vim
+  au!
+  " Reload vim config when ~/.vimrc is changed
+  au BufWritePost $HOME/.vimrc so $MYVIMRC | redraw | echo "Reloaded vimrc"
+augroup END
+]])

home/modules/nvim/config/lua/skeleton/init.lua

@@ -0,0 +1,11 @@
+local autocmd = vim.api.nvim_create_autocmd
+
+autocmd("BufNewFile", {
+  pattern = "shell.nix",
+  command = "0r ~/.config/nvim/skeletons/shell.nix.skeleton",
+})
+
+autocmd("BufNewFile", {
+  pattern = "flake.nix",
+  command = "0r ~/.config/nvim/skeletons/flake.nix.skeleton",
+})

home/modules/nvim/config/lua/statusline.lua

@@ -0,0 +1,10 @@
+vim.opt.laststatus = 3
+
+vim.cmd([[
+se stl=\ %0*%n
+se stl+=\ %m
+se stl+=\ %y%0*
+se stl+=\ %<%F
+se stl+=\ %0*%=%5l%*
+se stl+=%0*/%L%*
+]])

home/modules/nvim/config/lua/theme.lua

@@ -0,0 +1,8 @@
+vim.opt.background = "dark"
+
+if vim.g.vscode then
+  return
+end
+
+vim.g.zenwritten_compat = 1
+vim.cmd.colorscheme(require("nixCatsUtils").getCatOrDefault("colorscheme", "zenwritten"))

home/modules/nvim/config/lua/utils.lua

@@ -0,0 +1,8 @@
+vim.cmd([[
+function! SynGroup()
+    let l:s = synID(line('.'), col('.'), 1)
+    echo synIDattr(l:s, 'name') . ' -> ' . synIDattr(synIDtrans(l:s), 'name')
+endfun
+
+com! -nargs=0 Syn :call SynGroup()
+]])

home/modules/nvim/config/lua/zk/cmp.lua

@@ -0,0 +1,52 @@
+local cmp = require("cmp")
+
+local source = {}
+
+local function get_markdown_files(base)
+  local items = {}
+  local pattern = base .. "/**/*.md"
+  local files = vim.fn.glob(pattern, false, true)
+  for _, file in ipairs(files) do
+    local label = file:gsub("^%./", ""):gsub("%.md$", "")
+    table.insert(items, { label = label })
+  end
+  return items
+end
+
+function source:get_keyword_pattern()
+  return "[%w%./%-]*"
+end
+
+function source:complete(params, callback)
+  local cursor_before_line = params.context.cursor_before_line
+  local cursor_after_line = params.context.cursor_after_line or ""
+
+  if not cursor_before_line:match("%[[^%]]*%]%(") then
+    callback({})
+    return
+  end
+
+  local items = get_markdown_files(".")
+  local next_char = cursor_after_line:sub(1, 1)
+
+  for _, item in ipairs(items) do
+    if next_char == ")" then
+      item.insertText = item.label
+    else
+      item.insertText = item.label .. ")"
+    end
+  end
+
+  callback(items)
+end
+
+function source:get_trigger_characters()
+  return { "(" }
+end
+
+function source:is_available()
+  local ft = vim.bo.filetype
+  return ft == "markdown" or ft == "pandoc"
+end
+
+cmp.register_source("zk", source)

home/modules/nvim/config/lua/zk/init.lua

@@ -0,0 +1,25 @@
+require("zk.cmp")
+require("zk.utils")
+
+vim.cmd([[
+let s:zk_preview_enabled = 0
+let s:live_server_job = -1
+execute 'au BufEnter' g:zk_path . '/*.md' 'silent exe "!echo %" ">" g:zk_path . "/current-zettel.txt"'
+function! ToggleZKPreview()
+    if s:zk_preview_enabled == 1
+        let s:zk_preview_enabled = 0
+        call jobstop(s:live_server_job)
+        au! ZKPreview
+    else
+        let s:zk_preview_enabled = 1
+        let s:live_server_job = jobstart('live-server --watch=' . g:zk_path . '/current-zettel-content.html --open=current-zettel-content.html --port=8080')
+        augroup ZKPreview
+          execute 'au BufEnter' g:zk_path . '/*.md' 'silent exe "!cat %:r.html" ">" g:zk_path . "/current-zettel-content.html"'
+          execute 'au BufWritePost' g:zk_path . '/*.md' 'silent exe "!make && cat %:r.html" ">" g:zk_path . "/current-zettel-content.html"'
+        augroup END
+    endif
+endfunction
+command! ToggleZKPreview call ToggleZKPreview()
+
+nn <leader>o :ToggleZKPreview<cr> :!xdg-open http://localhost:8080/%:t:r.html & <cr>
+]])

home/modules/nvim/config/lua/zk/utils.lua

@@ -0,0 +1,2 @@
+vim.g.zk_path = os.getenv("ZK_PATH") or (os.getenv("HOME") .. "/.zk")
+return vim.g.zk_path