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.";
    };

    hints = {
      type = attrsOf (submodule {
        options = {
          text = mkOption {
            type = str;
            description = "The easier-to-read depiction of the motion.";
          };
          prio = {
            type = str;
            description = "The priority of the hint.";
            example = str;
          };
        };
      });
    };

    gutterHints = hints;

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

    mappings = {
      # enable = mkOption {
      # };
      #
      # disable = mkOption {
      # };
      #
      # toggle =  mkOption {
      # };
    };
  };
}