Merge pull request #821 from rice-cracker-dev/lint-required-files

nvim-lint: added required files support

docs/release-notes/rl-0.8.md

@@ -289,7 +289,9 @@
 [rice-cracker-dev](https://github.com/rice-cracker-dev):
 
 - `eslint_d` now checks for configuration files to load.
-- Fixed an error where `eslint_d` fails to load.
+- Fix an error where `eslint_d` fails to load.
+- Add required files support for linters under `vim.diagnostics.nvim-lint.linters.*.required_files`.
+- Add global function `nvf_lint` under `vim.diagnostics.nvim-lint.lint_function`.
 
 [Sc3l3t0n](https://github.com/Sc3l3t0n):
 

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

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
+        required_files = [
-        parser = mkLuaInline ''
+          "eslint.config.js"
-          function(output, bufnr, cwd)
+          "eslint.config.mjs"
-            local markers = { "eslint.config.js", "eslint.config.mjs",
+          ".eslintrc"
-              ".eslintrc", ".eslintrc.json", ".eslintrc.js", ".eslintrc.yml", }
+          ".eslintrc.json"
-            for _, filename in ipairs(markers) do
+          ".eslintrc.js"
-              local path = vim.fs.joinpath(cwd, filename)
+          ".eslintrc.yml"
-              if vim.loop.fs_stat(path) then
+        ];
-                return require("lint.linters.eslint_d").parser(output, bufnr, cwd)
-              end
-            end
-
-            return {}
-          end
-        '';
       };
     };
   };

modules/plugins/languages/ts.nix

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