init.lua

---@class remote-nvim.RemoteNeovim
---@field default_opts remote-nvim.config.PluginConfig Default plugin configuration
---@field config remote-nvim.config.PluginConfig Plugin configuration
---@field session_provider remote-nvim.providers.SessionProvider Session provider for each unique host
---@field setup fun(opts: remote-nvim.config.PluginConfig) Setup the plugin
local M = {}

local constants = require("remote-nvim.constants")
local utils = require("remote-nvim.utils")

---@alias prompt_type "plain"|"secret"
---@alias prompt_value_type "static"|"dynamic"
---@alias devcontainer_cfg_search_style "current_dir_only"|"recurse_up"
---@alias container_list_opts "running_only"|"all"

---@class remote-nvim.config.PluginConfig.DevpodConfig.DotfilesConfig
---@field path string? Path to your dotfiles which should be copied into devcontainers
---@field install_script string? Install script that should be called to install your dotfiles

---@class remote-nvim.config.PluginConfig.DevpodConfig
---@field binary string Name of binary on runtime path for dev container
---@field docker_binary string Name of the binary to use for docker containers
---@field ssh_config_path string Configuration path where devpod SSH configurations would be stored
---@field search_style devcontainer_cfg_search_style Where to search for devcontainer configuration
---@field dotfiles remote-nvim.config.PluginConfig.DevpodConfig.DotfilesConfig? Path/URI to dotfiles to use in the container
---@field gpg_agent_forwarding boolean Should forward the local GPG Agent into workspace
---@field container_list container_list_opts Show only running or all containers in container list

---@class remote-nvim.config.PluginConfig.SSHConfig.SSHPrompt
---@field match string Text that input should be matched against to identify need for stdin
---@field type prompt_type Is the input to be provided a secret?
---@field input_prompt string? What should be shown as input prompt when requesting user for input
---@field value_type prompt_value_type Is the prompt value going to remain same throughout a session, if yes, it can be cached
---@field value string Default value to fill in for the prompt, if any

---@class remote-nvim.config.PluginConfig.SSHConfig
---@field ssh_binary string Name of binary on runtime path for ssh
---@field scp_binary string Name of binary on runtime path for scp
---@field ssh_config_file_paths string[] Location of SSH configuration files that you want the plugin to consider
---@field ssh_prompts remote-nvim.config.PluginConfig.SSHConfig.SSHPrompt[] List of SSH prompts that should be considered for input

---@class remote-nvim.config.RemoteConfig.LocalClientConfig
---@field callback function<string, remote-nvim.providers.WorkspaceConfig> Function that would be called upon to start a Neovim client

---@class remote-nvim.config.PluginConfig.LogConfig
---@field filepath string Location of log file
---@field level string Logging level
---@field max_size integer Max file size, after which it will be truncated

---@class remote-nvim.config.PluginConfig.OfflineModeConfig
---@field enabled boolean Is the offline mode enabled
---@field no_github boolean Do not reach to GitHub at all
---@field cache_dir string Path to the cache directory

---@class remote-nvim.config.PluginConfig.ProgressViewConfig
---@field type "popup"|"split" Type of holder to launch
---@field relative nui_layout_option_relative_type|nui_layout_option_relative? How should split/popup be placed
---@field position  number|string|nui_layout_option_position|nui_split_option_position? Where should the holder be placed
---@field size number|string|nui_layout_option_size|nui_split_option_size? What should be the size of the holder
---@field border _nui_popup_border_style_builtin|nui_popup_border_options? What kind of border should be applied to the popup
---@field anchor nui_layout_option_anchor? What to anchor the popup with
---@field zindex number? What should be the z-index for the popup

---@class remote-nvim.config.PluginConfig.Remote.CopyDirs.FolderStructure
---@field base string Path to the base directory
---@field dirs "*"|string[] "*" means all directories in the path. When a string array is specified, it means subdirectories in the `base` directory
---@field compression remote-nvim.provider.Executor.JobOpts.CompressionOpts? Should the transfer be compressed or uncompressed

---@class remote-nvim.config.PluginConfig.Remote.CopyDirs
---@field config remote-nvim.config.PluginConfig.Remote.CopyDirs.FolderStructure Directory to copy over into remote XDG_CONFIG_HOME/nvim. Default is output of :lua= vim.fn.stdpath("config"). Default `base` when not specified is vim.fn.stdpath("config").
---@field data remote-nvim.config.PluginConfig.Remote.CopyDirs.FolderStructure Directory to copy over into remote XDG_DATA_HOME/nvim. Default is nothing. If base is not specified, it is assumed to be :lua= vim.fn.stdpath("data")
---@field state remote-nvim.config.PluginConfig.Remote.CopyDirs.FolderStructure Directory to copy over into remote XDG_STATE_HOME/nvim. Default is nothing. If base is not specified, it is assumed to be :lua= vim.fn.stdpath("state")
---@field cache remote-nvim.config.PluginConfig.Remote.CopyDirs.FolderStructure Directory to copy over into remote XDG_CACHE_HOME/nvim. Default is nothing. If base is not specified, it is assumed to be :lua= vim.fn.stdpath("cache")

---@alias install_nvim_policy "prompt"|"relax"|"always"
---@alias upload_config_policy "never"|"prompt"|"relax"|"always"
---@alias launch_cmd_prefix string launch command prefix for starting neovim on remote

---@class remote-nvim.config.PluginConfig.Remote
---@field copy_dirs remote-nvim.config.PluginConfig.Remote.CopyDirs Which directories should be copied over to the remote
---@field app_name string Neovim app name which should be used throughout
---@field install_nvim_policy install_nvim_policy Policy for installing Neovim on remote ("prompt": ask user, "relax": only if not executable, "always": always install)
---@field upload_config_policy upload_config_policy Policy for uploading config to remote ("never": never upload, "prompt": always ask user using config_copy variable, "relax": skip if exists and don't use NVIM_APPNAME, upload with NVIM_APPNAME if not exists, "always": always upload with NVIM_APPNAME)
---@field search_binary_pathes string[] Additional paths to search for nvim binary when install_policy is "relax"

---@class remote-nvim.config.PluginConfig
---@field devpod remote-nvim.config.PluginConfig.DevpodConfig Devcontainer configuration
---@field ssh_config remote-nvim.config.PluginConfig.SSHConfig SSH configuration
---@field neovim_install_script_path string Local path where neovim installation script is stored
---@field neovim_user_config_path string? Local path where the neovim configuration to be copied over to the remote
---@field remote remote-nvim.config.PluginConfig.Remote Configurations related to the remote
--server is stored. This is assumed to be a directory and entire directory would be copied over
---@field progress_view remote-nvim.config.PluginConfig.ProgressViewConfig Progress view configuration
---@field local_client_config remote-nvim.config.RemoteConfig.LocalClientConfig? Configuration for the local client
---@field client_callback function<string, remote-nvim.providers.WorkspaceConfig> Function that would be called upon to start a Neovim client
---@field offline_mode remote-nvim.config.PluginConfig.OfflineModeConfig Offline mode configuration
---@field log remote-nvim.config.PluginConfig.LogConfig Plugin logging options

M.default_opts = {
  devpod = {
    binary = "devpod",
    docker_binary = "docker",
    ---@diagnostic disable-next-line:param-type-mismatch
    ssh_config_path = utils.path_join(utils.is_windows, vim.fn.stdpath("data"), constants.PLUGIN_NAME, "ssh_config"),
    search_style = "current_dir_only",
    dotfiles = {
      path = nil,
      install_script = nil,
    },
    gpg_agent_forwarding = false,
    container_list = "running_only",
  },
  ssh_config = {
    ssh_binary = "ssh",
    scp_binary = "scp",
    ssh_config_file_paths = { "$HOME/.ssh/config" },
    ssh_prompts = {
      { -- Handle default password style on Linux/macOS
        match = "password:",
        type = "secret",
        value_type = "static",
        value = "",
      },
      { -- Handle unknown host upon SSH
        match = "continue connecting (yes/no/[fingerprint])?",
        type = "plain",
        value_type = "static",
        value = "",
      },
      { -- FreeBSD Default SSH Prompt style
        match = "Password for",
        type = "secret",
        value_type = "static",
        value = "",
      },
      {
        -- Because of https://github.com/amitds1997/remote-nvim.nvim/issues/94
        -- This could also be adjusted using case-insensitive search; but we would
        -- not be doing that right now
        match = "Password:",
        type = "secret",
        value_type = "static",
        value = "",
      },
      { -- Handle SSH-key with passphrases
        match = "Enter passphrase",
        type = "secret",
        value_type = "static",
        value = "",
      },
    },
  },
  remote = {
    app_name = "nvim",
    install_nvim_policy = "always",
    upload_config_policy = "always",
    launch_cmd_prefix = nil,
    search_binary_pathes = {},
    copy_dirs = {
      config = {
        ---@diagnostic disable-next-line:assign-type-mismatch
        base = vim.fn.stdpath("config"),
        dirs = "*",
        compression = {
          enabled = false,
        },
      },
      data = {
        ---@diagnostic disable-next-line:assign-type-mismatch
        base = vim.fn.stdpath("data"),
        dirs = {},
        compression = {
          enabled = true,
        },
      },
      cache = {
        ---@diagnostic disable-next-line:assign-type-mismatch
        base = vim.fn.stdpath("cache"),
        dirs = {},
        compression = {
          enabled = true,
        },
      },
      state = {
        ---@diagnostic disable-next-line:assign-type-mismatch
        base = vim.fn.stdpath("state"),
        dirs = {},
        compression = {
          enabled = true,
        },
      },
    },
  },
  client_callback = function(port, _)
    require("remote-nvim.ui").float_term(("nvim --server localhost:%s --remote-ui"):format(port), function(exit_code)
      if exit_code ~= 0 then
        vim.notify(("Local client failed with exit code %s"):format(exit_code), vim.log.levels.ERROR)
      end
    end)
  end,
  neovim_install_script_path = utils.path_join(
    utils.is_windows,
    utils.get_plugin_root(),
    "scripts",
    "neovim_install.sh"
  ),
  progress_view = {
    type = "popup",
  },
  offline_mode = {
    enabled = false,
    no_github = false,
    ---@diagnostic disable-next-line:param-type-mismatch
    cache_dir = utils.path_join(utils.is_windows, vim.fn.stdpath("cache"), constants.PLUGIN_NAME, "version_cache"),
  },
  log = {
    ---@diagnostic disable-next-line:param-type-mismatch
    filepath = utils.path_join(utils.is_windows, vim.fn.stdpath("state"), ("%s.log"):format(constants.PLUGIN_NAME)),
    level = "info",
    max_size = 1024 * 1024 * 2, -- 2MB
  },
}

---Setup for the plugin
---@param opts remote-nvim.config.PluginConfig User provided plugin configuration
---@return nil
M.setup = function(opts)
  local min_neovim_version = require("remote-nvim.constants").MIN_NEOVIM_VERSION:sub(2)
  if not vim.fn.has(("nvim-%s"):format(min_neovim_version)) then
    vim.notify_once(
      ("remote-nvim.nvim requires Neovim >= %s"):format(min_neovim_version),
      vim.log.levels.ERROR,
      { title = "remote-nvim.nvim" }
    )
  end
  M.config =
    require("remote-nvim.deprecation").handle_deprecations(vim.tbl_deep_extend("force", M.default_opts, opts or {}))

  M.session_provider = require("remote-nvim.providers.session_provider")()
  require("remote-nvim.command")
  require("remote-nvim.colors").setup()

  utils.truncate_log()
end

return M