plugins: do not import helpers.nix directly

CONTRIBUTING.md

@@ -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:
+2. Write the code for the corresponding nixvim module. You can start from the [template](plugins/TEMPLATE.nix).
-
-    ```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>
-          '';
-        };
-    }
-    ```
 
 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.

plugins/completion/nvim-cmp/cmp-helpers.nix

@@ -1,13 +1,12 @@
 {
   lib,
+  helpers,
   config,
   pkgs,
   ...
-}: let
+}:
-  helpers = import ../../helpers.nix {inherit lib;};
+with helpers.vim-plugin;
-in
+with lib; {
-  with helpers.vim-plugin;
-  with lib; {
   mkCmpSourcePlugin = {
     name,
     extraPlugins ? [],
@@ -63,4 +62,4 @@ in
     "vsnip" = "cmp-vsnip";
     "zsh" = "cmp-zsh";
   };
-  }
+}

plugins/completion/nvim-cmp/sources/default.nix

@@ -1,11 +1,12 @@
 {
   lib,
   config,
+  helpers,
   pkgs,
   ...
 }:
 with lib; let
-  cmpLib = import ../cmp-helpers.nix {inherit lib config pkgs;};
+  cmpLib = import ../cmp-helpers.nix {inherit lib config helpers pkgs;};
   cmpSourcesPluginNames = attrValues cmpLib.pluginAndSourceNames;
   pluginModules = lists.map (name: cmpLib.mkCmpSourcePlugin {inherit name;}) cmpSourcesPluginNames;
 in {

plugins/dap/dap-go.nix

@@ -7,7 +7,7 @@
 }:
 with lib; let
   cfg = config.plugins.dap.extensions.dap-go;
-  dapHelpers = import ./dapHelpers.nix {inherit lib;};
+  dapHelpers = import ./dapHelpers.nix {inherit lib helpers;};
 in {
   options.plugins.dap.extensions.dap-go = {
     enable = mkEnableOption "dap-go";

plugins/dap/dap-python.nix

@@ -7,7 +7,7 @@
 }:
 with lib; let
   cfg = config.plugins.dap.extensions.dap-python;
-  dapHelpers = import ./dapHelpers.nix {inherit lib;};
+  dapHelpers = import ./dapHelpers.nix {inherit lib helpers;};
 in {
   options.plugins.dap.extensions.dap-python = {
     enable = mkEnableOption "dap-python";

plugins/dap/dapHelpers.nix

@@ -1,7 +1,8 @@
-{lib, ...}:
+{
-with lib; let
+  lib,
-  helpers = import ../helpers.nix {inherit lib;};
+  helpers,
-in rec {
+}:
+with lib; rec {
   mkAdapterType = attrs:
     types.submodule {
       options =

plugins/dap/default.nix

@@ -7,7 +7,7 @@
 }:
 with lib; let
   cfg = config.plugins.dap;
-  dapHelpers = import ./dapHelpers.nix {inherit lib;};
+  dapHelpers = import ./dapHelpers.nix {inherit lib helpers;};
 in
   with dapHelpers; {
     imports = [

plugins/languages/treesitter/ts-autotag.nix

@@ -1,12 +1,11 @@
 {
   pkgs,
   lib,
+  helpers,
   config,
   ...
 }:
-with lib; let
+with lib; {
-  helpers = import ../../helpers.nix {inherit lib;};
-in {
   options.plugins.ts-autotag =
     helpers.neovim-plugin.extraOptionsOptions
     // {

plugins/lsp/helpers.nix

@@ -13,13 +13,12 @@
   {
     pkgs,
     config,
+    helpers,
     lib,
-    options,
     ...
   }:
     with lib; let
       cfg = config.plugins.lsp.servers.${name};
-      helpers = import ../helpers.nix {inherit lib;};
 
       packageOption =
         if package != null

plugins/lsp/language-servers/default.nix

@@ -303,7 +303,7 @@ with lib; let
       name = "ltex";
       description = "ltex-ls for LanguageTool";
       package = pkgs.ltex-ls;
-      settingsOptions = import ./ltex-settings.nix {inherit lib;};
+      settingsOptions = import ./ltex-settings.nix {inherit lib helpers;};
       settings = cfg: {ltex = cfg;};
     }
     {

plugins/lsp/language-servers/ltex-settings.nix

@@ -1,7 +1,8 @@
-{lib}:
+{
-with lib; let
+  lib,
-  helpers = import ../../helpers.nix {inherit lib;};
+  helpers,
-in {
+}:
+with lib; {
   enabled =
     helpers.defaultNullOpts.mkNullable
     (with types; either bool (listOf str))

plugins/none-ls/helpers.nix

@@ -12,10 +12,10 @@
     pkgs,
     config,
     lib,
+    helpers,
     ...
-  } @ args:
+  }:
     with lib; let
-      helpers = import ../helpers.nix args;
       cfg = config.plugins.none-ls.sources.${sourceType}.${name};
       # does this evaluate package?
       packageOption =

plugins/none-ls/servers.nix

@@ -5,7 +5,7 @@
   ...
 }:
 with lib; let
-  helpers = import ./helpers.nix;
+  cmpHelpers = import ./helpers.nix;
   serverData = {
     code_actions = {
       eslint = {
@@ -228,7 +228,7 @@ with lib; let
   dataFlattened = flatten serverDataFormatted;
 in {
   imports =
-    (map helpers.mkServer dataFlattened)
+    (map cmpHelpers.mkServer dataFlattened)
     ++ [
       ./prettier.nix
       # Introduced January 22 2024.