vimPlugins: rename nvimSkipModule into nvimSkipModules

It's confusing to have a polymorphic behavior for nvimSkipModule and it
is an implementation detail.
Let's not force ourselves to keep supporting both types and just support
lists, which imply plural in nixpkgs (e.g. "lib.optional" vs "lib.optionals").

Support and showcase just the list format to avoid confusion.
This commit is contained in:
Matthieu C. 2025-03-26 11:39:45 +01:00 committed by Matthieu Coudron
parent 2e6d6f5be9
commit 3e6edb83dd
7 changed files with 112 additions and 113 deletions

View file

@ -170,13 +170,12 @@ To only check a specific module, add it manually to the plugin definition [overr
};
```
Some plugins will have lua modules that require a user configuration to function properly or can contain optional lua modules that we dont want to test requiring.
We can skip specific modules using `nvimSkipModule`. Similar to `nvimRequireCheck`, it accepts a single string or a list of strings.
- `nvimSkipModule = MODULE;`
- `nvimSkipModule = [ MODULE1 MODULE2 ];`
We can skip specific modules using `nvimSkipModules`. Similar to `nvimRequireCheck`, it accepts a list of strings.
- `nvimSkipModules = [ MODULE1 MODULE2 ];`
```nix
asyncrun-vim = super.asyncrun-vim.overrideAttrs {
nvimSkipModule = [
nvimSkipModules = [
# vim plugin with optional toggleterm integration
"asyncrun.toggleterm"
"asyncrun.toggleterm2"