nvf/modules/plugins/languages/sql.nix

{
  config,
  pkgs,
  lib,
  ...
}: let
  inherit (builtins) attrNames;
  inherit (lib.options) mkEnableOption mkOption literalExpression;
  inherit (lib.meta) getExe;
  inherit (lib.modules) mkIf mkMerge;
  inherit (lib.types) enum package str;
  inherit (lib.nvim.types) diagnostics deprecatedSingleOrListOf;
  inherit (lib.nvim.attrsets) mapListToAttrs;
  inherit (lib.generators) mkLuaInline;

  cfg = config.vim.languages.sql;
  sqlfluffDefault = pkgs.sqlfluff;
  sqruffDefault = pkgs.sqruff;

  defaultServers = ["sqls"];
  servers = {
    sqls = {
      enable = true;
      cmd = [(getExe pkgs.sqls)];
      filetypes = ["sql" "mysql"];
      root_markers = ["config.yml"];
      settings = {};
      on_attach = mkLuaInline ''
        function(client, bufnr)
          client.server_capabilities.execute_command = true
          require'sqls'.setup{}
        end
      '';
    };
  };

  defaultFormat = ["sqlfluff"];
  formats = {
    sqlfluff = {
      command = getExe sqlfluffDefault;
      append_args = ["--dialect=${cfg.dialect}"];
    };
    sqruff = {
      command = getExe sqruffDefault;
      append_args = ["--dialect=${cfg.dialect}"];
    };
  };

  defaultDiagnosticsProvider = ["sqlfluff"];
  diagnosticsProviders = {
    sqlfluff = {
      package = sqlfluffDefault;
      config = {
        cmd = getExe sqlfluffDefault;
        args = ["lint" "--format=json" "--dialect=${cfg.dialect}"];
      };
    };
    sqruff = {
      package = sqruffDefault;
      config = {
        cmd = getExe sqruffDefault;
        args = ["lint" "--format=json" "--dialect=${cfg.dialect}" "-"];
      };
    };
  };
in {
  options.vim.languages.sql = {
    enable = mkEnableOption "SQL language support";

    dialect = mkOption {
      type = str;
      default = "ansi";
      description = "SQL dialect for formatters and diagnostics (if used)";
    };

    treesitter = {
      enable =
        mkEnableOption "SQL treesitter"
        // {
          default = config.vim.languages.enableTreesitter;
          defaultText = literalExpression "config.vim.languages.enableTreesitter";
        };

      package = mkOption {
        type = package;
        default = pkgs.vimPlugins.nvim-treesitter.grammarPlugins.sql;
        description = "SQL treesitter grammar to use";
      };
    };

    lsp = {
      enable =
        mkEnableOption "SQL LSP support"
        // {
          default = config.vim.lsp.enable;
          defaultText = literalExpression "config.vim.lsp.enable";
        };

      servers = mkOption {
        type = deprecatedSingleOrListOf "vim.language.sql.lsp.servers" (enum (attrNames servers));
        default = defaultServers;
        description = "SQL LSP server to use";
      };
    };

    format = {
      enable =
        mkEnableOption "SQL formatting"
        // {
          default = config.vim.languages.enableFormat;
          defaultText = literalExpression "config.vim.languages.enableFormat";
        };

      type = mkOption {
        type = deprecatedSingleOrListOf "vim.language.sql.format.type" (enum (attrNames formats));
        default = defaultFormat;
        description = "SQL formatter to use";
      };
    };

    extraDiagnostics = {
      enable =
        mkEnableOption "extra SQL diagnostics"
        // {
          default = config.vim.languages.enableExtraDiagnostics;
          defaultText = literalExpression "config.vim.languages.enableExtraDiagnostics";
        };

      types = diagnostics {
        langDesc = "SQL";
        inherit diagnosticsProviders;
        inherit defaultDiagnosticsProvider;
      };
    };
  };

  config = mkIf cfg.enable (mkMerge [
    (mkIf cfg.treesitter.enable {
      vim.treesitter.enable = true;
      vim.treesitter.grammars = [cfg.treesitter.package];
    })

    (mkIf cfg.lsp.enable {
      vim = {
        startPlugins = ["sqls-nvim"];

        lsp.servers =
          mapListToAttrs (n: {
            name = n;
            value = servers.${n};
          })
          cfg.lsp.servers;
      };
    })

    (mkIf cfg.format.enable {
      vim.formatter.conform-nvim = {
        enable = true;
        setupOpts = {
          formatters_by_ft.sql = cfg.format.type;
          formatters =
            mapListToAttrs (name: {
              inherit name;
              value = formats.${name};
            })
            cfg.format.type;
        };
      };
    })

    (mkIf cfg.extraDiagnostics.enable {
      vim.diagnostics.nvim-lint = {
        enable = true;
        linters_by_ft.sql = cfg.extraDiagnostics.types;
        linters =
          mkMerge (map (name: {${name} = diagnosticsProviders.${name}.config;})
            cfg.extraDiagnostics.types);
      };
    })
  ]);
}