plugins/TEMPLATE.nix: improve the template

This commit is contained in:
Gaetan Lepage 2024-03-06 10:42:36 +01:00 committed by Gaétan Lepage
parent 39df3f8355
commit 3543c84062

View file

@ -7,14 +7,25 @@
}: }:
helpers.neovim-plugin.mkNeovimPlugin config { helpers.neovim-plugin.mkNeovimPlugin config {
name = "my-plugin"; name = "my-plugin";
originalName = "my-plugin.nvim"; originalName = "my-plugin.nvim"; # TODO replace (or remove entirely if it is the same as `name`)
defaultPackage = pkgs.vimPlugins.my-plugin-nvim; # TODO replace defaultPackage = pkgs.vimPlugins.my-plugin-nvim; # TODO replace
# Optionnally provide an example for the `settings` option. maintainers = [lib.maintainers.MyName]; # TODO replace with your name
# Optionnally, explicitly declare some options. You don't have to.
settingsOptions = {
foo = helpers.defaultNullOpts.mkUnsignedInt 97 ''
The best birth year.
'';
great_feature = helpers.defaultNullOpts.mkBool false ''
Whether to enable the great feature.
'';
};
# Optionnally, provide an example for the `settings` option.
settingsExample = { settingsExample = {
foo = 42; foo = 42;
bar.__raw = "function() print('hello') end"; bar.__raw = "function() print('hello') end";
}; };
maintainers = [lib.maintainers.MyName]; # TODO replace with your name
} }