diff --git a/modules/plugins/utility/motion/precognition/precognition.nix b/modules/plugins/utility/motion/precognition/precognition.nix index 9c42e0f9..f1c701c8 100644 --- a/modules/plugins/utility/motion/precognition/precognition.nix +++ b/modules/plugins/utility/motion/precognition/precognition.nix @@ -1,28 +1,8 @@ {lib, ...}: let inherit (lib.options) mkEnableOption mkOption literalExpression; inherit (lib.types) attrsOf listOf str bool int submodule; - - mkHintType = description: - mkOption { - inherit description; - default = {}; - 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; - }; - }; - }); - }; in { - options.vim.utility.motion.precognition = { + options.vim.utility.motion.precognition = rec { enable = mkEnableOption "precognition.nvim plugin"; startVisible = mkOption { @@ -48,13 +28,46 @@ in { 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 = mkHintType "What motions display and at what priority."; + 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 = - mkHintType "What motions display and at what priority. Only appears in gutters."; + 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;