mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

plugins: do not import helpers.nix directly

Browse source
This commit is contained in:
Gaetan Lepage 2024-02-09 14:31:04 +01:00 • committed by Gaétan Lepage
parent 9f3bbca7f1
commit 7dbf7f978c
13 changed files with 83 additions and 119 deletions
Download patch file Download diff file Expand all files Collapse all files

38
CONTRIBUTING.md
View file

@ -29,43 +29,7 @@ Most of nixvim is dedicated to wrapping neovim plugin such that we can configure
To add a new plugin you need to do the following.
1. Add a file in the correct sub-directory of [plugins](plugins). This depends on your exact plugin.
You will most certainly need the `helpers`, they can be added by doing something like:
```nix
{
lib,
pkgs,
...
} @ args:
let
helpers = import ../helpers.nix args;
in {
}
```
2. Create the minimal options for a new plugin (in `options.plugins.<plug-name>`:
- `enable = mkEnableOption ...` to toggle the plugin.
- `package = helpers.mkPackageOption ...` to change the package options.
3. Add the plugin package to the installed plugins if it is enabled. This can be done with the following:
```nix
{
config =
let
cfg = config.plugins."<plug-name>";
in lib.mkIf cfg.enable {
extraPlugins = [cfg.package];
extraConfigLua = ''
<plugin configuration if needed>
'';
};
}
```
2. Write the code for the corresponding nixvim module. You can start from the [template](plugins/TEMPLATE.nix).
You will then need to add Nix options for all (or most) of the upstream plugin options.
These options should be in `camelCase` (whereas most plugins define their options in `snake_case`), and their names should match exactly (except the case) to the upstream names.