mirror of
https://github.com/NotAShelf/nvf.git
synced 2025-09-07 10:51:36 +00:00
docs: add missing descriptions
This commit is contained in:
parent
8cde1f7b93
commit
7092ff5b7b
2 changed files with 20 additions and 25 deletions
|
@ -1,7 +1,7 @@
|
||||||
{lib, ...}: let
|
{lib, ...}: let
|
||||||
inherit (lib.options) mkOption mkEnableOption literalMD;
|
inherit (lib.options) mkOption mkEnableOption literalMD;
|
||||||
inherit (lib.types) int str enum nullOr attrs either;
|
inherit (lib.types) int str enum nullOr attrs;
|
||||||
inherit (lib.nvim.types) mkPluginSetupOption luaInline;
|
inherit (lib.nvim.types) mkPluginSetupOption;
|
||||||
in {
|
in {
|
||||||
options.vim.assistant = {
|
options.vim.assistant = {
|
||||||
avante-nvim = {
|
avante-nvim = {
|
||||||
|
@ -63,24 +63,25 @@ in {
|
||||||
mkEnableOption ""
|
mkEnableOption ""
|
||||||
// {
|
// {
|
||||||
default = false;
|
default = false;
|
||||||
description = ''
|
description = "Whether to enable dual_boost mode.";
|
||||||
enable/disable dual boost.
|
|
||||||
'';
|
|
||||||
};
|
};
|
||||||
|
|
||||||
first_provider = mkOption {
|
first_provider = mkOption {
|
||||||
type = str;
|
type = str;
|
||||||
default = "openai";
|
default = "openai";
|
||||||
|
description = "The first provider to generate response.";
|
||||||
};
|
};
|
||||||
|
|
||||||
second_provider = mkOption {
|
second_provider = mkOption {
|
||||||
type = str;
|
type = str;
|
||||||
default = "claude";
|
default = "claude";
|
||||||
|
description = "The second provider to generate response.";
|
||||||
};
|
};
|
||||||
|
|
||||||
prompt = mkOption {
|
prompt = mkOption {
|
||||||
type = str;
|
type = str;
|
||||||
default = "Based on the two reference outputs below, generate a response that incorporates elements from both but reflects your own judgment and unique perspective. Do not provide any explanation, just give the response directly. Reference Output 1: [{{provider1_output}}], Reference Output 2: [{{provider2_output}}]";
|
default = "Based on the two reference outputs below, generate a response that incorporates elements from both but reflects your own judgment and unique perspective. Do not provide any explanation, just give the response directly. Reference Output 1: [{{provider1_output}}], Reference Output 2: [{{provider2_output}}]";
|
||||||
|
description = "The prompt to generate response based on the two reference outputs.";
|
||||||
};
|
};
|
||||||
|
|
||||||
timeout = mkOption {
|
timeout = mkOption {
|
||||||
|
@ -95,30 +96,35 @@ in {
|
||||||
mkEnableOption ""
|
mkEnableOption ""
|
||||||
// {
|
// {
|
||||||
default = false;
|
default = false;
|
||||||
|
description = "Whether to enable auto suggestions.";
|
||||||
};
|
};
|
||||||
|
|
||||||
auto_set_highlight_group =
|
auto_set_highlight_group =
|
||||||
mkEnableOption ""
|
mkEnableOption ""
|
||||||
// {
|
// {
|
||||||
default = true;
|
default = true;
|
||||||
|
description = "Whether to automatically set the highlight group for the current line.";
|
||||||
};
|
};
|
||||||
|
|
||||||
auto_set_keymaps =
|
auto_set_keymaps =
|
||||||
mkEnableOption ""
|
mkEnableOption ""
|
||||||
// {
|
// {
|
||||||
default = true;
|
default = true;
|
||||||
|
description = "Whether to automatically set the keymap for the current line.";
|
||||||
};
|
};
|
||||||
|
|
||||||
auto_apply_diff_after_generation =
|
auto_apply_diff_after_generation =
|
||||||
mkEnableOption ""
|
mkEnableOption ""
|
||||||
// {
|
// {
|
||||||
default = false;
|
default = false;
|
||||||
|
description = "Whether to automatically apply diff after LLM response.";
|
||||||
};
|
};
|
||||||
|
|
||||||
support_paste_from_clipboard =
|
support_paste_from_clipboard =
|
||||||
mkEnableOption ""
|
mkEnableOption ""
|
||||||
// {
|
// {
|
||||||
default = false;
|
default = false;
|
||||||
|
description = "Whether to support pasting image from clipboard. This will be determined automatically based whether img-clip is available or not.";
|
||||||
};
|
};
|
||||||
|
|
||||||
minimize_diff =
|
minimize_diff =
|
||||||
|
@ -239,6 +245,7 @@ in {
|
||||||
mkEnableOption ""
|
mkEnableOption ""
|
||||||
// {
|
// {
|
||||||
default = true;
|
default = true;
|
||||||
|
description = "Enable rounded sidebar header";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -246,6 +253,7 @@ in {
|
||||||
prefix = mkOption {
|
prefix = mkOption {
|
||||||
type = str;
|
type = str;
|
||||||
default = "> ";
|
default = "> ";
|
||||||
|
description = "The prefix used on the user input.";
|
||||||
};
|
};
|
||||||
|
|
||||||
height = mkOption {
|
height = mkOption {
|
||||||
|
@ -261,6 +269,7 @@ in {
|
||||||
border = mkOption {
|
border = mkOption {
|
||||||
type = str;
|
type = str;
|
||||||
default = "rounded";
|
default = "rounded";
|
||||||
|
description = "The border type on the edit window.";
|
||||||
};
|
};
|
||||||
|
|
||||||
start_insert =
|
start_insert =
|
||||||
|
@ -295,26 +304,13 @@ in {
|
||||||
border = mkOption {
|
border = mkOption {
|
||||||
type = str;
|
type = str;
|
||||||
default = "rounded";
|
default = "rounded";
|
||||||
|
description = "The border type on the ask window.";
|
||||||
};
|
};
|
||||||
|
|
||||||
focus_on_apply = mkOption {
|
focus_on_apply = mkOption {
|
||||||
type = enum ["ours" "theirs"];
|
type = enum ["ours" "theirs"];
|
||||||
default = "ours";
|
default = "ours";
|
||||||
description = "which diff to focus after applying.";
|
description = "Which diff to focus after applying.";
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
highlights = {
|
|
||||||
diff = {
|
|
||||||
current = mkOption {
|
|
||||||
type = str;
|
|
||||||
default = "DiffText";
|
|
||||||
};
|
|
||||||
|
|
||||||
incoming = mkOption {
|
|
||||||
type = str;
|
|
||||||
default = "DiffAdd";
|
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
@ -324,13 +320,9 @@ in {
|
||||||
mkEnableOption ""
|
mkEnableOption ""
|
||||||
// {
|
// {
|
||||||
default = true;
|
default = true;
|
||||||
|
description = "Automatically jumps to the next change.";
|
||||||
};
|
};
|
||||||
|
|
||||||
list_opener = mkOption {
|
|
||||||
type = either str luaInline;
|
|
||||||
default = "copen";
|
|
||||||
};
|
|
||||||
|
|
||||||
override_timeoutlen = mkOption {
|
override_timeoutlen = mkOption {
|
||||||
type = int;
|
type = int;
|
||||||
default = 500;
|
default = 500;
|
||||||
|
@ -346,11 +338,13 @@ in {
|
||||||
debounce = mkOption {
|
debounce = mkOption {
|
||||||
type = int;
|
type = int;
|
||||||
default = 600;
|
default = 600;
|
||||||
|
description = "Suggestion debounce in milliseconds.";
|
||||||
};
|
};
|
||||||
|
|
||||||
throttle = mkOption {
|
throttle = mkOption {
|
||||||
type = int;
|
type = int;
|
||||||
default = 600;
|
default = 600;
|
||||||
|
description = "Suggestion throttle in milliseconds.";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
|
@ -121,6 +121,7 @@ in {
|
||||||
file_types = lib.mkOption {
|
file_types = lib.mkOption {
|
||||||
type = listOf (nullOr str);
|
type = listOf (nullOr str);
|
||||||
default = [];
|
default = [];
|
||||||
|
description = "List of buffer filetypes to enable this plugin in. This will cause the plugin to attach to new buffers who have any of these filetypes.";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue