nvf/modules/plugins/lsp/otter/otter.nix

{
  config,
  lib,
  ...
}: let
  inherit (lib.options) mkOption mkEnableOption;
  inherit (lib.types) bool str listOf;
  inherit (lib.nvim.types) mkPluginSetupOption;
  inherit (config.vim.lib) mkMappingOption;
in {
  options.vim.lsp = {
    otter-nvim = {
      enable = mkEnableOption ''
        lsp features and a code completion source for code embedded in other documents [otter-nvim]
      '';
      mappings = {
        toggle = mkMappingOption "Activate LSP on Cursor Position [otter-nvim]" "<leader>lo";
      };
      setupOpts = mkPluginSetupOption "otter.nvim" {
        lsp = {
          diagnostic_update_event = mkOption {
            type = listOf str;
            default = ["BufWritePost"];
            description = ''
              `:h events` that cause the diagnostic to update.
              Set to: {"BufWritePost", "InsertLeave", "TextChanged" }
              for less performant but more instant diagnostic updates
            '';
          };
        };
        buffers = {
          write_to_disk = mkOption {
            type = bool;
            default = false;
            description = ''
              write <path>.otter.<embedded language extension> files to disk on save of main buffer.
              Useful for some linters that require actual files.
              Otter files are deleted on quit or main buffer close
            '';
          };
        };
        strip_wrapping_quote_characters = mkOption {
          type = listOf str;
          default = ["'" ''"'' "`"];
          description = ''
          '';
        };
        handle_leading_whitespace = mkOption {
          type = bool;
          default = false;
          description = ''
            otter may not work the way you expect when entire code blocks are indented
            (eg. in Org files) When true, otter handles these cases fully.
          '';
        };
      };
    };
  };
}