nvf/modules/plugins/languages/scala.nix

{
  config,
  pkgs,
  lib,
  ...
}: let
  inherit (lib) types optionalString;
  inherit (lib.modules) mkIf mkMerge;
  inherit (lib.nvim.types) mkGrammarOption;
  inherit (lib.nvim.binds) mkMappingOption;
  inherit (lib.options) mkOption mkEnableOption;
  inherit (lib.nvim.dag) entryAfter;

  mkBinding = binding: "vim.api.nvim_buf_set_keymap(bufnr, 'n', '${binding.value}', '<cmd>lua ${binding.action}<CR>', {noremap=true, silent=true, desc='${binding.description}'})";

  listCommandsBinding = {
    value = cfg.lsp.extraMappings.listCommands;
    description = "List Metals commands";
    action =
      if config.vim.telescope.enable
      then ''require("telescope").extensions.metals.commands()''
      else ''require("metals").commands()'';
  };

  cfg = config.vim.languages.scala;

  usingDap = config.vim.debugger.nvim-dap.enable && cfg.dap.enable;
  usingLualine = config.vim.statusline.lualine.enable;
in {
  options.vim.languages.scala = {
    enable = mkEnableOption "Scala language support";
    treesitter = {
      enable = mkEnableOption "Scala treesitter" // {default = config.vim.languages.enableTreesitter;};
      package = mkGrammarOption pkgs "scala";
    };
    lsp = {
      enable = mkEnableOption "Scala LSP support (metals)" // {default = config.vim.languages.enableLSP;};
      package = mkOption {
        type = types.package;
        default = pkgs.metals;
        description = ''
          metals package to use
        '';
      };
      extraMappings = {
        listCommands = mkMappingOption "List Metals commands" "<leader>lc";
      };
    };
    dap = {
      enable = mkOption {
        description = "Scala Debug Adapter support";
        type = types.bool;
        default = config.vim.languages.enableDAP;
      };
      config = mkOption {
        description = "Lua configuration for dap";
        type = types.str;
        default = ''
          dap.configurations.scala = {
            {
              type = "scala",
              request = "launch",
              name = "RunOrTest",
              metals = {
                runType = "runOrTestFile",
                --args = { "firstArg", "secondArg", "thirdArg" }, -- here just as an example
              },
            },
            {
              type = "scala",
              request = "launch",
              name = "Test Target",
              metals = {
                runType = "testTarget",
              },
            },
          }
        '';
      };
    };
  };
  config = mkIf cfg.enable (
    mkMerge [
      (mkIf cfg.treesitter.enable {
        vim.treesitter.enable = true;
        vim.treesitter.grammars = [cfg.treesitter.package];
      })
      (mkIf (cfg.lsp.enable || cfg.dap.enable) {
        vim = {
          startPlugins = ["nvim-metals"];
          luaConfigRC.nvim-metals = entryAfter ["lsp-setup"] ''
            -- Scala nvim-metals config
            local metals_caps = capabilities  -- from lsp-setup

            local attach_metals_keymaps = function(client, bufnr)
              attach_keymaps(client, bufnr)  -- from lsp-setup
              ${mkBinding listCommandsBinding}
            end

            metals_config = require('metals').bare_config()
            ${optionalString usingLualine "metals_config.init_options.statusBarProvider = 'on'"}

            metals_config.capabilities = metals_caps
            metals_config.on_attach = function(client, bufnr)
              ${optionalString usingDap "require('metals').setup_dap()"}
              attach_metals_keymaps(client, bufnr)
            end
            metals_config.settings = {
               metalsBinaryPath = "${cfg.lsp.package}/bin/metals",
               showImplicitArguments = true,
               showImplicitConversionsAndClasses = true,
               showInferredType = true,
               excludedPackages = {
                 "akka.actor.typed.javadsl",
                 "com.github.swagger.akka.javadsl"
               },

            }

            metals_config.handlers["textDocument/publishDiagnostics"] = vim.lsp.with(
              vim.lsp.diagnostic.on_publish_diagnostics, {
                virtual_text = {
                  prefix = '⚠',
                }
              }
            )


            -- without doing this, autocommands that deal with filetypes prohibit messages from being shown
            vim.opt_global.shortmess:remove("F")

            vim.cmd([[augroup lsp]])
            vim.cmd([[autocmd!]])
            vim.cmd([[autocmd FileType java,scala,sbt lua require('metals').initialize_or_attach(metals_config)]])
            vim.cmd([[augroup end]])
          '';
        };
      })
    ]
  );
}