mirror of
https://github.com/nix-community/nixvim.git
synced 2025-07-12 10:14:31 +02:00
plugins/utils: move to by-name
This commit is contained in:
Matt Sturgeon
parent
faff32b9f1
commit
52f125679f
195 changed files with 2 additions and 102 deletions
50
plugins/by-name/hydra/default.nix
Normal file
50
plugins/by-name/hydra/default.nix
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
{
|
||||
lib,
|
||||
helpers,
|
||||
...
|
||||
}:
|
||||
with lib;
|
||||
helpers.neovim-plugin.mkNeovimPlugin {
|
||||
name = "hydra";
|
||||
originalName = "hydra.nvim";
|
||||
package = "hydra-nvim";
|
||||
|
||||
maintainers = [ maintainers.GaetanLepage ];
|
||||
|
||||
extraOptions = {
|
||||
# A list of `Hydra` definitions
|
||||
hydras = import ./hydras-option.nix { inherit lib helpers; };
|
||||
};
|
||||
|
||||
settingsOptions = import ./settings-options.nix { inherit lib helpers; };
|
||||
|
||||
settingsExample = {
|
||||
exit = false;
|
||||
foreign_keys = "run";
|
||||
color = "red";
|
||||
buffer = true;
|
||||
invoke_on_body = false;
|
||||
desc = null;
|
||||
on_enter = ''
|
||||
function()
|
||||
print('hello')
|
||||
end
|
||||
'';
|
||||
timeout = 5000;
|
||||
hint = false;
|
||||
};
|
||||
|
||||
callSetup = false;
|
||||
extraConfig = cfg: {
|
||||
extraConfigLua = ''
|
||||
hydra = require('hydra')
|
||||
|
||||
hydra.setup(${helpers.toLuaObject cfg.settings})
|
||||
|
||||
__hydra_defs = ${helpers.toLuaObject cfg.hydras}
|
||||
for _, hydra_config in ipairs(__hydra_defs) do
|
||||
hydra(hydra_config)
|
||||
end
|
||||
'';
|
||||
};
|
||||
}
|
||||
250
plugins/by-name/hydra/hydras-option.nix
Normal file
250
plugins/by-name/hydra/hydras-option.nix
Normal file
|
|
@ -0,0 +1,250 @@
|
|||
{ lib, helpers }:
|
||||
with lib;
|
||||
let
|
||||
hydraType = types.submodule {
|
||||
freeformType = with types; attrsOf anything;
|
||||
options = {
|
||||
name = helpers.mkNullOrStr ''
|
||||
Hydra's name.
|
||||
Only used in auto-generated hint.
|
||||
'';
|
||||
|
||||
mode = helpers.defaultNullOpts.mkNullable (
|
||||
with helpers.nixvimTypes; either helpers.keymaps.modeEnum (listOf helpers.keymaps.modeEnum)
|
||||
) "n" "Modes where the hydra exists, same as `vim.keymap.set()` accepts.";
|
||||
|
||||
body = helpers.mkNullOrStr ''
|
||||
Key required to activate the hydra, when excluded, you can use `Hydra:activate()`.
|
||||
'';
|
||||
|
||||
hint = helpers.mkNullOrStr ''
|
||||
The hint for a hydra can let you know that it's active, and remind you of the
|
||||
hydra's heads.
|
||||
The string for the hint is passed directly to the hydra.
|
||||
|
||||
See [the README](https://github.com/nvimtools/hydra.nvim?tab=readme-ov-file#hint)
|
||||
for more information.
|
||||
'';
|
||||
|
||||
config = import ./settings-options.nix { inherit lib helpers; };
|
||||
|
||||
heads =
|
||||
let
|
||||
headsOptType = types.submodule {
|
||||
freeformType = with types; attrsOf anything;
|
||||
options = {
|
||||
private = helpers.defaultNullOpts.mkBool false ''
|
||||
"When the hydra hides, this head does not stick out".
|
||||
Private heads are unreachable outside of the hydra state.
|
||||
'';
|
||||
|
||||
exit = helpers.defaultNullOpts.mkBool false ''
|
||||
When true, stops the hydra after executing this head.
|
||||
NOTE:
|
||||
- All exit heads are private
|
||||
- If no exit head is specified, `esc` is set by default
|
||||
'';
|
||||
|
||||
exit_before = helpers.defaultNullOpts.mkBool false ''
|
||||
Like `exit`, but stops the hydra BEFORE executing the command.
|
||||
'';
|
||||
|
||||
ok_key = helpers.defaultNullOpts.mkBool true ''
|
||||
When set to `false`, `config.on_key` isn't run after this head.
|
||||
'';
|
||||
|
||||
desc = helpers.mkNullOrStr ''
|
||||
Value shown in auto-generated hint.
|
||||
When false, this key doesn't show up in the auto-generated hint.
|
||||
'';
|
||||
|
||||
expr = helpers.defaultNullOpts.mkBool false ''
|
||||
Same as the builtin `expr` map option.
|
||||
See `:h :map-expression`.
|
||||
'';
|
||||
|
||||
silent = helpers.defaultNullOpts.mkBool false ''
|
||||
Same as the builtin `silent` map option.
|
||||
See `:h :map-silent`.
|
||||
'';
|
||||
|
||||
nowait = helpers.defaultNullOpts.mkBool false ''
|
||||
For Pink Hydras only.
|
||||
Allows binding a key which will immediately perform its action and not wait
|
||||
`timeoutlen` for a possible continuation.
|
||||
'';
|
||||
|
||||
mode = helpers.mkNullOrOption (
|
||||
with helpers.nixvimTypes; either helpers.keymaps.modeEnum (listOf helpers.keymaps.modeEnum)
|
||||
) "Override `mode` for this head.";
|
||||
};
|
||||
};
|
||||
headType =
|
||||
with helpers.nixvimTypes;
|
||||
# More precisely, a tuple: [head action opts]
|
||||
listOf (
|
||||
nullOr (
|
||||
# action can be `null`
|
||||
oneOf [
|
||||
str # for `head` and `action`
|
||||
rawLua # for `action`
|
||||
headsOptType # for opts
|
||||
]
|
||||
)
|
||||
);
|
||||
in
|
||||
helpers.mkNullOrOption (types.listOf headType) ''
|
||||
Each Hydra's head has the form:
|
||||
`[head rhs opts]
|
||||
|
||||
Similar to the `vim.keymap.set()` function.
|
||||
|
||||
- The `head` is the "lhs" of the mapping (given as a string).
|
||||
These are the keys you press to perform the action.
|
||||
- The `rhs` is the action that gets performed.
|
||||
It can be a string, function (use `__raw`) or `null`.
|
||||
When `null`, the action is a no-op.
|
||||
- The `opts` attrs is empty by default.
|
||||
'';
|
||||
};
|
||||
};
|
||||
in
|
||||
mkOption {
|
||||
type = types.listOf hydraType;
|
||||
default = [ ];
|
||||
description = ''
|
||||
A list of hydra configurations.
|
||||
See [here](https://github.com/nvimtools/hydra.nvim?tab=readme-ov-file#creating-a-new-hydra).
|
||||
'';
|
||||
example = [
|
||||
{
|
||||
name = "git";
|
||||
hint.__raw = ''
|
||||
[[
|
||||
_J_: next hunk _s_: stage hunk _d_: show deleted _b_: blame line
|
||||
_K_: prev hunk _u_: undo stage hunk _p_: preview hunk _B_: blame show full
|
||||
^ ^ _S_: stage buffer ^ ^ _/_: show base file
|
||||
^
|
||||
^ ^ _<Enter>_: Neogit _q_: exit
|
||||
]]
|
||||
'';
|
||||
config = {
|
||||
color = "pink";
|
||||
invoke_on_body = true;
|
||||
hint = {
|
||||
position = "bottom";
|
||||
};
|
||||
on_enter = ''
|
||||
function()
|
||||
vim.bo.modifiable = false
|
||||
gitsigns.toggle_signs(true)
|
||||
gitsigns.toggle_linehl(true)
|
||||
end
|
||||
'';
|
||||
on_exit = ''
|
||||
function()
|
||||
gitsigns.toggle_signs(false)
|
||||
gitsigns.toggle_linehl(false)
|
||||
gitsigns.toggle_deleted(false)
|
||||
vim.cmd("echo") -- clear the echo area
|
||||
end
|
||||
'';
|
||||
};
|
||||
mode = [
|
||||
"n"
|
||||
"x"
|
||||
];
|
||||
body = "<leader>g";
|
||||
heads = [
|
||||
[
|
||||
"J"
|
||||
{
|
||||
__raw = ''
|
||||
function()
|
||||
if vim.wo.diff then
|
||||
return "]c"
|
||||
end
|
||||
vim.schedule(function()
|
||||
gitsigns.next_hunk()
|
||||
end)
|
||||
return "<Ignore>"
|
||||
end
|
||||
'';
|
||||
}
|
||||
{ expr = true; }
|
||||
]
|
||||
[
|
||||
"K"
|
||||
{
|
||||
__raw = ''
|
||||
function()
|
||||
if vim.wo.diff then
|
||||
return "[c"
|
||||
end
|
||||
vim.schedule(function()
|
||||
gitsigns.prev_hunk()
|
||||
end)
|
||||
return "<Ignore>"
|
||||
end
|
||||
'';
|
||||
}
|
||||
{ expr = true; }
|
||||
]
|
||||
[
|
||||
"s"
|
||||
":Gitsigns stage_hunk<CR>"
|
||||
{ silent = true; }
|
||||
]
|
||||
[
|
||||
"u"
|
||||
{ __raw = "require('gitsigns').undo_stage_hunk"; }
|
||||
]
|
||||
[
|
||||
"S"
|
||||
{ __raw = "require('gitsigns').stage_buffer"; }
|
||||
]
|
||||
[
|
||||
"p"
|
||||
{ __raw = "require('gitsigns').preview_hunk"; }
|
||||
]
|
||||
[
|
||||
"d"
|
||||
{ __raw = "require('gitsigns').toggle_deleted"; }
|
||||
{ nowait = true; }
|
||||
]
|
||||
[
|
||||
"b"
|
||||
{ __raw = "require('gitsigns').blame_line"; }
|
||||
]
|
||||
[
|
||||
"B"
|
||||
{
|
||||
__raw = ''
|
||||
function()
|
||||
gitsigns.blame_line({ full = true })
|
||||
end,
|
||||
'';
|
||||
}
|
||||
]
|
||||
[
|
||||
"/"
|
||||
{ __raw = "require('gitsigns').show"; }
|
||||
{ exit = true; }
|
||||
]
|
||||
[
|
||||
"<Enter>"
|
||||
"<cmd>Neogit<CR>"
|
||||
{ exit = true; }
|
||||
]
|
||||
[
|
||||
"q"
|
||||
null
|
||||
{
|
||||
exit = true;
|
||||
nowait = true;
|
||||
}
|
||||
]
|
||||
];
|
||||
}
|
||||
];
|
||||
}
|
||||
174
plugins/by-name/hydra/settings-options.nix
Normal file
174
plugins/by-name/hydra/settings-options.nix
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
# Those are the configuration options for both the plugin's `setup` function (defaults for all
|
||||
# hydras) and each Hydra.
|
||||
# So this attrs of options is used:
|
||||
# - as the `plugins.hydra.settings` option definition
|
||||
# - for `plugins.hydra.hydras.[].config`
|
||||
#
|
||||
# -> https://github.com/nvimtools/hydra.nvim?tab=readme-ov-file#config
|
||||
{ helpers, lib, ... }:
|
||||
with lib;
|
||||
{
|
||||
debug = helpers.defaultNullOpts.mkBool false ''
|
||||
Whether to enable debug mode.
|
||||
'';
|
||||
|
||||
exit = helpers.defaultNullOpts.mkBool false ''
|
||||
Set the default exit value for each head in the hydra.
|
||||
'';
|
||||
|
||||
foreign_keys =
|
||||
helpers.defaultNullOpts.mkEnum
|
||||
[
|
||||
"warn"
|
||||
"run"
|
||||
]
|
||||
null
|
||||
''
|
||||
Decides what to do when a key which doesn't belong to any head is pressed
|
||||
- `null`: hydra exits and foreign key behaves normally, as if the hydra wasn't active
|
||||
- `"warn"`: hydra stays active, issues a warning and doesn't run the foreign key
|
||||
- `"run"`: hydra stays active, runs the foreign key
|
||||
'';
|
||||
|
||||
color = helpers.defaultNullOpts.mkStr "red" ''
|
||||
See `:h hydra-colors`.
|
||||
`"red" | "amaranth" | "teal" | "pink"`
|
||||
'';
|
||||
|
||||
buffer = helpers.defaultNullOpts.mkNullable (
|
||||
with types; either (enum [ true ]) ints.unsigned
|
||||
) null "Define a hydra for the given buffer, pass `true` for current buf.";
|
||||
|
||||
invoke_on_body = helpers.defaultNullOpts.mkBool false ''
|
||||
When true, summon the hydra after pressing only the `body` keys.
|
||||
Normally a head is required.
|
||||
'';
|
||||
|
||||
desc = helpers.defaultNullOpts.mkStr null ''
|
||||
Description used for the body keymap when `invoke_on_body` is true.
|
||||
When nil, "[Hydra] .. name" is used.
|
||||
'';
|
||||
|
||||
on_enter = helpers.mkNullOrLuaFn ''
|
||||
Called when the hydra is activated.
|
||||
'';
|
||||
|
||||
on_exit = helpers.mkNullOrLuaFn ''
|
||||
Called before the hydra is deactivated.
|
||||
'';
|
||||
|
||||
on_key = helpers.mkNullOrLuaFn ''
|
||||
Called after every hydra head.
|
||||
'';
|
||||
|
||||
timeout = helpers.defaultNullOpts.mkNullable (with types; either bool ints.unsigned) false ''
|
||||
Timeout after which the hydra is automatically disabled.
|
||||
Calling any head will refresh the timeout
|
||||
- `true`: timeout set to value of `timeoutlen` (`:h timeoutlen`)
|
||||
- `5000`: set to desired number of milliseconds
|
||||
|
||||
By default hydras wait forever (`false`).
|
||||
'';
|
||||
|
||||
hint =
|
||||
let
|
||||
hintConfigType = types.submodule {
|
||||
freeformType = with types; attrsOf anything;
|
||||
options = {
|
||||
type =
|
||||
helpers.mkNullOrOption
|
||||
(types.enum [
|
||||
"window"
|
||||
"cmdline"
|
||||
"statusline"
|
||||
"statuslinemanual"
|
||||
])
|
||||
''
|
||||
- "window": show hint in a floating window
|
||||
- "cmdline": show hint in the echo area
|
||||
- "statusline": show auto-generated hint in the status line
|
||||
- "statuslinemanual": Do not show a hint, but return a custom status line hint from
|
||||
`require("hydra.statusline").get_hint()`
|
||||
|
||||
Defaults to "window" if `hint` is passed to the hydra otherwise defaults to "cmdline".
|
||||
'';
|
||||
|
||||
position = helpers.defaultNullOpts.mkEnum [
|
||||
"top-left"
|
||||
"top"
|
||||
"top-right"
|
||||
"middle-left"
|
||||
"middle"
|
||||
"middle-right"
|
||||
"bottom-left"
|
||||
"bottom"
|
||||
"bottom-right"
|
||||
] "bottom" "Set the position of the hint window.";
|
||||
|
||||
offset = helpers.defaultNullOpts.mkInt 0 ''
|
||||
Offset of the floating window from the nearest editor border.
|
||||
'';
|
||||
|
||||
float_opts = helpers.mkNullOrOption (with types; attrsOf anything) ''
|
||||
Options passed to `nvim_open_win()`. See `:h nvim_open_win()`.
|
||||
Lets you set `border`, `header`, `footer`, etc.
|
||||
|
||||
Note: `row`, `col`, `height`, `width`, `relative`, and `anchor` should not be overridden.
|
||||
'';
|
||||
|
||||
show_name = helpers.defaultNullOpts.mkBool true ''
|
||||
Show the hydras name (or "HYDRA:" if not given a name), at the beginning of an
|
||||
auto-generated hint.
|
||||
'';
|
||||
|
||||
hide_on_load = helpers.defaultNullOpts.mkBool false ''
|
||||
If set to true, this will prevent the hydra's hint window from displaying immediately.
|
||||
|
||||
Note: you can still show the window manually by calling `Hydra.hint:show()` and manually
|
||||
close it with `Hydra.hint:close()`.
|
||||
'';
|
||||
|
||||
funcs = mkOption {
|
||||
type = with helpers.nixvimTypes; attrsOf strLuaFn;
|
||||
description = ''
|
||||
Table from function names to function.
|
||||
Functions should return a string.
|
||||
These functions can be used in hints with `%{func_name}` more in `:h hydra-hint`.
|
||||
'';
|
||||
default = { };
|
||||
example = {
|
||||
number = ''
|
||||
function()
|
||||
if vim.o.number then
|
||||
return '[x]'
|
||||
else
|
||||
return '[ ]'
|
||||
end
|
||||
end
|
||||
'';
|
||||
relativenumber = ''
|
||||
function()
|
||||
if vim.o.relativenumber then
|
||||
return '[x]'
|
||||
else
|
||||
return '[ ]'
|
||||
end
|
||||
end
|
||||
'';
|
||||
};
|
||||
apply = mapAttrs (_: helpers.mkRaw);
|
||||
};
|
||||
};
|
||||
};
|
||||
in
|
||||
helpers.defaultNullOpts.mkNullable (with types; either (enum [ false ]) hintConfigType)
|
||||
{
|
||||
show_name = true;
|
||||
position = "bottom";
|
||||
offset = 0;
|
||||
}
|
||||
''
|
||||
Configure the hint.
|
||||
Set to `false` to disable.
|
||||
'';
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue