Skip to content

avante-nvim: reduce mkEnableOption usage and reformat descriptions #1070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

avante-nvim: reduce mkEnableOption usage and reformat descriptions #1070

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a1d1eb1
fix: format avante.nvim
Ladas552 Aug 10, 2025
b82772b
fix: wrong type
Ladas552 Aug 10, 2025
33e1632
avante-nvim: reformat mkEnableOption and descriptions
Ladas552 Aug 10, 2025
ae4698c
fix: honor prepended Whether to enable
Ladas552 Aug 10, 2025
a8ac4e9
fix: honor techincal term capitalization
Ladas552 Aug 10, 2025
2330091
fix: descriptions fit into documentations standards
Ladas552 Aug 10, 2025
a7e5414
fix: use inline code
Ladas552 Aug 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 46 additions & 61 deletions modules/plugins/assistant/avante/avante-nvim.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
in {
options.vim.assistant = {
avante-nvim = {
enable = mkEnableOption "complementary Neovim plugin for avante.nvim";
enable = mkEnableOption "Complementary Neovim plugin for avante.nvim";
setupOpts = mkPluginSetupOption "avante-nvim" {
provider = mkOption {
type = nullOr str;
Expand Down Expand Up @@ -76,7 +76,7 @@ in {
};

dual_boost = {
enabled = mkEnableOption "dual_boost mode.";
enabled = mkEnableOption "Dual_boost mode.";

first_provider = mkOption {
type = str;
Expand Down Expand Up @@ -109,39 +109,39 @@ in {

behaviour = {
auto_suggestions =
mkEnableOption "auto suggestions.";
mkEnableOption "Auto suggestions.";

auto_set_highlight_group =
mkEnableOption "automatically set the highlight group for the current line."
// {
default = true;
};
auto_set_highlight_group = mkOption {
type = bool;
default = true;
description = "Automatically set the highlight group for the current line.";
};
Copy link
Owner

@NotAShelf NotAShelf Aug 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think boolean options should use mkEnableOption because of the "Whether to..." prefix. If replacing (which is fine) please consider "Whether to..." at the beginning so that it's more obvious this is a boolean logical op.

Copy link
Author

@Ladas552 Ladas552 Aug 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am still confused on whether to use mkOption, and format description to fit into mkEnableOption standardized strings. Or would merging the "default = true;", as in the original version of the module, be better.

The latter looks ugly, but could be refactored later easily if you ever want to add mkEnableTrue or similar alias to the mkOption.

I can revert mkOption added in this PR back to mkEnableOption, and provide better fitting descriptions if need be


auto_set_keymaps =
mkEnableOption "automatically set the keymap for the current line."
// {
default = true;
};
auto_set_keymaps = mkOption {
type = bool;
default = true;
description = "Automatically set the keymap for the current line.";
};

auto_apply_diff_after_generation =
mkEnableOption "automatically apply diff after LLM response.";
mkEnableOption "Automatically apply diff after LLM response.";

support_paste_from_clipboard = mkEnableOption ''
pasting image from clipboard.
Pasting image from clipboard.
This will be determined automatically based whether img-clip is available or not.
'';

minimize_diff =
mkEnableOption "remove unchanged lines when applying a code block."
// {
default = true;
};
minimize_diff = mkOption {
type = bool;
default = true;
description = "Remove unchanged lines when applying a code block.";
};

enable_token_counting =
mkEnableOption "token counting."
// {
default = true;
};
enable_token_counting = mkOption {
type = bool;
default = true;
description = "Token counting.";
};

enable_cursor_planning_mode =
mkEnableOption "Cursor Planning Mode.";
Expand Down Expand Up @@ -188,14 +188,11 @@ in {
};
};

hints.enabled =
mkEnableOption ""
// {
default = true;
description = ''
Whether to enable hints.
'';
};
hints.enabled = mkOption {
type = bool;
default = true;
description = "Whether to enable hints.";
};

windows = {
position = mkOption {
Expand All @@ -204,14 +201,11 @@ in {
description = "The position of the sidebar.";
};

wrap =
mkEnableOption ""
// {
default = true;
description = ''
similar to vim.o.wrap.
'';
};
wrap = mkOption {
type = bool;
default = true;
description = "Similar to vim.o.wrap.";
};

width = mkOption {
type = int;
Expand All @@ -223,7 +217,7 @@ in {
enabled = mkOption {
type = bool;
default = true;
description = "enable/disable the header.";
description = "Enable the sidebar header.";
};

align = mkOption {
Expand All @@ -235,7 +229,7 @@ in {
rounded = mkOption {
type = bool;
default = true;
description = "Enable rounded sidebar header";
description = "Enable rounded sidebar header.";
};
};

Expand All @@ -249,9 +243,7 @@ in {
height = mkOption {
type = int;
default = 8;
description = ''
Height of the input window in vertical layout.
'';
description = "Height of the input window in vertical layout.";
};
};

Expand All @@ -265,27 +257,21 @@ in {
start_insert = mkOption {
type = bool;
default = true;
description = ''
Start insert mode when opening the edit window.
'';
description = "Start insert mode when opening the edit window.";
};
};

ask = {
floating = mkOption {
type = bool;
default = false;
description = ''
Open the 'AvanteAsk' prompt in a floating window.
'';
description = "Open the 'AvanteAsk' prompt in a floating window.";
};

start_insert = mkOption {
type = bool;
default = true;
description = ''
Start insert mode when opening the ask window.
'';
description = "Start insert mode when opening the ask window.";
};

border = mkOption {
Expand All @@ -303,12 +289,11 @@ in {
};

diff = {
autojump =
mkEnableOption ""
// {
default = true;
description = "Automatically jumps to the next change.";
};
autojump = mkOption {
type = bool;
default = true;
description = "Automatically jumps to the next change.";
};

override_timeoutlen = mkOption {
type = int;
Expand Down