plugins/nvim-osc52: mark as obsolete

Upstream has declared the plugin obsolete because OSC52 support was
added to Neovim 0.10.

See https://neovim.io/doc/user/provider.html#clipboard-osc52
This commit is contained in:
Matt Sturgeon 2024-06-21 12:29:13 +01:00
parent 55fee7051f
commit 100ae4027d
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299

View file

@ -1,14 +1,31 @@
# TODO: As of nvim 0.10 this plugin is obsolete.
# warning added 2024-06-21, remove after 24.11.
{
lib,
helpers,
pkgs,
config,
options,
...
}:
with lib;
{
options.plugins.nvim-osc52 = {
enable = mkEnableOption "nvim-osc52, a plugin to use OSC52 sequences to copy/paste";
enable = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
Whether to enable nvim-osc52, a plugin to use OSC52 sequences to copy/paste.
Note: this plugin is obsolete and will be removed after 24.11.
As of Neovim 0.10 (specifically since [this PR][1]), native support for OSC52 has been added.
Check [`:h clipboard-osc52`][2] for more details.
[1]: https://github.com/neovim/neovim/pull/25872
[2]: https://neovim.io/doc/user/provider.html#clipboard-osc52
'';
};
package = helpers.mkPluginPackageOption "nvim-osc52" pkgs.vimPlugins.nvim-osc52;
@ -54,6 +71,15 @@ with lib;
};
in
mkIf cfg.enable {
warnings = [
''
Nixvim(plugins.nvim-osc52): this plugin is obsolete and will be removed after 24.11.
As of Neovim 0.10, native support for OSC52 has been added.
See `:h clipboard-osc52` for more details: https://neovim.io/doc/user/provider.html#clipboard-osc52
Definitions: ${lib.options.showDefs options.plugins.nvim-osc52.enable.definitionsWithLocations}
''
];
extraPlugins = [ cfg.package ];
keymaps =