diff --git a/docs/release-notes/rl-0.8.md b/docs/release-notes/rl-0.8.md index 036b673c..ed627475 100644 --- a/docs/release-notes/rl-0.8.md +++ b/docs/release-notes/rl-0.8.md @@ -16,6 +16,11 @@ - Implement [](#opt-vim.git.gitsigns.setupOpts) for user-specified setup table in gitsigns configuration. +- [](#opt-vim.options.mouse) no longer compares values to an enum of available + mouse modes. This means you can provide any string without the module system + warning you that it is invalid. Do keep in mind that this value is no longer + checked, so you will be responsible for ensuring its validity. + [amadaluzia](https://github.com/amadaluzia): [haskell-tools.nvim]: https://github.com/MrcJkb/haskell-tools.nvim diff --git a/modules/wrapper/rc/options.nix b/modules/wrapper/rc/options.nix index d82fc741..36296f02 100644 --- a/modules/wrapper/rc/options.nix +++ b/modules/wrapper/rc/options.nix @@ -167,16 +167,25 @@ in { }; mouse = mkOption { - type = enum ["a" "n" "v" "i" "c"]; - default = "a"; + type = str; + default = "nvi"; + example = "a"; description = '' Set modes for mouse support. - * a - all * n - normal * v - visual * i - insert - * c - command + * c - command-line + * h - all modes when editing a help file + * a - all modes + * r - for hit-enter and more-prompt prompt + + [neovim documentation]: https://neovim.io/doc/user/options.html#'mouse'" + + This option takes a string to ensure proper conversion to the corresponding Lua type. + As such, we do not check the value passed to this option. Please ensure that any value + that is set here is a valid value as per [neovim documentation]. ''; };