helpers: add mkPackageOption + refactoring (nix-community#144)

flake.nix

@@ -58,7 +58,7 @@
                   modules = nixvimModules;
                 };
                 runUpdates = pkgs.callPackage
-                  ({ pkgs, stdenv }: stdenv.mkDerivation { 
+                  ({ pkgs, stdenv }: stdenv.mkDerivation {
                     pname = "run-updates";
                     version = pkgs.rust-analyzer.version;
 
@@ -67,7 +67,7 @@
                     nativeBuildInputs = with pkgs; [extractRustAnalyzerPkg alejandra nixpkgs-fmt];
 
                     buildPhase = ''
-                      extract_rust_analyzer.py editors/code/package.json | 
+                      extract_rust_analyzer.py editors/code/package.json |
                         alejandra --quiet |
                         nixpkgs-fmt > rust-analyzer-config.nix
                     '';

lib/helpers.nix

@@ -92,6 +92,12 @@ rec {
     mkEnumFirstDefault = enum: mkEnum enum (head enum);
   };
 
+  mkPackageOption = name: default: mkOption {
+    type = types.package;
+    inherit default;
+    description = "Plugin to use for ${name}";
+  };
+
   mkPlugin = { config, lib, ... }: { name
                                    , description
                                    , package ? null
@@ -112,11 +118,7 @@ rec {
         options;
       # does this evaluate package?
       packageOption = if package == null then { } else {
-        package = mkOption {
-          type = types.package;
-          default = package;
-          description = "Plugin to use for ${name}";
-        };
+        package = mkPackageOption name package;
       };
     in
     {

plugins/bufferlines/barbar.nix

@@ -2,16 +2,13 @@
 with lib;
 let
   cfg = config.plugins.barbar;
+  helpers = import ../helpers.nix { inherit lib; };
 in
 {
   options.plugins.barbar = {
     enable = mkEnableOption "barbar.nvim";
 
-    package = mkOption {
-      type = types.package;
-      default = pkgs.vimPlugins.barbar-nvim;
-      description = "Plugin to use for barbar";
-    };
+    package = helpers.mkPackageOption "barbar" pkgs.vimPlugins.barbar-nvim;
 
     animations = mkOption {
       type = types.nullOr types.bool;

plugins/bufferlines/bufferline.nix

@@ -34,11 +34,7 @@ in
   options = {
     plugins.bufferline = {
       enable = mkEnableOption "bufferline";
-      package = mkOption {
-        type = types.package;
-        description = "Plugin to use for bufferline";
-        default = pkgs.vimPlugins.bufferline-nvim;
-      };
+      package = helpers.mkPackageOption "bufferline" pkgs.vimPlugins.bufferline-nvim;
       numbers = mkOption {
         type = types.nullOr types.lines;
         description = "A lua function customizing the styling of numbers.";

plugins/colorschemes/base16.nix

@@ -2,18 +2,15 @@
 with lib;
 let
   cfg = config.colorschemes.base16;
+  helpers = import ../helpers.nix { inherit lib; };
   themes = import ./base16-list.nix;
 in
 {
   options = {
     colorschemes.base16 = {
       enable = mkEnableOption "base16";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.base16-vim;
-        description = "Plugin to use for base16";
-      };
+      package = helpers.mkPackageOption "base16" pkgs.vimPlugins.base16-vim;
 
       useTruecolor = mkOption {
         type = types.bool;

plugins/colorschemes/gruvbox.nix

@@ -2,18 +2,15 @@
 with lib;
 let
   cfg = config.colorschemes.gruvbox;
+  helpers = import ../helpers.nix { inherit lib; };
   colors = types.enum [ "bg" "red" "green" "yellow" "blue" "purple" "aqua" "gray" "fg" "bg0_h" "bg0" "bg1" "bg2" "bg3" "bg4" "gray" "orange" "bg0_s" "fg0" "fg1" "fg2" "fg3" "fg4" ];
 in
 {
   options = {
     colorschemes.gruvbox = {
       enable = mkEnableOption "gruvbox";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.gruvbox-nvim;
-        description = "Plugin to use for gruvbox";
-      };
+      package = helpers.mkPackageOption "gruvbox" pkgs.vimPlugins.gruvbox-nvim;
 
       italics = mkEnableOption "italics";
       bold = mkEnableOption "bold";

plugins/colorschemes/nord.nix

@@ -2,17 +2,14 @@
 with lib;
 let
   cfg = config.colorschemes.nord;
+  helpers = import ../helpers.nix { inherit lib; };
 in
 {
   options = {
     colorschemes.nord = {
       enable = mkEnableOption "nord";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.nord-nvim;
-        description = "Plugin to use for nord.nvim";
-      };
+      package = helpers.mkPackageOption "nord.vim" pkgs.vimPlugins.nord-nvim;
 
       contrast = mkEnableOption
         "Make sidebars and popup menus like nvim-tree and telescope have a different background";

plugins/colorschemes/one.nix

@@ -2,17 +2,14 @@
 with lib;
 let
   cfg = config.colorschemes.one;
+  helpers = import ../helpers.nix { inherit lib; };
 in
 {
   options = {
     colorschemes.one = {
       enable = mkEnableOption "vim-one";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.vim-one;
-        description = "Plugin to use for one";
-      };
+      package = helpers.mkPackageOption "one" pkgs.vimPlugins.vim-one;
     };
   };
 

plugins/colorschemes/onedark.nix

@@ -8,11 +8,7 @@ in
     colorschemes.onedark = {
       enable = mkEnableOption "onedark";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.onedark-vim;
-        description = "Plugin to use for one";
-      };
+      package = helpers.mkPackageOption "one" pkgs.vimPlugins.onedark-vim;
     };
   };
 

plugins/colorschemes/tokyonight.nix

@@ -9,11 +9,7 @@ in
   options = {
     colorschemes.tokyonight = {
       enable = mkEnableOption "tokyonight";
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.tokyonight-nvim;
-        description = "Plugin to use for tokyonight";
-      };
+      package = helpers.mkPackageOption "tokyonight" pkgs.vimPlugins.tokyonight-nvim;
       style = mkOption {
         type = style;
         default = "storm";

plugins/completion/copilot.nix

@@ -7,11 +7,7 @@ in
   options = {
     plugins.copilot = {
       enable = mkEnableOption "copilot";
-      package = mkOption {
-        type = types.package;
-        description = "The copilot plugin package to use";
-        default = pkgs.vimPlugins.copilot-vim;
-      };
+      package = helpers.mkPackageOption "copilot" pkgs.vimPlugins.copilot-vim;
       filetypes = mkOption {
         type = types.attrsOf types.bool;
         description = "A dictionary mapping file types to their enabled status";

plugins/completion/coq.nix

@@ -2,7 +2,7 @@
 with lib;
 let
   cfg = config.plugins.coq-nvim;
-  helpers = import ../helpers.nix { lib = lib; };
+  helpers = import ../helpers.nix { inherit lib; };
   plugins = import ../plugin-defs.nix { inherit pkgs; };
 
 in
@@ -11,11 +11,7 @@ in
     plugins.coq-nvim = {
       enable = mkEnableOption "coq-nvim";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.coq-vim;
-        description = "Plugin to use for coq-nvim";
-      };
+      package = helpers.mkPackageOption "coq-nvim" pkgs.vimPlugins.coq-nvim;
 
       installArtifacts = mkEnableOption "Install coq-artifacts";
 

plugins/completion/lspkind.nix

@@ -8,11 +8,7 @@ in
   options.plugins.lspkind = {
     enable = mkEnableOption "lspkind.nvim";
 
-    package = mkOption {
-      type = types.package;
-      default = pkgs.vimPlugins.lspkind-nvim;
-      description = "Plugin to use for lspkind.nvim";
-    };
+    package = helpers.mkPackageOption "lspkind" pkgs.vimPlugins.lspkind-nvim;
 
     mode = mkOption {
       type = with types; nullOr (enum [ "text" "text_symbol" "symbol_text" "symbol" ]);

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

@@ -1,6 +1,6 @@
 { lib, pkgs, ... }@attrs:
 let
-  helpers = import ../../helpers.nix { lib = lib; };
+  helpers = import ../../helpers.nix { inherit lib; };
 in with helpers; with lib;
 {
   mkCmpSourcePlugin = { name, extraPlugins ? [], useDefaultPackage ? true, ... }: mkPlugin attrs {

plugins/completion/nvim-cmp/default.nix

@@ -2,7 +2,7 @@
 with lib;
 let
   cfg = config.plugins.nvim-cmp;
-  helpers = import ../../helpers.nix { lib = lib; };
+  helpers = import ../../helpers.nix { inherit lib; };
   mkNullOrOption = helpers.mkNullOrOption;
   cmpLib = import ./cmp-helpers.nix args;
   # functionName should be a string
@@ -17,11 +17,7 @@ in
   options.plugins.nvim-cmp = {
     enable = mkEnableOption "nvim-cmp";
 
-    package = mkOption {
-      type = types.package;
-      default = pkgs.vimPlugins.nvim-cmp;
-      description = "Plugin to use for nvim-cmp";
-    };
+    package = helpers.mkPackageOption "nvim-cmp" pkgs.vimPlugins.nvim-cmp;
 
     performance = mkOption {
       default = null;

plugins/git/fugitive.nix

@@ -1,6 +1,6 @@
 { lib, pkgs, ... }@attrs:
 let
-  helpers = import ../helpers.nix { lib = lib; };
+  helpers = import ../helpers.nix { inherit lib; };
 in with helpers; with lib;
 mkPlugin attrs {
   name = "fugitive";

plugins/git/gitgutter.nix

@@ -9,11 +9,7 @@ in
     plugins.gitgutter = {
       enable = mkEnableOption "gitgutter";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.gitgutter;
-        description = "Plugin to use for gitgutter";
-      };
+      package = helpers.mkPackageOption "gitgutter" pkgs.vimPlugins.gitgutter;
 
       recommendedSettings = mkOption {
         type = types.bool;

plugins/git/gitsigns.nix

@@ -37,11 +37,7 @@ in
 {
   options.plugins.gitsigns = {
     enable = mkEnableOption "Enable gitsigns plugin";
-    package = mkOption {
-      type = types.package;
-      default = pkgs.vimPlugins.gitsigns-nvim;
-      description = "Plugin to use for gitsigns";
-    };
+    package = helpers.mkPackageOption "gitsigns" pkgs.vimPlugins.gitsigns-nvim;
     signs = {
       add = signOptions {
         hl = "GitSignsAdd";

plugins/git/neogit.nix

@@ -18,11 +18,7 @@ in
     plugins.neogit = {
       enable = mkEnableOption "neogit";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.neogit;
-        description = "Plugin to use for neogit";
-      };
+      package = helpers.mkPackageOption "neogit" pkgs.vimPlugins.neogit;
 
       disableSigns = mkOption {
         description = "Disable signs";

plugins/helpers.nix

@@ -1,2 +1 @@
 args: import ../lib/helpers.nix args
-

plugins/languages/ledger.nix

@@ -1,5 +1,5 @@
 { pkgs, lib, ... }@args:
-with lib; with import ../helpers.nix { lib = lib; };
+with lib; with import ../helpers.nix { inherit lib; };
 mkPlugin args {
   name = "ledger";
   description = "Enable ledger language features";

plugins/languages/nix.nix

@@ -1,6 +1,6 @@
 { lib, pkgs, ... }@attrs:
 let
-  helpers = import ../helpers.nix { lib = lib; };
+  helpers = import ../helpers.nix { inherit lib; };
 in with helpers; with lib;
 mkPlugin attrs {
   name = "nix";

plugins/languages/plantuml-syntax.nix

@@ -7,11 +7,7 @@ with lib; {
   options.plugins.plantuml-syntax = {
     enable = mkEnableOption "plantuml syntax support";
 
-    package = mkOption {
-      type = types.package;
-      default = pkgs.vimPlugins.plantuml-syntax;
-      description = "Plugin to use for plantuml-syntax";
-    };
+    package = helpers.mkPackageOption "plantuml-syntax" pkgs.vimPlugins.plantuml-syntax;
 
     setMakeprg = mkOption {
       type = types.bool;

plugins/languages/rust.nix

@@ -46,11 +46,7 @@ with lib; {
     in
     {
       enable = mkEnableOption "rust tools plugins";
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.rust-tools-nvim;
-        description = "Package to use for rust-tools";
-      };
+      package = helpers.mkPackageOption "rust-tools" pkgs.vimPlugins.rust-tools-nvim;
       serverPackage = mkOption {
         type = types.package;
         default = pkgs.rust-analyzer;

plugins/languages/treesitter-context.nix

@@ -1,17 +1,14 @@
 { pkgs
 , lib
 , config
+, helpers
 , ...
 }:
 with lib; {
   options.plugins.treesitter-context = {
     enable = mkEnableOption "nvim-treesitter-context";
 
-    package = mkOption {
-      type = types.package;
-      default = pkgs.vimPlugins.nvim-treesitter-context;
-      description = "Plugin to use for nvim-treesitter-context";
-    };
+    package = helpers.mkPackageOption "treesitter-context" pkgs.vimPlugins.nvim-treesitter-context;
 
     maxLines = mkOption {
       type = types.nullOr types.ints.positive;

plugins/languages/treesitter-refactor.nix

@@ -3,7 +3,11 @@
 , lib
 , ...
 }:
-with lib; {
+with lib;
+let
+  helpers = import ../helpers.nix { inherit lib; };
+in
+{
   options.plugins.treesitter-refactor =
     let
       disable = mkOption {
@@ -17,11 +21,7 @@ with lib; {
         mkEnableOption
           "treesitter-refactor (requires plugins.treesitter.enable to be true)";
 
-      package = mkOption {
-        type = types.package;
-        default = pkgs.vimPlugins.nvim-treesitter-refactor;
-        description = "Plugin to use for treesitter-refactor";
-      };
+      package = helpers.mkPackageOption "treesitter-refactor" pkgs.vimPlugins.nvim-treesitter-refactor;
 
       highlightDefinitions = {
         inherit disable;