{ config, lib, ... }: let inherit (lib.options) mkOption mkEnableOption literalMD; inherit (lib.strings) optionalString; inherit (lib.types) enum bool str int either; inherit (lib.generators) mkLuaInline; inherit (lib.nvim.dag) entryAfter; inherit (lib.nvim.binds) pushDownDefault; inherit (lib.nvim.lua) toLuaObject; inherit (lib.nvim.types) luaInline; cfg = config.vim; in { options.vim = { disableArrows = mkOption { type = bool; default = false; description = "Set to prevent arrow keys from moving cursor"; }; hideSearchHighlight = mkOption { type = bool; default = false; description = "Hide search highlight so it doesn't stay highlighted"; }; scrollOffset = mkOption { type = int; default = 8; description = "Start scrolling this number of lines from the top or bottom of the page."; }; syntaxHighlighting = mkOption { type = bool; default = !config.vim.treesitter.highlight.enable; description = "Enable syntax highlighting"; }; useSystemClipboard = mkOption { type = bool; default = false; description = "Make use of the clipboard for default yank and paste operations. Don't use * and +"; }; lineNumberMode = mkOption { type = enum ["relative" "number" "relNumber" "none"]; default = "relNumber"; example = "none"; description = "How line numbers are displayed."; }; preventJunkFiles = mkOption { type = bool; default = false; description = "Prevent swapfile and backupfile from being created"; }; showSignColumn = mkOption { type = bool; default = true; description = "Show the sign column"; }; bell = mkOption { type = enum ["none" "visual" "on"]; default = "none"; description = "Set how bells are handled. Options: on, visual or none"; }; enableEditorconfig = mkOption { type = bool; default = true; description = "Follow editorconfig rules in current directory"; }; searchCase = mkOption { type = enum ["ignore" "smart" "sensitive"]; default = "sensitive"; description = "Set the case sensitivity of search"; }; undoFile = { enable = mkEnableOption "undofile for persistent undo behaviour"; path = mkOption { type = either str luaInline; default = mkLuaInline "vim.fn.stdpath('state') .. '/undo'"; defaultText = literalMD '' ```nix mkLuaInline "vim.fn.stdpath('state') .. '/undo'" ``` ''; example = literalMD '' ```nix mkLuaInline "os.getenv('XDG_DATA_HOME') .. '/nvf/undo'" ``` ''; description = "Path to the directory in which undo history will be stored"; }; }; }; config.vim = { # Set options that were previously interpolated in 'luaConfigRC.basic' as vim.options (vim.o) # and 'vim.globals' (vim.g). Future options, if possible, should be added here instead of the # luaConfigRC section below. options = pushDownDefault { encoding = "utf-8"; hidden = true; expandtab = true; }; globals = pushDownDefault { editorconfig = cfg.enableEditorconfig; }; # Options that are more difficult to set through 'vim.options'. Fear not, though # as the Lua DAG is still as powerful as it could be. luaConfigRC.basic = entryAfter ["globalsScript"] '' -- Settings that are set for everything vim.opt.shortmess:append("c") ${optionalString cfg.undoFile.enable '' vim.o.undofile = true vim.o.undodir = ${toLuaObject cfg.undoFile.path} ''} ${optionalString cfg.showSignColumn '' vim.o.signcolumn = "yes" ''} ${optionalString cfg.preventJunkFiles '' vim.o.swapfile = false vim.o.backup = false vim.o.writebackup = false ''} ${optionalString (cfg.bell == "none") '' vim.o.errorbells = false vim.o.visualbell = false ''} ${optionalString (cfg.bell == "on") '' vim.o.visualbell = false ''} ${optionalString (cfg.bell == "visual") '' vim.o.errorbells = false ''} ${optionalString (cfg.lineNumberMode == "relative") '' vim.o.relativenumber = true ''} ${optionalString (cfg.lineNumberMode == "number") '' vim.o.number = true ''} ${optionalString (cfg.lineNumberMode == "relNumber") '' vim.o.number = true vim.o.relativenumber = true ''} ${optionalString cfg.useSystemClipboard '' vim.opt.clipboard:append("unnamedplus") ''} ${optionalString cfg.syntaxHighlighting '' vim.cmd("syntax on") ''} ${optionalString cfg.hideSearchHighlight '' vim.o.hlsearch = false vim.o.incsearch = true ''} ${optionalString (cfg.searchCase == "ignore") '' vim.o.smartcase = false vim.o.ignorecase = true ''} ${optionalString (cfg.searchCase == "smart") '' vim.o.smartcase = true vim.o.ignorecase = true ''} ${optionalString (cfg.searchCase == "sensitive") '' vim.o.smartcase = false vim.o.ignorecase = false ''} ''; }; }