nix-community.nixvim/plugins/by-name/cmp-git/settings-options.nix

{ lib }:
let
  inherit (lib) types;
  inherit (lib.nixvim) defaultNullOpts;

  mkAction =
    action: target:
    defaultNullOpts.mkLuaFn "require('cmp_git.${action}').git.${target}" ''
      Function used to ${action} the ${lib.replaceStrings [ "_" ] [ " " ] target}.
    '';
in
{

  filetypes = defaultNullOpts.mkListOf types.str [
    "gitcommit"
    "octo"
  ] "Filetypes for which to trigger.";

  remotes = defaultNullOpts.mkListOf types.str [
    "upstream"
    "origin"
  ] "List of git remotes.";

  enableRemoteUrlRewrites = defaultNullOpts.mkBool false ''
    Whether to enable remote URL rewrites.
  '';

  git = {
    commits = {
      limit = defaultNullOpts.mkUnsignedInt 100 ''
        Max number of git commits to fetch.
      '';

      sort_by = mkAction "sort" "commits";
      format = mkAction "format" "commits";
    };
  };

  github = {
    hosts = defaultNullOpts.mkListOf types.str [ ] ''
      List of private instances of github.
    '';

    issues = {
      fields = defaultNullOpts.mkListOf types.str [
        "title"
        "number"
        "body"
        "updatedAt"
        "state"
      ] "The fields used for issues.";

      filter = defaultNullOpts.mkStr "all" ''
        The filter to use when fetching issues.
      '';

      limit = defaultNullOpts.mkUnsignedInt 100 ''
        Max number of issues to fetch.
      '';

      state = defaultNullOpts.mkStr "open" ''
        Which issues to fetch (`"open"`, `"closed"` or `"all"`).
      '';

      sort_by = mkAction "sort" "issues";
      format = mkAction "format" "issues";
    };

    mentions = {
      limit = defaultNullOpts.mkUnsignedInt 100 ''
        Max number of mentions to fetch.
      '';

      sort_by = mkAction "sort" "mentions";
      format = mkAction "format" "mentions";
    };

    pull_requests = {
      fields = defaultNullOpts.mkListOf types.str [
        "title"
        "number"
        "body"
        "updatedAt"
        "state"
      ] "The fields used for pull requests.";

      limit = defaultNullOpts.mkUnsignedInt 100 ''
        Max number of pull requests to fetch.
      '';

      state = defaultNullOpts.mkStr "open" ''
        Which issues to fetch (`"open"`, `"closed"`, `"merged"` or `"all"`).
      '';

      sort_by = mkAction "sort" "pull_requests";
      format = mkAction "format" "pull_requests";
    };
  };

  gitlab = {
    hosts = defaultNullOpts.mkListOf types.str [ ] ''
      List of private instances of gitlab.
    '';

    issues = {
      limit = defaultNullOpts.mkUnsignedInt 100 ''
        Max number of issues to fetch.
      '';

      state = defaultNullOpts.mkStr "open" ''
        Which issues to fetch (`"open"`, `"closed"` or `"all"`).
      '';

      sort_by = mkAction "sort" "issues";
      format = mkAction "format" "issues";
    };

    mentions = {
      limit = defaultNullOpts.mkUnsignedInt 100 ''
        Max number of mentions to fetch.
      '';

      sort_by = mkAction "sort" "mentions";
      format = mkAction "format" "mentions";
    };

    merge_requests = {
      limit = defaultNullOpts.mkUnsignedInt 100 ''
        Max number of merge requests to fetch.
      '';

      state = defaultNullOpts.mkStr "open" ''
        Which issues to fetch (`"open"`, `"closed"`, `"locked"` or `"merged"`).
      '';

      sort_by = mkAction "sort" "merge_requests";
      format = mkAction "format" "merge_requests";
    };
  };

  trigger_actions =
    defaultNullOpts.mkListOf
      (types.submodule {
        options = {
          debug_name = lib.nixvim.mkNullOrStr "Debug name.";

          trigger_character = lib.mkOption {
            type = types.str;
            example = ":";
            description = ''
              The trigger character.
              Has to be a single character
            '';
          };

          action = lib.mkOption {
            type = lib.types.strLuaFn;
            description = ''
              The parameters to the action function are the different sources (currently `git`,
              `gitlab` and `github`), the completion callback, the trigger character, the
              parameters passed to complete from nvim-cmp, and the current git info.
            '';
            example = ''
              function(sources, trigger_char, callback, params, git_info)
                return sources.git:get_commits(callback, params, trigger_char)
              end
            '';
          };
        };
      })
      [
        {
          debug_name = "git_commits";
          trigger_character = ":";
          action = ''
            function(sources, trigger_char, callback, params, git_info)
              return sources.git:get_commits(callback, params, trigger_char)
            end
          '';
        }
        {
          debug_name = "gitlab_issues";
          trigger_character = "#";
          action = ''
            function(sources, trigger_char, callback, params, git_info)
                return sources.gitlab:get_issues(callback, git_info, trigger_char)
            end
          '';
        }
        {
          debug_name = "gitlab_mentions";
          trigger_character = "@";
          action = ''
            function(sources, trigger_char, callback, params, git_info)
                return sources.gitlab:get_mentions(callback, git_info, trigger_char)
            end
          '';
        }
        {
          debug_name = "gitlab_mrs";
          trigger_character = "!";
          action = ''
            function(sources, trigger_char, callback, params, git_info)
              return sources.gitlab:get_merge_requests(callback, git_info, trigger_char)
            end
          '';
        }
        {
          debug_name = "github_issues_and_pr";
          trigger_character = "#";
          action = ''
            function(sources, trigger_char, callback, params, git_info)
              return sources.github:get_issues_and_prs(callback, git_info, trigger_char)
            end
          '';
        }
        {
          debug_name = "github_mentions";
          trigger_character = "@";
          action = ''
            function(sources, trigger_char, callback, params, git_info)
              return sources.github:get_mentions(callback, git_info, trigger_char)
            end
          '';
        }
      ]
      ''
        If you want specific behaviour for a trigger or new behaviour for a trigger, you need to
        add an entry in the `trigger_actions` list of the config.
        The two necessary fields are the `trigger_character` and the `action`.
      '';
}