neovim-flake/modules/plugins/utility/motion/precognition/precognition.nix

{lib, ...}: let
  inherit (lib.options) mkEnableOption mkOption literalExpression;
  inherit (lib.types) attrsOf listOf str bool int submodule;
in {
  options.vim.utility.motion.precognition = rec {
    enable = mkEnableOption "precognition.nvim plugin";

    startVisible = mkOption {
      type = bool;
      description = "Whether to start 'precognition' automatically.";
      default = true;
    };

    showBlankVirtLine = mkOption {
      type = bool;
      description = "Whether to show a blank virtual line when no movements are shown.";
      default = true;
    };

    highlightColor = mkOption {
      type = attrsOf str;

      example = literalExpression ''
        { link = "Comment"; }
        # or
        { foreground = "#0000FF"; background = "#000000"; };
      '';
      default = {link = "Comment";};
      description = ''
        The highlight for the virtual text.

        To find more about this option, please see
        [the documentation](https://github.com/tris203/precognition.nvim).
      '';
    };

    hints = mkOption {
      default = {};
      description = ''
        What motions display and at what priority.";

        To find more about this option, please see
        [the documentation](https://github.com/tris203/precognition.nvim).
      '';
      type = attrsOf (submodule {
        options = {
          text = mkOption {
            type = str;
            description = "The easier-to-read depiction of the motion.";
          };
          prio = mkOption {
            type = int;
            description = "The priority of the hint.";
            example = 10;
            default = 1;
          };
        };
      });
    };

    gutterHints = hints //
      {
        description = ''
          What motions display and at what priority. Only appears in gutters.

          To find more about this option, please see
          [the documentation](https://github.com/tris203/precognition.nvim).
        '';
      };

    disabled_fts = mkOption {
      type = listOf str;
      default = ["startify"];
      example = literalExpression ''["startify"]'';
    };
  };
}