Merge branch 'main' of https://github.com/NotAShelf/nvf

merge

modules/default.nix

@@ -1,10 +1,13 @@
-inputs: {
-  configuration,
-  pkgs,
+{
+  inputs,
   lib,
-  check ? true,
+}: {
+  pkgs,
   extraSpecialArgs ? {},
+  modules ? [],
+  # deprecated
   extraModules ? [],
+  configuration ? {},
 }: let
   inherit (pkgs) vimPlugins;
   inherit (lib.strings) isString toString;
@@ -13,13 +16,25 @@ inputs: {
   # import modules.nix with `check`, `pkgs` and `lib` as arguments
   # check can be disabled while calling this file is called
   # to avoid checking in all modules
-  nvimModules = import ./modules.nix {inherit pkgs check lib;};
+  nvimModules = import ./modules.nix {inherit pkgs lib;};
 
   # evaluate the extended library with the modules
   # optionally with any additional modules passed by the user
   module = lib.evalModules {
     specialArgs = extraSpecialArgs // {modulesPath = toString ./.;};
-    modules = concatLists [[configuration] nvimModules extraModules];
+    modules = concatLists [
+      nvimModules
+      modules
+      (lib.optional (configuration != {}) (lib.warn ''
+          nvf: passing 'configuration' to lib.neovimConfiguration is deprecated.
+        ''
+        configuration))
+
+      (lib.optionals (extraModules != []) (lib.warn ''
+          nvf: passing 'extraModules' to lib.neovimConfiguration is deprecated, use 'modules' instead.
+        ''
+        extraModules))
+    ];
   };
 
   # alias to the internal configuration

modules/extra/deprecations.nix

@@ -7,5 +7,12 @@ in {
       Tidalcycles language support has been removed as of 2024-06-06 as it was long unmaintained. If
       you depended on this functionality, please open an issue.
     '')
+
+    # 2024-07-20
+    (mkRemovedOptionModule ["vim" "lsp" "nvimCodeActionMenu"] ''
+      nvimCodeActionMenu has been deprecated and removed upstream. As of 0.7, fastaction will be
+      available under `vim.ui.fastaction` as a replacement. Simply remove everything under
+      `vim.lsp.nvimCodeActionMenu`, and set `vim.ui.fastaction.enable` to `true`.
+    '')
   ];
 }

modules/modules.nix

@@ -1,77 +1,72 @@
 {
-  check ? true,
   pkgs,
   lib,
 }: let
   inherit (lib.modules) mkDefault;
   inherit (lib.lists) concatLists;
+  allModules = let
+    # The core neovim modules.
+    # Contains configuration for core neovim features
+    # such as spellchecking, mappings, and the init script (init.vim).
+    neovim = map (p: "${./neovim}/${p}") [
+      "init"
+      "mappings"
+    ];
 
-  # The core neovim modules.
-  # Contains configuration for core neovim features
-  # such as spellchecking, mappings, and the init script (init.vim).
-  neovim = map (p: ./neovim + "/${p}") [
-    "init"
-    "mappings"
-  ];
+    # Individual plugin modules, separated by the type of plugin.
+    # While adding a new type, you must make sure your type is
+    # included in the list below.
+    plugins = map (p: "${./plugins}/${p}") [
+      "assistant"
+      "autopairs"
+      "comments"
+      "completion"
+      "dashboard"
+      "debugger"
+      "filetree"
+      "git"
+      "languages"
+      "lsp"
+      "minimap"
+      "notes"
+      "projects"
+      "rich-presence"
+      "session"
+      "snippets"
+      # "spellcheck" # FIXME: see neovim/init/spellcheck.nix
+      "statusline"
+      "tabline"
+      "terminal"
+      "theme"
+      "treesitter"
+      "ui"
+      "utility"
+      "visuals"
+    ];
 
-  # Individual plugin modules, separated by the type of plugin.
-  # While adding a new type, you must make sure your type is
-  # included in the list below.
-  plugins = map (p: ./plugins + "/${p}") [
-    "assistant"
-    "autopairs"
-    "comments"
-    "completion"
-    "dashboard"
-    "debugger"
-    "filetree"
-    "git"
-    "languages"
-    "lsp"
-    "minimap"
-    "notes"
-    "projects"
-    "rich-presence"
-    "session"
-    "snippets"
-    # "spellcheck" # FIXME: see neovim/init/spellcheck.nix
-    "statusline"
-    "tabline"
-    "terminal"
-    "theme"
-    "treesitter"
-    "ui"
-    "utility"
-    "visuals"
-  ];
+    # The neovim wrapper, used to build a wrapped neovim package
+    # using the configuration passed in `neovim` and `plugins` modules.
+    wrapper = map (p: "${./wrapper}/${p}") [
+      "build"
+      "rc"
+      "warnings"
+    ];
 
-  # The neovim wrapper, used to build a wrapped neovim package
-  # using the configuration passed in `neovim` and `plugins` modules.
-  wrapper = map (p: ./wrapper + "/${p}") [
-    "build"
-    "rc"
-    "warnings"
-  ];
-
-  # Extra modules, such as deprecation warnings
-  # or renames in one place.
-  extra = map (p: ./extra + "/${p}") [
-    "deprecations.nix"
-  ];
-
-  allModules = concatLists [neovim plugins wrapper extra];
-
-  pkgsModule = {config, ...}: {
-    config = {
-      _module = {
-        inherit check;
-        args = {
-          baseModules = allModules;
-          pkgsPath = mkDefault pkgs.path;
-          pkgs = mkDefault pkgs;
-        };
-      };
-    };
-  };
+    # Extra modules, such as deprecation warnings
+    # or renames in one place.
+    extra = map (p: "${./extra}/${p}") [
+      "deprecations.nix"
+    ];
+  in
+    concatLists [neovim plugins wrapper extra];
 in
-  allModules ++ [pkgsModule]
+  allModules
+  ++ [
+    {
+      _module.args = {
+        baseModules = allModules;
+        pkgsPath = mkDefault pkgs.path;
+        pkgs = mkDefault pkgs;
+      };
+    }
+  ]

modules/neovim/init/basic.nix

@@ -3,11 +3,13 @@
   lib,
   ...
 }: let
-  inherit (lib.options) mkOption literalExpression;
+  inherit (lib.options) mkOption mkEnableOption literalExpression literalMD;
   inherit (lib.strings) optionalString;
-  inherit (lib.types) enum bool str int;
+  inherit (lib.types) enum bool str int either;
+  inherit (lib.generators) mkLuaInline;
   inherit (lib.nvim.dag) entryAfter;
   inherit (lib.nvim.lua) toLuaObject;
+  inherit (lib.nvim.types) luaInline;
 
   cfg = config.vim;
 in {
@@ -158,112 +160,138 @@ in {
       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.luaConfigRC.basic = entryAfter ["globalsScript"] ''
-    -- Settings that are set for everything
-    vim.o.encoding = "utf-8"
-    vim.o.hidden = true
-    vim.opt.shortmess:append("c")
-    vim.o.expandtab = true
-    vim.o.mouse = ${toLuaObject cfg.mouseSupport}
-    vim.o.tabstop = ${toLuaObject cfg.tabWidth}
-    vim.o.shiftwidth = ${toLuaObject cfg.tabWidth}
-    vim.o.softtabstop = ${toLuaObject cfg.tabWidth}
-    vim.o.cmdheight = ${toLuaObject cfg.cmdHeight}
-    vim.o.updatetime = ${toLuaObject cfg.updateTime}
-    vim.o.tm = ${toLuaObject cfg.mapTimeout}
-    vim.o.cursorlineopt = ${toLuaObject cfg.cursorlineOpt}
-    vim.o.scrolloff = ${toLuaObject cfg.scrollOffset}
-    vim.g.mapleader = ${toLuaObject cfg.leaderKey}
-    vim.g.maplocalleader = ${toLuaObject cfg.leaderKey}
+  config = {
+    vim.luaConfigRC.basic = entryAfter ["globalsScript"] ''
+      -- Settings that are set for everything
+      vim.o.encoding = "utf-8"
+      vim.o.hidden = true
+      vim.opt.shortmess:append("c")
+      vim.o.expandtab = true
+      vim.o.mouse = ${toLuaObject cfg.mouseSupport}
+      vim.o.tabstop = ${toLuaObject cfg.tabWidth}
+      vim.o.shiftwidth = ${toLuaObject cfg.tabWidth}
+      vim.o.softtabstop = ${toLuaObject cfg.tabWidth}
+      vim.o.cmdheight = ${toLuaObject cfg.cmdHeight}
+      vim.o.updatetime = ${toLuaObject cfg.updateTime}
+      vim.o.tm = ${toLuaObject cfg.mapTimeout}
+      vim.o.cursorlineopt = ${toLuaObject cfg.cursorlineOpt}
+      vim.o.scrolloff = ${toLuaObject cfg.scrollOffset}
+      vim.g.mapleader = ${toLuaObject cfg.leaderKey}
+      vim.g.maplocalleader = ${toLuaObject cfg.leaderKey}
 
-    ${optionalString cfg.splitBelow ''
-      vim.o.splitbelow = true
-    ''}
+      ${optionalString cfg.undoFile.enable ''
+        vim.o.undofile = true
+        vim.o.undodir = ${toLuaObject cfg.undoFile.path}
+      ''}
 
-    ${optionalString cfg.splitRight ''
-      vim.o.splitright = true
-    ''}
+      ${optionalString cfg.splitBelow ''
+        vim.o.splitbelow = true
+      ''}
 
-    ${optionalString cfg.showSignColumn ''
-      vim.o.signcolumn = "yes"
-    ''}
+      ${optionalString cfg.splitRight ''
+        vim.o.splitright = true
+      ''}
 
-    ${optionalString cfg.autoIndent ''
-      vim.o.autoindent = true
-    ''}
+      ${optionalString cfg.showSignColumn ''
+        vim.o.signcolumn = "yes"
+      ''}
 
-    ${optionalString cfg.preventJunkFiles ''
-      vim.o.swapfile = false
-      vim.o.backup = false
-      vim.o.writebackup = false
-    ''}
+      ${optionalString cfg.autoIndent ''
+        vim.o.autoindent = true
+      ''}
 
-    ${optionalString (cfg.bell == "none") ''
-      vim.o.errorbells = false
-      vim.o.visualbell = false
-    ''}
+      ${optionalString cfg.preventJunkFiles ''
+        vim.o.swapfile = false
+        vim.o.backup = false
+        vim.o.writebackup = false
+      ''}
 
-    ${optionalString (cfg.bell == "on") ''
-      vim.o.visualbell = false
-    ''}
+      ${optionalString (cfg.bell == "none") ''
+        vim.o.errorbells = false
+        vim.o.visualbell = false
+      ''}
 
-    ${optionalString (cfg.bell == "visual") ''
-      vim.o.errorbells = false
-    ''}
+      ${optionalString (cfg.bell == "on") ''
+        vim.o.visualbell = false
+      ''}
 
-    ${optionalString (cfg.lineNumberMode == "relative") ''
-      vim.o.relativenumber = true
-    ''}
+      ${optionalString (cfg.bell == "visual") ''
+        vim.o.errorbells = false
+      ''}
 
-    ${optionalString (cfg.lineNumberMode == "number") ''
-      vim.o.number = true
-    ''}
+      ${optionalString (cfg.lineNumberMode == "relative") ''
+        vim.o.relativenumber = true
+      ''}
 
-    ${optionalString (cfg.lineNumberMode == "relNumber") ''
-      vim.o.number = true
-      vim.o.relativenumber = true
-    ''}
+      ${optionalString (cfg.lineNumberMode == "number") ''
+        vim.o.number = true
+      ''}
 
-    ${optionalString cfg.useSystemClipboard ''
-      vim.opt.clipboard:append("unnamedplus")
-    ''}
+      ${optionalString (cfg.lineNumberMode == "relNumber") ''
+        vim.o.number = true
+        vim.o.relativenumber = true
+      ''}
 
-    ${optionalString cfg.syntaxHighlighting ''
-      vim.cmd("syntax on")
-    ''}
+      ${optionalString cfg.useSystemClipboard ''
+        vim.opt.clipboard:append("unnamedplus")
+      ''}
 
-    ${optionalString (!cfg.wordWrap) ''
-      vim.o.wrap = false
-    ''}
+      ${optionalString cfg.syntaxHighlighting ''
+        vim.cmd("syntax on")
+      ''}
 
-    ${optionalString cfg.hideSearchHighlight ''
-      vim.o.hlsearch = false
-      vim.o.incsearch = true
-    ''}
+      ${optionalString (!cfg.wordWrap) ''
+        vim.o.wrap = false
+      ''}
 
-    ${optionalString cfg.colourTerm ''
-      vim.o.termguicolors = true
-    ''}
+      ${optionalString cfg.hideSearchHighlight ''
+        vim.o.hlsearch = false
+        vim.o.incsearch = true
+      ''}
 
-    ${optionalString (!cfg.enableEditorconfig) ''
-      vim.g.editorconfig = false
-    ''}
+      ${optionalString cfg.colourTerm ''
+        vim.o.termguicolors = true
+      ''}
 
-    ${optionalString (cfg.searchCase == "ignore") ''
-      vim.o.smartcase = false
-      vim.o.ignorecase = true
-    ''}
+      ${optionalString (!cfg.enableEditorconfig) ''
+        vim.g.editorconfig = false
+      ''}
 
-    ${optionalString (cfg.searchCase == "smart") ''
-      vim.o.smartcase = true
-      vim.o.ignorecase = true
-    ''}
+      ${optionalString (cfg.searchCase == "ignore") ''
+        vim.o.smartcase = false
+        vim.o.ignorecase = true
+      ''}
 
-    ${optionalString (cfg.searchCase == "sensitive") ''
-      vim.o.smartcase = false
-      vim.o.ignorecase = false
-    ''}
-  '';
+      ${optionalString (cfg.searchCase == "smart") ''
+        vim.o.smartcase = true
+        vim.o.ignorecase = true
+      ''}
+
+      ${optionalString (cfg.searchCase == "sensitive") ''
+        vim.o.smartcase = false
+        vim.o.ignorecase = false
+      ''}
+    '';
+  };
 }

modules/plugins/languages/ts.nix

@@ -17,12 +17,12 @@
 
   cfg = config.vim.languages.ts;
 
-  defaultServer = "tsserver";
+  defaultServer = "ts_ls";
   servers = {
-    tsserver = {
+    ts_ls = {
       package = pkgs.typescript-language-server;
       lspConfig = ''
-        lspconfig.tsserver.setup {
+        lspconfig.ts_ls.setup {
           capabilities = capabilities;
           on_attach = attach_keymaps,
           cmd = ${
@@ -49,6 +49,24 @@
         }
       '';
     };
+
+    # Here for backwards compatibility. Still consider tsserver a valid
+    # configuration in the enum, but assert if it's set to *properly*
+    # redirect the user to the correct server.
+    tsserver = {
+      package = pkgs.typescript-language-server;
+      lspConfig = ''
+        lspconfig.ts_ls.setup {
+          capabilities = capabilities;
+          on_attach = attach_keymaps,
+          cmd = ${
+          if isList cfg.lsp.package
+          then expToLua cfg.lsp.package
+          else ''{"${cfg.lsp.package}/bin/typescript-language-server", "--stdio"}''
+        }
+        }
+      '';
+    };
   };
 
   # TODO: specify packages
@@ -65,6 +83,7 @@
         )
       '';
     };
+
     prettierd = {
       package = pkgs.prettierd;
       nullConfig = ''
@@ -94,6 +113,7 @@
     };
   };
 in {
+  _file = ./ts.nix;
   options.vim.languages.ts = {
     enable = mkEnableOption "Typescript/Javascript language support";
 
@@ -190,11 +210,32 @@ in {
       };
     })
 
+    # Extensions
     (mkIf cfg.extensions."ts-error-translator".enable {
       vim.startPlugins = ["ts-error-translator"];
       vim.pluginRC.ts-error-translator = entryAnywhere ''
         require("ts-error-translator").setup(${toLuaObject cfg.extensions.ts-error-translator.setupOpts})
       '';
     })
+
+    # Warn the user if they have set the default server name to tsserver to match upstream (us)
+    # The name "tsserver" has been deprecated in lspconfig, and now should be called ts_ls. This
+    # is a purely cosmetic change, but emits a warning if not accounted for.
+    {
+      assertions = [
+        {
+          assertion = cfg.lsp.enable -> cfg.lsp.server != "tsserver";
+          message = ''
+            As of a recent lspconfig update, he `tsserver` configuration has been renamed
+            to `ts_ls` to match upstream behaviour of `lspconfig`, and the name `tsserver`
+            is no longer considered valid by nvf. Please set `vim.languages.ts.lsp.server`
+            to `"ts_ls"` instead of to `${cfg.lsp.server}`
+
+            Please see <https://github.com/neovim/nvim-lspconfig/pull/3232> for more details
+            about this change.
+          '';
+        }
+      ];
+    }
   ]);
 }

modules/plugins/lsp/default.nix

@@ -10,7 +10,6 @@
 
     # lsp plugins
     ./lspsaga
-    ./nvim-code-action-menu
     ./trouble
     ./lsp-signature
     ./lightbulb

modules/plugins/lsp/lspsaga/config.nix

@@ -36,7 +36,7 @@ in {
           (mkSetLuaBinding mappings.nextDiagnostic "require('lspsaga.diagnostic').navigate('next')")
           (mkSetLuaBinding mappings.previousDiagnostic "require('lspsaga.diagnostic').navigate('prev')")
 
-          (mkIf (!cfg.nvimCodeActionMenu.enable) (mkSetLuaBinding mappings.codeAction "require('lspsaga.codeaction').code_action"))
+          (mkSetLuaBinding mappings.codeAction "require('lspsaga.codeaction').code_action")
           (mkIf (!cfg.lspSignature.enable) (mkSetLuaBinding mappings.signatureHelp "require('lspsaga.signaturehelp').signature_help"))
         ];
       };

modules/plugins/lsp/nvim-code-action-menu/config.nix

@@ -1,38 +0,0 @@
-{
-  config,
-  lib,
-  ...
-}: let
-  inherit (lib.modules) mkIf;
-  inherit (lib.nvim.dag) entryAnywhere;
-  inherit (lib.nvim.binds) mkSetBinding addDescriptionsToMappings pushDownDefault;
-  inherit (lib.nvim.lua) toLuaObject;
-
-  cfg = config.vim.lsp;
-
-  self = import ./nvim-code-action-menu.nix {inherit lib;};
-  mappingDefinitions = self.options.vim.lsp.nvimCodeActionMenu.mappings;
-  mappings = addDescriptionsToMappings cfg.nvimCodeActionMenu.mappings mappingDefinitions;
-in {
-  config = mkIf (cfg.enable && cfg.nvimCodeActionMenu.enable) {
-    vim = {
-      startPlugins = ["nvim-code-action-menu"];
-
-      maps.normal = mkSetBinding mappings.open ":CodeActionMenu<CR>";
-
-      binds.whichKey.register = pushDownDefault {
-        "<leader>c" = "+CodeAction";
-      };
-
-      pluginRC.code-action-menu = entryAnywhere ''
-        -- border configuration
-        vim.g.code_action_menu_window_border = ${toLuaObject config.vim.ui.borders.plugins.code-action-menu.style}
-
-        -- show individual sections of the code action menu
-        ${lib.optionalString cfg.nvimCodeActionMenu.show.details "vim.g.code_action_menu_show_details = true"}
-        ${lib.optionalString cfg.nvimCodeActionMenu.show.diff "vim.g.code_action_menu_show_diff = true"}
-        ${lib.optionalString cfg.nvimCodeActionMenu.show.actionKind "vim.g.code_action_menu_show_action_kind = true"}
-      '';
-    };
-  };
-}

modules/plugins/lsp/nvim-code-action-menu/nvim-code-action-menu.nix

@@ -1,20 +0,0 @@
-{lib, ...}: let
-  inherit (lib.options) mkEnableOption;
-  inherit (lib.nvim.binds) mkMappingOption;
-in {
-  options.vim.lsp = {
-    nvimCodeActionMenu = {
-      enable = mkEnableOption "nvim code action menu";
-
-      show = {
-        details = mkEnableOption "Show details" // {default = true;};
-        diff = mkEnableOption "Show diff" // {default = true;};
-        actionKind = mkEnableOption "Show action kind" // {default = true;};
-      };
-
-      mappings = {
-        open = mkMappingOption "Open code action menu [nvim-code-action-menu]" "<leader>ca";
-      };
-    };
-  };
-}

modules/plugins/ui/borders/borders.nix

@@ -43,7 +43,7 @@ in {
       lspsaga = mkPluginStyleOption "lspsaga";
       nvim-cmp = mkPluginStyleOption "nvim-cmp";
       lsp-signature = mkPluginStyleOption "lsp-signature";
-      code-action-menu = mkPluginStyleOption "code-actions-menu";
+      fastaction = mkPluginStyleOption "fastaction";
     };
   };
 }

modules/plugins/ui/default.nix

@@ -8,5 +8,6 @@
     ./illuminate
     ./breadcrumbs
     ./borders
+    ./fastaction
   ];
 }

modules/plugins/ui/fastaction/config.nix

@@ -0,0 +1,24 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.modules) mkIf mkDefault;
+  inherit (lib.nvim.dag) entryAnywhere;
+  inherit (lib.nvim.lua) toLuaObject;
+
+  cfg = config.vim.ui.fastaction;
+  borderCfg = config.vim.ui.borders.plugins.fastaction;
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      ui.fastaction.setupOpts = {
+        register_ui_select = mkDefault true;
+        popup.border = mkIf borderCfg.enable borderCfg.style;
+      };
+
+      startPlugins = ["fastaction-nvim"];
+      pluginRC.fastaction = entryAnywhere "require('fastaction').setup(${toLuaObject cfg.setupOpts})";
+    };
+  };
+}

modules/plugins/ui/fastaction/default.nix

@@ -1,6 +1,6 @@
 {
   imports = [
-    ./nvim-code-action-menu.nix
+    ./fastaction-nvim.nix
     ./config.nix
   ];
 }

modules/plugins/ui/fastaction/fastaction-nvim.nix

@@ -0,0 +1,9 @@
+{lib, ...}: let
+  inherit (lib.options) mkEnableOption;
+  inherit (lib.nvim.types) mkPluginSetupOption;
+in {
+  options.vim.ui.fastaction = {
+    enable = mkEnableOption "overriding vim.ui.select with fastaction.nvim";
+    setupOpts = mkPluginSetupOption "fastaction" {};
+  };
+}

modules/plugins/visuals/config.nix

@@ -45,8 +45,6 @@ in {
               'noice',
               'NvimTree',
               'alpha',
-              'code-action-menu-menu',
-              'code-action-menu-warning-message',
               'notify',
               'Navbuddy'
             },