Merge branch 'main' into fix-additional-rtp-override

modules/neovim/init/autocmds.nix

@@ -17,7 +17,7 @@
         mkEnableOption ""
         // {
           default = true;
-          description = "Whether to enable this autocommand";
+          description = "Whether to enable this autocommand.";
         };
 
       event = mkOption {
@@ -31,7 +31,7 @@
         type = nullOr (listOf str);
         default = null;
         example = ["*.lua" "*.vim"];
-        description = "The file pattern(s) that determine when the autocommand applies).";
+        description = "The file pattern(s) that determine when the autocommand applies.";
       };
 
       callback = mkOption {
@@ -44,13 +44,16 @@
             end
           ''''
         '';
-        description = "The file pattern(s) that determine when the autocommand applies.";
+        description = "Lua function to be called when the event(s) are triggered.";
       };
 
       command = mkOption {
         type = nullOr str;
         default = null;
-        description = "Vim command string instead of a Lua function.";
+        description = ''
+          Vim command to be executed when the event(s) are triggered.
+          Cannot be defined if the `callback` option is already defined.
+        '';
       };
 
       group = mkOption {
@@ -70,7 +73,7 @@
       once = mkOption {
         type = bool;
         default = false;
-        description = "Whether autocommand run only once.";
+        description = "Whether to run the autocommand only once.";
       };
 
       nested = mkOption {
@@ -87,7 +90,7 @@
         mkEnableOption ""
         // {
           default = true;
-          description = "Whether to enable this autogroup";
+          description = "Whether to enable this autocommand group.";
         };
 
       name = mkOption {
@@ -118,8 +121,8 @@ in {
         autocommands together. Groups allow multiple autocommands to be cleared
         or redefined collectively, preventing duplicate definitions.
 
-        Each autogroup consists of a name, a boolean indicating whether to clear
-        existing autocommands, and a list of associated autocommands.
+        Each autogroup consists of a name and a boolean indicating whether to clear
+        existing autocommands.
       '';
     };
 
@@ -129,8 +132,8 @@ in {
       description = ''
         A list of Neovim autocommands to be registered.
 
-        Each entry defines an autocommand, specifying events, patterns, optional
-        callbacks, commands, groups, and execution settings.
+        Each entry defines an autocommand, specifying events, patterns, a callback or Vim
+        command, an optional group, a description, and execution settings.
       '';
     };
   };

modules/plugins/diagnostics/nvim-lint/config.nix

@@ -28,6 +28,8 @@ in {
               end
             end
           end
+
+          nvf_lint = ${toLuaObject cfg.lint_function}
         '';
       };
     })
@@ -38,8 +40,8 @@ in {
           {
             event = ["BufWritePost"];
             callback = mkLuaInline ''
-              function()
-                require("lint").try_lint()
+              function(args)
+                nvf_lint(args.buf)
               end
             '';
           }

modules/plugins/diagnostics/nvim-lint/nvim-lint.nix

@@ -1,7 +1,8 @@
 {lib, ...}: let
-  inherit (lib.options) mkOption mkEnableOption;
+  inherit (lib.options) mkOption mkEnableOption literalExpression;
   inherit (lib.types) nullOr attrsOf listOf str either submodule bool enum;
   inherit (lib.nvim.types) luaInline;
+  inherit (lib.generators) mkLuaInline;
 
   linterType = submodule {
     options = {
@@ -69,6 +70,23 @@
         default = null;
         description = "Parser function";
       };
+
+      required_files = mkOption {
+        type = nullOr (listOf str);
+        default = null;
+        example = ["eslint.config.js"];
+        description = ''
+          Required files to lint. These files must exist relative to the cwd
+          of the linter or else this linter will be skipped
+
+          ::: {.note}
+          This option is an nvf extension that only takes effect if you
+          use the `nvf_lint()` lua function.
+
+          See {option}`vim.diagnostics.nvim-lint.lint_function`.
+          :::
+        '';
+      };
     };
   };
 in {
@@ -117,5 +135,53 @@ in {
     };
 
     lint_after_save = mkEnableOption "autocmd to lint after each save" // {default = true;};
+
+    lint_function = mkOption {
+      type = luaInline;
+      default = mkLuaInline ''
+        function(buf)
+          local ft = vim.api.nvim_get_option_value("filetype", { buf = buf })
+          local linters = require("lint").linters
+          local linters_from_ft = require("lint").linters_by_ft[ft]
+
+          -- if no linter is configured for this filetype, stops linting
+          if linters_from_ft == nil then return end
+
+          for _, name in ipairs(linters_from_ft) do
+            local linter = linters[name]
+            assert(linter, 'Linter with name `' .. name .. '` not available')
+
+            if type(linter) == "function" then
+              linter = linter()
+            end
+            -- for require("lint").lint() to work, linter.name must be set
+            linter.name = linter.name or name
+            local cwd = linter.required_files
+
+            -- if no configuration files are configured, lint
+            if cwd == nil then
+              require("lint").lint(linter)
+            else
+              -- if configuration files are configured and present in the project, lint
+              for _, fn in ipairs(cwd) do
+                local path = vim.fs.joinpath(linter.cwd or vim.fn.getcwd(), fn);
+                if vim.uv.fs_stat(path) then
+                  require("lint").lint(linter)
+                  break
+                end
+              end
+            end
+          end
+        end
+      '';
+      example = literalExpression ''
+        mkLuaInline '''
+          function(buf)
+            require("lint").try_lint()
+          end
+        '''
+      '';
+      description = "Define the global function nvf_lint which is used by nvf to lint.";
+    };
   };
 }

modules/plugins/languages/astro.nix

@@ -53,24 +53,20 @@
   # TODO: specify packages
   defaultDiagnosticsProvider = ["eslint_d"];
   diagnosticsProviders = {
-    eslint_d = {
-      package = pkgs.eslint_d;
+    eslint_d = let
+      pkg = pkgs.eslint_d;
+    in {
+      package = pkg;
       config = {
-        # HACK: change if nvim-lint gets a dynamic enable thing
-        parser = mkLuaInline ''
-          function(output, bufnr, cwd)
-            local markers = { "eslint.config.js", "eslint.config.mjs",
-              ".eslintrc", ".eslintrc.json", ".eslintrc.js", ".eslintrc.yml", }
-            for _, filename in ipairs(markers) do
-              local path = vim.fs.joinpath(cwd, filename)
-              if vim.loop.fs_stat(path) then
-                return require("lint.linters.eslint_d").parser(output, bufnr, cwd)
-              end
-            end
-
-            return {}
-          end
-        '';
+        cmd = getExe pkg;
+        required_files = [
+          "eslint.config.js"
+          "eslint.config.mjs"
+          ".eslintrc"
+          ".eslintrc.json"
+          ".eslintrc.js"
+          ".eslintrc.yml"
+        ];
       };
     };
   };
@@ -153,16 +149,9 @@ in {
       vim.diagnostics.nvim-lint = {
         enable = true;
         linters_by_ft.astro = cfg.extraDiagnostics.types;
-        linters = mkMerge (map (
-            name: {
-              ${name} =
-                diagnosticsProviders.${name}.config
-                // {
-                  cmd = getExe diagnosticsProviders.${name}.package;
-                };
-            }
-          )
-          cfg.extraDiagnostics.types);
+        linters =
+          mkMerge (map (name: {${name} = diagnosticsProviders.${name}.config;})
+            cfg.extraDiagnostics.types);
       };
     })
   ]);

modules/plugins/languages/dart.nix

@@ -13,7 +13,7 @@
   inherit (lib.strings) optionalString;
   inherit (lib.nvim.lua) expToLua;
   inherit (lib.nvim.types) mkGrammarOption;
-  inherit (lib.nvim.dag) entryAnywhere;
+  inherit (lib.nvim.dag) entryAfter;
 
   cfg = config.vim.languages.dart;
   ftcfg = cfg.flutter-tools;
@@ -81,16 +81,25 @@ in {
         description = "Enable flutter-tools for flutter support";
       };
 
+      flutterPackage = mkOption {
+        type = nullOr package;
+        default = pkgs.flutter;
+        description = "Flutter package, or null to detect the flutter path at runtime instead.";
+      };
+
       enableNoResolvePatch = mkOption {
         type = bool;
-        default = true;
+        default = false;
         description = ''
           Whether to patch flutter-tools so that it doesn't resolve
           symlinks when detecting flutter path.
 
-          This is required if you want to use a flutter package built with nix.
-          If you are using a flutter SDK installed from a different source
-          and encounter the error "`dart` missing from PATH", disable this option.
+          ::: {.note}
+          This is required if `flutterPackage` is set to null and the flutter
+          package in your `PATH` was built with Nix. If you are using a flutter
+          SDK installed from a different source and encounter the error "`dart`
+          missing from `PATH`", leave this option disabled.
+          :::
         '';
       };
 
@@ -122,19 +131,21 @@ in {
     };
   };
 
-  config = mkIf cfg.enable (mkMerge [
+  config.vim = mkIf cfg.enable (mkMerge [
     (mkIf cfg.treesitter.enable {
-      vim.treesitter.enable = true;
-      vim.treesitter.grammars = [cfg.treesitter.package];
+      treesitter.enable = true;
+      treesitter.grammars = [cfg.treesitter.package];
     })
 
     (mkIf cfg.lsp.enable {
-      vim.lsp.lspconfig.enable = true;
-      vim.lsp.lspconfig.sources.dart-lsp = servers.${cfg.lsp.server}.lspConfig;
+      lsp.lspconfig.enable = true;
+      lsp.lspconfig.sources.dart-lsp = servers.${cfg.lsp.server}.lspConfig;
     })
 
     (mkIf ftcfg.enable {
-      vim.startPlugins = [
+      lsp.enable = true;
+
+      startPlugins = [
         (
           if ftcfg.enableNoResolvePatch
           then "flutter-tools-patched"
@@ -143,8 +154,9 @@ in {
         "plenary-nvim"
       ];
 
-      vim.pluginRC.flutter-tools = entryAnywhere ''
+      pluginRC.flutter-tools = entryAfter ["lsp-setup"] ''
         require('flutter-tools').setup {
+          ${optionalString (ftcfg.flutterPackage != null) "flutter_path = \"${ftcfg.flutterPackage}/bin/flutter\","}
           lsp = {
             color = { -- show the derived colours for dart variables
               enabled = ${boolToString ftcfg.color.enable}, -- whether or not to highlight color variables at all, only supported on flutter >= 2.10
@@ -156,7 +168,6 @@ in {
 
             capabilities = capabilities,
             on_attach = default_on_attach;
-            flags = lsp_flags,
           },
           ${optionalString cfg.dap.enable ''
           debugger = {

modules/plugins/languages/go.nix

@@ -5,7 +5,7 @@
   ...
 }: let
   inherit (builtins) attrNames;
-  inherit (lib.options) mkEnableOption mkOption;
+  inherit (lib.options) mkEnableOption mkOption literalMD;
   inherit (lib.modules) mkIf mkMerge;
   inherit (lib.meta) getExe;
   inherit (lib.lists) isList;
@@ -84,7 +84,14 @@ in {
     };
 
     format = {
-      enable = mkEnableOption "Go formatting" // {default = config.vim.languages.enableFormat;};
+      enable =
+        mkEnableOption "Go formatting"
+        // {
+          default = !cfg.lsp.enable && config.vim.languages.enableFormat;
+          defaultText = literalMD ''
+            disabled if Go LSP is enabled, otherwise follows {option}`vim.languages.enableFormat`
+          '';
+        };
 
       type = mkOption {
         description = "Go formatter to use";

modules/plugins/languages/python.nix

@@ -99,7 +99,7 @@
       # idk if this is the best way to install/run debugpy
       package = pkgs.python3.withPackages (ps: with ps; [debugpy]);
       dapConfig = ''
-        dap.adapters.python = function(cb, config)
+        dap.adapters.debugpy = function(cb, config)
           if config.request == 'attach' then
             ---@diagnostic disable-next-line: undefined-field
             local port = (config.connect or config).port
@@ -125,10 +125,10 @@
           end
         end
 
-        dap.configurations.python = {
+        dap.configurations.debugpy = {
           {
             -- The first three options are required by nvim-dap
-            type = 'python'; -- the type here established the link to the adapter definition: `dap.adapters.python`
+            type = 'debugpy'; -- the type here established the link to the adapter definition: `dap.adapters.debugpy`
             request = 'launch';
             name = "Launch file";
 

modules/plugins/languages/svelte.nix

@@ -55,21 +55,14 @@
       package = pkg;
       config = {
         cmd = getExe pkg;
-        # HACK: change if nvim-lint gets a dynamic enable thing
-        parser = mkLuaInline ''
-          function(output, bufnr, cwd)
-            local markers = { "eslint.config.js", "eslint.config.mjs",
-              ".eslintrc", ".eslintrc.json", ".eslintrc.js", ".eslintrc.yml", }
-            for _, filename in ipairs(markers) do
-              local path = vim.fs.joinpath(cwd, filename)
-              if vim.loop.fs_stat(path) then
-                return require("lint.linters.eslint_d").parser(output, bufnr, cwd)
-              end
-            end
-
-            return {}
-          end
-        '';
+        required_files = [
+          "eslint.config.js"
+          "eslint.config.mjs"
+          ".eslintrc"
+          ".eslintrc.json"
+          ".eslintrc.js"
+          ".eslintrc.yml"
+        ];
       };
     };
   };

modules/plugins/languages/ts.nix

@@ -91,27 +91,20 @@
   # TODO: specify packages
   defaultDiagnosticsProvider = ["eslint_d"];
   diagnosticsProviders = {
-    eslint_d = {
-      package = pkgs.eslint_d;
-      config = let
-        pkg = pkgs.eslint_d;
-      in {
+    eslint_d = let
+      pkg = pkgs.eslint_d;
+    in {
+      package = pkg;
+      config = {
         cmd = getExe pkg;
-        # HACK: change if nvim-lint gets a dynamic enable thing
-        parser = mkLuaInline ''
-          function(output, bufnr, cwd)
-            local markers = { "eslint.config.js", "eslint.config.mjs",
-              ".eslintrc", ".eslintrc.json", ".eslintrc.js", ".eslintrc.yml", }
-            for _, filename in ipairs(markers) do
-              local path = vim.fs.joinpath(cwd, filename)
-              if vim.loop.fs_stat(path) then
-                return require("lint.linters.eslint_d").parser(output, bufnr, cwd)
-              end
-            end
-
-            return {}
-          end
-        '';
+        required_files = [
+          "eslint.config.js"
+          "eslint.config.mjs"
+          ".eslintrc"
+          ".eslintrc.json"
+          ".eslintrc.js"
+          ".eslintrc.yml"
+        ];
       };
     };
   };
@@ -221,10 +214,9 @@ in {
         linters_by_ft.typescript = cfg.extraDiagnostics.types;
         linters_by_ft.typescriptreact = cfg.extraDiagnostics.types;
 
-        linters = mkMerge (map (name: {
-            ${name}.cmd = getExe diagnosticsProviders.${name}.package;
-          })
-          cfg.extraDiagnostics.types);
+        linters =
+          mkMerge (map (name: {${name} = diagnosticsProviders.${name}.config;})
+            cfg.extraDiagnostics.types);
       };
     })