plugins: add top-level deprecation file

- Initialize it with the `treesitter-playground` removal
This commit is contained in:
Matt Sturgeon 2024-09-06 23:44:41 +01:00
parent 9a156ae60c
commit 86a4021597
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
3 changed files with 24 additions and 22 deletions

View file

@ -93,7 +93,6 @@
./languages/treesitter/hmts.nix ./languages/treesitter/hmts.nix
./languages/treesitter/rainbow-delimiters.nix ./languages/treesitter/rainbow-delimiters.nix
./languages/treesitter/treesitter-context.nix ./languages/treesitter/treesitter-context.nix
./languages/treesitter/treesitter-playground.nix
./languages/treesitter/treesitter-refactor.nix ./languages/treesitter/treesitter-refactor.nix
./languages/treesitter/treesitter-textobjects.nix ./languages/treesitter/treesitter-textobjects.nix
./languages/treesitter/treesitter.nix ./languages/treesitter/treesitter.nix
@ -248,5 +247,7 @@
./utils/yanky.nix ./utils/yanky.nix
./utils/zellij.nix ./utils/zellij.nix
./utils/zk.nix ./utils/zk.nix
./deprecation.nix
]; ];
} }

22
plugins/deprecation.nix Normal file
View file

@ -0,0 +1,22 @@
{ lib, ... }:
let
removed = {
# Added 2023-08-29
treesitter-playground = ''
The `treesitter-playground` plugin has been deprecated since the functionality is included in Neovim.
Use:
- `:Inspect` to show the highlight groups under the cursor
- `:InspectTree` to show the parsed syntax tree ("TSPlayground")
- `:PreviewQuery` to open the Query Editor (Nvim 0.10+)
'';
};
in
{
imports = lib.mapAttrsToList (
name:
lib.mkRemovedOptionModule [
"plugins"
name
]
) removed;
}

View file

@ -1,21 +0,0 @@
{ lib, ... }:
with lib;
{
# Deprecation notice added 2023/08/29
# TODO: remove (along with this file) in early November 2023.
imports = [
(mkRemovedOptionModule
[
"plugins"
"treesitter-playground"
]
''
The `treesitter-playground` plugin has been deprecated since the functionality is included in Neovim.
Use:
- `:Inspect` to show the highlight groups under the cursor
- `:InspectTree` to show the parsed syntax tree ("TSPlayground")
- `:PreviewQuery` to open the Query Editor (Nvim 0.10+)
''
)
];
}