mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-20 16:15:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

contributing: reduce emphasis on settingsOptions

Browse source 
- Add an additional caution in CONTRIBUTING.md#declaring-plugin-options
- Remove `settingsOptions` from plugins/TEMPLATE.nix
This commit is contained in:
Matt Sturgeon 2025-04-21 10:02:30 +01:00
parent 55ad604d44
commit 86a887025f
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
2 changed files with 4 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

17
plugins/TEMPLATE.nix
View file

@ -1,7 +1,4 @@
{ lib, ... }:
let
inherit (lib.nixvim) defaultNullOpts;
in
lib.nixvim.plugins.mkNeovimPlugin {
name = "my-plugin";
moduleName = "my-plugin"; # TODO replace (or remove entirely if it is the same as `name`)
@ -10,18 +7,8 @@ lib.nixvim.plugins.mkNeovimPlugin {
maintainers = [ lib.maintainers.MyName ]; # TODO replace with your name
# Optionally, explicitly declare some options. You don't have to.
settingsOptions = {
foo = defaultNullOpts.mkUnsignedInt 97 ''
The best birth year.
'';
great_feature = defaultNullOpts.mkBool false ''
Whether to enable the great feature.
'';
};
# Optionally, provide an example for the `settings` option.
# TODO provide an example for the `settings` option (or remove entirely if there is no useful example)
# NOTE you can use `lib.literalExpression` or `lib.literalMD` if needed
settingsExample = {
foo = 42;
bar.__raw = "function() print('hello') end";