helpers: move mkPlugin and mkDefaultOpt to helpers.vim-plugin

This commit is contained in:
Gaetan Lepage 2024-01-24 22:49:29 +01:00 committed by Gaétan Lepage
parent ddce82d0d1
commit 8f90372ee5
22 changed files with 445 additions and 435 deletions

View file

@ -5,7 +5,7 @@
} @ args:
with lib;
(
with import ../helpers.nix {inherit lib;};
with (import ../helpers.nix {inherit lib;}).vim-plugin;
mkPlugin args {
name = "copilot-vim";
description = "copilot.vim";

View file

@ -6,7 +6,7 @@
}: let
helpers = import ../../helpers.nix {inherit lib;};
in
with helpers;
with helpers.vim-plugin;
with lib; {
mkCmpSourcePlugin = {
name,

View file

@ -5,7 +5,7 @@
} @ attrs: let
helpers = import ../helpers.nix {inherit lib;};
in
with helpers;
with helpers.vim-plugin;
with lib;
mkPlugin attrs {
name = "fugitive";

View file

@ -4,7 +4,7 @@
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
with (import ../helpers.nix {inherit lib;}).vim-plugin;
mkPlugin args {
name = "ledger";
description = "ledger language features";

View file

@ -5,7 +5,7 @@
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
with (import ../helpers.nix {inherit lib;}).vim-plugin;
mkPlugin args {
name = "markdown-preview";
description = "markdown-preview.nvim";

View file

@ -5,7 +5,7 @@
} @ attrs: let
helpers = import ../helpers.nix {inherit lib;};
in
with helpers;
with helpers.vim-plugin;
with lib;
mkPlugin attrs {
name = "nix";

View file

@ -4,7 +4,7 @@
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
with (import ../helpers.nix {inherit lib;}).vim-plugin;
mkPlugin args {
name = "tagbar";
package = pkgs.vimPlugins.tagbar;

View file

@ -2,122 +2,124 @@
lib,
pkgs,
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
mkPlugin args {
name = "vim-slime";
package = pkgs.vimPlugins.vim-slime;
globalPrefix = "slime_";
} @ args: let
helpers = import ../helpers.nix {inherit lib;};
in
with lib;
with helpers.vim-plugin;
mkPlugin args {
name = "vim-slime";
package = pkgs.vimPlugins.vim-slime;
globalPrefix = "slime_";
options = {
target = mkDefaultOpt {
type = types.enum [
"dtach"
"kitty"
"neovim"
"screen"
"tmux"
"vimterminal"
"wezterm"
"whimrepl"
"x11"
"zellij"
];
description = ''
Which backend vim-slime should use.
options = {
target = mkDefaultOpt {
type = types.enum [
"dtach"
"kitty"
"neovim"
"screen"
"tmux"
"vimterminal"
"wezterm"
"whimrepl"
"x11"
"zellij"
];
description = ''
Which backend vim-slime should use.
Default: "screen"
'';
example = "dtach";
Default: "screen"
'';
example = "dtach";
};
vimterminalCmd = mkDefaultOpt {
global = "vimterminal_cmd";
type = types.str;
description = "The vim terminal command to execute.";
};
noMappings = mkDefaultOpt {
global = "no_mappings";
type = types.bool;
description = ''
Whether to disable the default mappings.
Default: `false`
'';
};
pasteFile = mkDefaultOpt {
global = "paste_file";
type = types.str;
description = ''
Required to transfer data from vim to GNU screen or tmux.
Setting this explicitly can work around some occasional portability issues.
whimrepl does not require or support this setting.
Default: "$HOME/.slime_paste"
'';
};
preserveCurpos = mkDefaultOpt {
global = "preserve_curpos";
type = types.bool;
description = ''
Whether to preserve cursor position when sending a line or paragraph.
Default: `true`
'';
};
defaultConfig = mkDefaultOpt {
global = "default_config";
type = with helpers.nixvimTypes; attrsOf (either str rawLua);
description = ''
Pre-filled prompt answer.
Default: `null`
Examples:
- `tmux`:
```nix
{
socket_name = "default";
target_pane = "{last}";
}
```
- `zellij`:
```nix
{
session_id = "current";
relative_pane = "right";
}
```
'';
};
dontAskDefault = mkDefaultOpt {
global = "dont_ask_default";
type = types.bool;
description = ''
Whether to bypass the prompt and use the specified default configuration options.
Default: `false`
'';
};
bracketedPaste = mkDefaultOpt {
global = "bracketed_paste";
type = with types; nullOr bool;
description = ''
Sometimes REPL are too smart for their own good, e.g. autocompleting a bracket that should
not be autocompleted when pasting code from a file.
In this case it can be useful to rely on bracketed-paste
(https://cirw.in/blog/bracketed-paste).
Luckily, tmux knows how to handle that. See tmux's manual.
Default: `false`
'';
};
};
vimterminalCmd = mkDefaultOpt {
global = "vimterminal_cmd";
type = types.str;
description = "The vim terminal command to execute.";
};
noMappings = mkDefaultOpt {
global = "no_mappings";
type = types.bool;
description = ''
Whether to disable the default mappings.
Default: `false`
'';
};
pasteFile = mkDefaultOpt {
global = "paste_file";
type = types.str;
description = ''
Required to transfer data from vim to GNU screen or tmux.
Setting this explicitly can work around some occasional portability issues.
whimrepl does not require or support this setting.
Default: "$HOME/.slime_paste"
'';
};
preserveCurpos = mkDefaultOpt {
global = "preserve_curpos";
type = types.bool;
description = ''
Whether to preserve cursor position when sending a line or paragraph.
Default: `true`
'';
};
defaultConfig = mkDefaultOpt {
global = "default_config";
type = with nixvimTypes; attrsOf (either str rawLua);
description = ''
Pre-filled prompt answer.
Default: `null`
Examples:
- `tmux`:
```nix
{
socket_name = "default";
target_pane = "{last}";
}
```
- `zellij`:
```nix
{
session_id = "current";
relative_pane = "right";
}
```
'';
};
dontAskDefault = mkDefaultOpt {
global = "dont_ask_default";
type = types.bool;
description = ''
Whether to bypass the prompt and use the specified default configuration options.
Default: `false`
'';
};
bracketedPaste = mkDefaultOpt {
global = "bracketed_paste";
type = with types; nullOr bool;
description = ''
Sometimes REPL are too smart for their own good, e.g. autocompleting a bracket that should
not be autocompleted when pasting code from a file.
In this case it can be useful to rely on bracketed-paste
(https://cirw.in/blog/bracketed-paste).
Luckily, tmux knows how to handle that. See tmux's manual.
Default: `false`
'';
};
};
}
}

View file

@ -5,7 +5,7 @@
} @ attrs: let
helpers = import ../helpers.nix {inherit lib;};
in
with helpers;
with helpers.vim-plugin;
with lib;
mkPlugin attrs {
name = "zig";

View file

@ -4,7 +4,7 @@
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
with (import ../helpers.nix {inherit lib;}).vim-plugin;
mkPlugin args {
name = "airline";
description = "vim-airline";

View file

@ -11,7 +11,7 @@ with lib; let
in
either strInt (attrsOf (either strInt (attrsOf strInt)));
in
with helpers;
with helpers.vim-plugin;
mkPlugin attrs {
name = "emmet";
description = "Enable emmet";

View file

@ -5,7 +5,7 @@
} @ attrs: let
helpers = import ../helpers.nix {inherit lib;};
in
with helpers;
with helpers.vim-plugin;
with lib;
mkPlugin attrs {
name = "endwise";

View file

@ -5,7 +5,7 @@
} @ attrs: let
helpers = import ../helpers.nix {inherit lib;};
in
with helpers;
with helpers.vim-plugin;
with lib;
mkPlugin attrs {
name = "goyo";

View file

@ -4,7 +4,7 @@
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
with (import ../helpers.nix {inherit lib;}).vim-plugin;
mkPlugin args {
name = "instant";
description = "instant.nvim";

View file

@ -4,7 +4,7 @@
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
with (import ../helpers.nix {inherit lib;}).vim-plugin;
mkPlugin args {
name = "magma-nvim";
description = "magma-nvim";

View file

@ -2,208 +2,210 @@
lib,
pkgs,
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
mkPlugin args {
name = "molten";
description = "molten-nvim";
package = pkgs.vimPlugins.molten-nvim;
globalPrefix = "molten_";
} @ args: let
helpers = import ../helpers.nix {inherit lib;};
in
with lib;
with helpers.vim-plugin;
mkPlugin args {
name = "molten";
description = "molten-nvim";
package = pkgs.vimPlugins.molten-nvim;
globalPrefix = "molten_";
options = {
autoOpenOutput = mkDefaultOpt {
global = "auto_open_output";
description = ''
Automatically open the output window when your cursor moves over a cell.
options = {
autoOpenOutput = mkDefaultOpt {
global = "auto_open_output";
description = ''
Automatically open the output window when your cursor moves over a cell.
Default: `true`
'';
type = types.bool;
example = false;
Default: `true`
'';
type = types.bool;
example = false;
};
copyOutput = mkDefaultOpt {
global = "copy_output";
description = ''
Copy evaluation output to clipboard automatically (requires pyperclip).
Default: `false`
'';
type = types.bool;
example = true;
};
enterOutputBehavior = mkDefaultOpt {
global = "enter_output_behavior";
description = ''
The behavior of MoltenEnterOutput.
Default: `"open_then_enter"`
'';
type = types.enum ["open_then_enter" "open_and_enter" "no_open"];
};
imageProvider = mkDefaultOpt {
global = "image_provider";
description = ''
How images are displayed.
Default: `"none"`
'';
type = types.enum ["none" "image.nvim"];
};
outputCropBorder = mkDefaultOpt {
global = "output_crop_border";
description = ''
'crops' the bottom border of the output window when it would otherwise just sit at the
bottom of the screen.
Default: `true`
'';
type = types.bool;
};
outputShowMore = mkDefaultOpt {
global = "output_show_more";
description = ''
When the window can't display the entire contents of the output buffer, shows the number
of extra lines in the window footer (requires nvim 10.0+ and a window border).
Default: `false`
'';
type = types.bool;
};
outputVirtLines = mkDefaultOpt {
global = "output_virt_lines";
description = ''
Pad the main buffer with virtual lines so the output doesn't cover anything while it's
open.
Default: `false`
'';
type = types.bool;
};
outputWinBorder = mkDefaultOpt {
global = "output_win_border";
description = ''
Some border features will not work if you don't specify your border as a table.
See border option of `:h nvim_open_win()`.
Default: `["" "" "" ""]`
'';
type = helpers.nixvimTypes.border;
};
outputWinCoverGutter = mkDefaultOpt {
global = "output_win_cover_gutter";
description = ''
Should the output window cover the gutter (numbers and sign col), or not.
If you change this, you probably also want to change `outputWinStyle`.
Default: `true`
'';
type = types.bool;
};
outputWinHideOnLeave = mkDefaultOpt {
global = "output_win_hide_on_leave";
description = ''
After leaving the output window (via `:q` or switching windows), do not attempt to redraw
the output window.
Default: `true`
'';
type = types.bool;
};
outputWinMaxHeight = mkDefaultOpt {
global = "output_win_max_height";
description = ''
Max height of the output window.
Default: `999999`
'';
type = types.ints.unsigned;
};
outputWinMaxWidth = mkDefaultOpt {
global = "output_win_max_width";
description = ''
Max width of the output window.
Default: `999999`
'';
type = types.ints.unsigned;
};
outputWinStyle = mkDefaultOpt {
global = "output_win_style";
description = ''
Value passed to the `style` option in `:h nvim_open_win()`
Default: `false`
'';
type = types.enum [false "minimal"];
};
savePath = mkDefaultOpt {
global = "save_path";
description = ''
Where to save/load data with `:MoltenSave` and `:MoltenLoad`.
Default: `{__raw = "vim.fn.stdpath('data')..'/molten'";}`
'';
type = with helpers.nixvimTypes; either str rawLua;
};
useBorderHighlights = mkDefaultOpt {
global = "use_border_highlights";
description = ''
When true, uses different highlights for output border depending on the state of the cell
(running, done, error).
See [highlights](https://github.com/benlubas/molten-nvim#highlights).
Default: `false`
'';
type = types.bool;
};
virtLinesOffBy1 = mkDefaultOpt {
global = "virt_lines_off_by_1";
description = ''
_Only has effect when `outputVirtLines` is true._
Allows the output window to cover exactly one line of the regular buffer.
(useful for running code in a markdown file where that covered line will just be ```)
Default: `false`
'';
type = types.bool;
};
wrapOutput = mkDefaultOpt {
global = "wrap_output";
description = ''
Wrap text in output windows.
Default: `false`
'';
type = types.bool;
};
# Debug
showMimetypeDebug = mkDefaultOpt {
global = "show_mimetype_debug";
description = ''
Before any non-iostream output chunk, the mime-type for that output chunk is shown.
Meant for debugging/plugin devlopment.
Default: `false`
'';
type = types.bool;
};
};
copyOutput = mkDefaultOpt {
global = "copy_output";
description = ''
Copy evaluation output to clipboard automatically (requires pyperclip).
Default: `false`
'';
type = types.bool;
example = true;
};
enterOutputBehavior = mkDefaultOpt {
global = "enter_output_behavior";
description = ''
The behavior of MoltenEnterOutput.
Default: `"open_then_enter"`
'';
type = types.enum ["open_then_enter" "open_and_enter" "no_open"];
};
imageProvider = mkDefaultOpt {
global = "image_provider";
description = ''
How images are displayed.
Default: `"none"`
'';
type = types.enum ["none" "image.nvim"];
};
outputCropBorder = mkDefaultOpt {
global = "output_crop_border";
description = ''
'crops' the bottom border of the output window when it would otherwise just sit at the
bottom of the screen.
Default: `true`
'';
type = types.bool;
};
outputShowMore = mkDefaultOpt {
global = "output_show_more";
description = ''
When the window can't display the entire contents of the output buffer, shows the number
of extra lines in the window footer (requires nvim 10.0+ and a window border).
Default: `false`
'';
type = types.bool;
};
outputVirtLines = mkDefaultOpt {
global = "output_virt_lines";
description = ''
Pad the main buffer with virtual lines so the output doesn't cover anything while it's
open.
Default: `false`
'';
type = types.bool;
};
outputWinBorder = mkDefaultOpt {
global = "output_win_border";
description = ''
Some border features will not work if you don't specify your border as a table.
See border option of `:h nvim_open_win()`.
Default: `["" "" "" ""]`
'';
type = nixvimTypes.border;
};
outputWinCoverGutter = mkDefaultOpt {
global = "output_win_cover_gutter";
description = ''
Should the output window cover the gutter (numbers and sign col), or not.
If you change this, you probably also want to change `outputWinStyle`.
Default: `true`
'';
type = types.bool;
};
outputWinHideOnLeave = mkDefaultOpt {
global = "output_win_hide_on_leave";
description = ''
After leaving the output window (via `:q` or switching windows), do not attempt to redraw
the output window.
Default: `true`
'';
type = types.bool;
};
outputWinMaxHeight = mkDefaultOpt {
global = "output_win_max_height";
description = ''
Max height of the output window.
Default: `999999`
'';
type = types.ints.unsigned;
};
outputWinMaxWidth = mkDefaultOpt {
global = "output_win_max_width";
description = ''
Max width of the output window.
Default: `999999`
'';
type = types.ints.unsigned;
};
outputWinStyle = mkDefaultOpt {
global = "output_win_style";
description = ''
Value passed to the `style` option in `:h nvim_open_win()`
Default: `false`
'';
type = types.enum [false "minimal"];
};
savePath = mkDefaultOpt {
global = "save_path";
description = ''
Where to save/load data with `:MoltenSave` and `:MoltenLoad`.
Default: `{__raw = "vim.fn.stdpath('data')..'/molten'";}`
'';
type = with nixvimTypes; either str rawLua;
};
useBorderHighlights = mkDefaultOpt {
global = "use_border_highlights";
description = ''
When true, uses different highlights for output border depending on the state of the cell
(running, done, error).
See [highlights](https://github.com/benlubas/molten-nvim#highlights).
Default: `false`
'';
type = types.bool;
};
virtLinesOffBy1 = mkDefaultOpt {
global = "virt_lines_off_by_1";
description = ''
_Only has effect when `outputVirtLines` is true._
Allows the output window to cover exactly one line of the regular buffer.
(useful for running code in a markdown file where that covered line will just be ```)
Default: `false`
'';
type = types.bool;
};
wrapOutput = mkDefaultOpt {
global = "wrap_output";
description = ''
Wrap text in output windows.
Default: `false`
'';
type = types.bool;
};
# Debug
showMimetypeDebug = mkDefaultOpt {
global = "show_mimetype_debug";
description = ''
Before any non-iostream output chunk, the mime-type for that output chunk is shown.
Meant for debugging/plugin devlopment.
Default: `false`
'';
type = types.bool;
};
};
}
}

View file

@ -6,7 +6,7 @@
helpers = import ../helpers.nix {inherit lib;};
in
with lib;
with helpers;
with helpers.vim-plugin;
mkPlugin args {
name = "startify";
description = "Enable startify";

View file

@ -5,7 +5,7 @@
} @ attrs: let
helpers = import ../helpers.nix {inherit lib;};
in
with helpers;
with helpers.vim-plugin;
with lib;
mkPlugin attrs {
name = "surround";

View file

@ -4,7 +4,7 @@
...
} @ args:
with lib;
with import ../helpers.nix {inherit lib;};
with (import ../helpers.nix {inherit lib;}).vim-plugin;
mkPlugin args {
name = "undotree";
package = pkgs.vimPlugins.undotree;