From a68ee739471f461761ad8474196ab732e86111a9 Mon Sep 17 00:00:00 2001 From: Gaetan Lepage Date: Thu, 25 Jan 2024 14:32:49 +0100 Subject: [PATCH] helpers/vim-plugin: mkPlugin -> mkVimPlugin --- CONTRIBUTING.md | 2 +- lib/vim-plugin.nix | 2 +- plugins/completion/copilot-vim.nix | 2 +- plugins/completion/nvim-cmp/cmp-helpers.nix | 2 +- plugins/git/fugitive.nix | 2 +- plugins/languages/ledger.nix | 2 +- plugins/languages/markdown-preview.nix | 2 +- plugins/languages/nix.nix | 2 +- plugins/languages/tagbar.nix | 2 +- plugins/languages/vim-slime.nix | 2 +- plugins/languages/zig.nix | 2 +- plugins/statuslines/airline.nix | 2 +- plugins/utils/emmet.nix | 2 +- plugins/utils/endwise.nix | 2 +- plugins/utils/goyo.nix | 2 +- plugins/utils/instant.nix | 2 +- plugins/utils/magma-nvim.nix | 2 +- plugins/utils/molten.nix | 2 +- plugins/utils/startify.nix | 2 +- plugins/utils/surround.nix | 2 +- plugins/utils/undotree.nix | 2 +- 21 files changed, 21 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6f06e312..167fb09f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,7 +71,7 @@ You will then need to add Nix options for all (or most) of the upstream plugin o 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. There are a number of helpers to help you correctly implement them: -- `helpers.vim-plugin.mkPlugin`: This helper is useful for simple plugins that are configured through (vim) global variables. +- `helpers.vim-plugin.mkVimPlugin`: This helper is useful for simple plugins that are configured through (vim) global variables. - `helpers.defaultNullOpts.{mkBool,mkInt,mkStr,...}`: This family of helpers takes a default value and a description, and sets the Nix default to `null`. These are the main functions you should use to define options. - `helpers.defaultNullOpts.mkNullable`: This takes a type, a default and a description. This is useful for more complex options. - `helpers.nixvimTypes.rawLua`: A type to represent raw lua code. The values are of the form `{ __raw = "";}`. This should not be used if the option can only be raw lua code, `mkLua`/`mkLuaFn` should be used in this case. diff --git a/lib/vim-plugin.nix b/lib/vim-plugin.nix index 8514e6f1..dffa7886 100644 --- a/lib/vim-plugin.nix +++ b/lib/vim-plugin.nix @@ -3,7 +3,7 @@ mkPackageOption, }: with lib; { - mkPlugin = { + mkVimPlugin = { config, lib, ... diff --git a/plugins/completion/copilot-vim.nix b/plugins/completion/copilot-vim.nix index ea0cb7dc..ef8e89e5 100644 --- a/plugins/completion/copilot-vim.nix +++ b/plugins/completion/copilot-vim.nix @@ -6,7 +6,7 @@ with lib; ( with (import ../helpers.nix {inherit lib;}).vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "copilot-vim"; description = "copilot.vim"; package = pkgs.vimPlugins.copilot-vim; diff --git a/plugins/completion/nvim-cmp/cmp-helpers.nix b/plugins/completion/nvim-cmp/cmp-helpers.nix index fa02837a..0fee26ef 100644 --- a/plugins/completion/nvim-cmp/cmp-helpers.nix +++ b/plugins/completion/nvim-cmp/cmp-helpers.nix @@ -14,7 +14,7 @@ in useDefaultPackage ? true, ... }: - mkPlugin {inherit lib config pkgs;} { + mkVimPlugin {inherit lib config pkgs;} { inherit name; extraPlugins = extraPlugins ++ (lists.optional useDefaultPackage pkgs.vimPlugins.${name}); description = "Enable ${name}"; diff --git a/plugins/git/fugitive.nix b/plugins/git/fugitive.nix index 9d7465e5..ecf2efbd 100644 --- a/plugins/git/fugitive.nix +++ b/plugins/git/fugitive.nix @@ -7,7 +7,7 @@ in with helpers.vim-plugin; with lib; - mkPlugin attrs { + mkVimPlugin attrs { name = "fugitive"; description = "Enable vim-fugitive"; package = pkgs.vimPlugins.vim-fugitive; diff --git a/plugins/languages/ledger.nix b/plugins/languages/ledger.nix index d77e20cd..31316972 100644 --- a/plugins/languages/ledger.nix +++ b/plugins/languages/ledger.nix @@ -5,7 +5,7 @@ } @ args: with lib; with (import ../helpers.nix {inherit lib;}).vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "ledger"; description = "ledger language features"; package = pkgs.vimPlugins.vim-ledger; diff --git a/plugins/languages/markdown-preview.nix b/plugins/languages/markdown-preview.nix index 500c9154..f3fdb580 100644 --- a/plugins/languages/markdown-preview.nix +++ b/plugins/languages/markdown-preview.nix @@ -6,7 +6,7 @@ } @ args: with lib; with (import ../helpers.nix {inherit lib;}).vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "markdown-preview"; description = "markdown-preview.nvim"; package = pkgs.vimPlugins.markdown-preview-nvim; diff --git a/plugins/languages/nix.nix b/plugins/languages/nix.nix index e7550b28..4bb9562d 100644 --- a/plugins/languages/nix.nix +++ b/plugins/languages/nix.nix @@ -7,7 +7,7 @@ in with helpers.vim-plugin; with lib; - mkPlugin attrs { + mkVimPlugin attrs { name = "nix"; description = "Enable nix"; package = pkgs.vimPlugins.vim-nix; diff --git a/plugins/languages/tagbar.nix b/plugins/languages/tagbar.nix index c383b660..4936fa90 100644 --- a/plugins/languages/tagbar.nix +++ b/plugins/languages/tagbar.nix @@ -5,7 +5,7 @@ } @ args: with lib; with (import ../helpers.nix {inherit lib;}).vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "tagbar"; package = pkgs.vimPlugins.tagbar; globalPrefix = "tagbar_"; diff --git a/plugins/languages/vim-slime.nix b/plugins/languages/vim-slime.nix index 1f77b85f..29900895 100644 --- a/plugins/languages/vim-slime.nix +++ b/plugins/languages/vim-slime.nix @@ -7,7 +7,7 @@ in with lib; with helpers.vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "vim-slime"; package = pkgs.vimPlugins.vim-slime; globalPrefix = "slime_"; diff --git a/plugins/languages/zig.nix b/plugins/languages/zig.nix index ad01d345..498af1a3 100644 --- a/plugins/languages/zig.nix +++ b/plugins/languages/zig.nix @@ -7,7 +7,7 @@ in with helpers.vim-plugin; with lib; - mkPlugin attrs { + mkVimPlugin attrs { name = "zig"; description = "Enable zig"; package = pkgs.vimPlugins.zig-vim; diff --git a/plugins/statuslines/airline.nix b/plugins/statuslines/airline.nix index 7ec78c73..a9e8a0ee 100644 --- a/plugins/statuslines/airline.nix +++ b/plugins/statuslines/airline.nix @@ -5,7 +5,7 @@ } @ args: with lib; with (import ../helpers.nix {inherit lib;}).vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "airline"; description = "vim-airline"; package = pkgs.vimPlugins.vim-airline; diff --git a/plugins/utils/emmet.nix b/plugins/utils/emmet.nix index 24ee5904..5fc362fb 100644 --- a/plugins/utils/emmet.nix +++ b/plugins/utils/emmet.nix @@ -12,7 +12,7 @@ with lib; let either strInt (attrsOf (either strInt (attrsOf strInt))); in with helpers.vim-plugin; - mkPlugin attrs { + mkVimPlugin attrs { name = "emmet"; description = "Enable emmet"; package = pkgs.vimPlugins.emmet-vim; diff --git a/plugins/utils/endwise.nix b/plugins/utils/endwise.nix index 8365087a..19b3dd87 100644 --- a/plugins/utils/endwise.nix +++ b/plugins/utils/endwise.nix @@ -7,7 +7,7 @@ in with helpers.vim-plugin; with lib; - mkPlugin attrs { + mkVimPlugin attrs { name = "endwise"; description = "Enable vim-endwise"; package = pkgs.vimPlugins.vim-endwise; diff --git a/plugins/utils/goyo.nix b/plugins/utils/goyo.nix index b7d48b69..e32b1993 100644 --- a/plugins/utils/goyo.nix +++ b/plugins/utils/goyo.nix @@ -7,7 +7,7 @@ in with helpers.vim-plugin; with lib; - mkPlugin attrs { + mkVimPlugin attrs { name = "goyo"; description = "Enable goyo.vim"; package = pkgs.vimPlugins.goyo-vim; diff --git a/plugins/utils/instant.nix b/plugins/utils/instant.nix index 58b5ed3f..b0cb16ab 100644 --- a/plugins/utils/instant.nix +++ b/plugins/utils/instant.nix @@ -5,7 +5,7 @@ } @ args: with lib; with (import ../helpers.nix {inherit lib;}).vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "instant"; description = "instant.nvim"; package = pkgs.vimPlugins.instant-nvim; diff --git a/plugins/utils/magma-nvim.nix b/plugins/utils/magma-nvim.nix index 06bbb3a7..8a0cd39c 100644 --- a/plugins/utils/magma-nvim.nix +++ b/plugins/utils/magma-nvim.nix @@ -5,7 +5,7 @@ } @ args: with lib; with (import ../helpers.nix {inherit lib;}).vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "magma-nvim"; description = "magma-nvim"; package = pkgs.vimPlugins.magma-nvim-goose; diff --git a/plugins/utils/molten.nix b/plugins/utils/molten.nix index c1c9b031..8181bc25 100644 --- a/plugins/utils/molten.nix +++ b/plugins/utils/molten.nix @@ -7,7 +7,7 @@ in with lib; with helpers.vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "molten"; description = "molten-nvim"; package = pkgs.vimPlugins.molten-nvim; diff --git a/plugins/utils/startify.nix b/plugins/utils/startify.nix index a6ce6fbb..3710c244 100644 --- a/plugins/utils/startify.nix +++ b/plugins/utils/startify.nix @@ -7,7 +7,7 @@ in with lib; with helpers.vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "startify"; description = "Enable startify"; package = pkgs.vimPlugins.vim-startify; diff --git a/plugins/utils/surround.nix b/plugins/utils/surround.nix index fb88c33e..49478a64 100644 --- a/plugins/utils/surround.nix +++ b/plugins/utils/surround.nix @@ -7,7 +7,7 @@ in with helpers.vim-plugin; with lib; - mkPlugin attrs { + mkVimPlugin attrs { name = "surround"; description = "Enable surround.vim"; package = pkgs.vimPlugins.surround; diff --git a/plugins/utils/undotree.nix b/plugins/utils/undotree.nix index a95c8efc..8ffd73ff 100644 --- a/plugins/utils/undotree.nix +++ b/plugins/utils/undotree.nix @@ -5,7 +5,7 @@ } @ args: with lib; with (import ../helpers.nix {inherit lib;}).vim-plugin; - mkPlugin args { + mkVimPlugin args { name = "undotree"; package = pkgs.vimPlugins.undotree; globalPrefix = "undotree_";