Commit 3e6edb83 authored by Matthieu C.'s avatar Matthieu C. Committed by Matthieu Coudron
Browse files

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.
parent 2e6d6f5b

doc/languages-frameworks/neovim.section.md

+3 −4
Original line number Diff line number Diff line
@@ -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"

pkgs/applications/editors/vim/plugins/hooks/neovim-require-check-hook.sh

+1 −1
Original line number Diff line number Diff line
@@ -56,7 +56,7 @@ run_require_checks() { 
    set +e

    for name in "${nvimRequireCheck[@]}"; do

        local skip=false

        for module in "${nvimSkipModule[@]}"; do

        for module in "${nvimSkipModules[@]}"; do

            if [[ "$module" == "$name" ]]; then

                echo "$name is in list of modules to not check. Skipping..."

                skip=true

pkgs/applications/editors/vim/plugins/non-generated/avante-nvim/default.nix

+1 −1
Original line number Diff line number Diff line
@@ -80,7 +80,7 @@ vimUtils.buildVimPlugin { 
    inherit avante-nvim-lib;

  };



  nvimSkipModule = [

  nvimSkipModules = [

    # Requires setup with corresponding provider

    "avante.providers.azure"

    "avante.providers.copilot"

pkgs/applications/editors/vim/plugins/non-generated/blink-cmp/default.nix

+1 −1
Original line number Diff line number Diff line
@@ -61,7 +61,7 @@ vimUtils.buildVimPlugin { 
    ];

  };



  nvimSkipModule = [

  nvimSkipModules = [

    # Module for reproducing issues

    "repro"

  ];

pkgs/applications/editors/vim/plugins/non-generated/rainbow-delimiters-nvim/default.nix

+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ vimUtils.buildVimPlugin { 
    hash = "sha256-zWHXYs3XdnoszqOFY3hA2L5mNn1a44OAeKv3lL3EMEw=";

  };



  nvimSkipModule = [

  nvimSkipModules = [

    # rainbow-delimiters.types.lua

    "rainbow-delimiters.types"

    # Test that requires an unpackaged dependency