Merge pull request #169 from ksonj/fix-enable-options

fix enable option descriptions
This commit is contained in:
NotAShelf 2023-10-21 21:07:04 +03:00 committed by GitHub
commit d7cf84c514
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 42 additions and 42 deletions

View file

@ -1,10 +1,10 @@
{lib, ...}: {lib, ...}:
with lib; { with lib; {
options.vim.debugger.nvim-dap = { options.vim.debugger.nvim-dap = {
enable = mkEnableOption "Enable debugging via nvim-dap"; enable = mkEnableOption "debugging via nvim-dap";
ui = { ui = {
enable = mkEnableOption "Enable UI extension for nvim-dap"; enable = mkEnableOption "UI extension for nvim-dap";
autoStart = mkOption { autoStart = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;

View file

@ -207,7 +207,7 @@ with builtins; {
type = types.submodule { type = types.submodule {
options = { options = {
enable = mkEnableOption "Enable diagnostics view in the signcolumn."; enable = mkEnableOption "diagnostics view in the signcolumn.";
debounceDelay = mkOption { debounceDelay = mkOption {
description = "Idle milliseconds between diagnostic event and update."; description = "Idle milliseconds between diagnostic event and update.";

View file

@ -89,7 +89,7 @@ in {
}; };
lsp = { lsp = {
enable = mkEnableOption "Enable clang LSP support" // {default = config.vim.languages.enableLSP;}; enable = mkEnableOption "clang LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption { server = mkOption {
description = "The clang LSP server to use"; description = "The clang LSP server to use";

View file

@ -30,7 +30,7 @@ in {
enable = mkEnableOption "Dart language support"; enable = mkEnableOption "Dart language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Dart treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Dart treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "dart"; package = nvim.types.mkGrammarOption pkgs "dart";
}; };

View file

@ -70,13 +70,13 @@ in {
enable = mkEnableOption "Go language support"; enable = mkEnableOption "Go language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Go treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Go treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "go"; package = nvim.types.mkGrammarOption pkgs "go";
}; };
lsp = { lsp = {
enable = mkEnableOption "Enable Go LSP support" // {default = config.vim.languages.enableLSP;}; enable = mkEnableOption "Go LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption { server = mkOption {
description = "Go LSP server to use"; description = "Go LSP server to use";

View file

@ -12,7 +12,7 @@ in {
enable = mkEnableOption "Java language support"; enable = mkEnableOption "Java language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Java treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Java treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "java"; package = nvim.types.mkGrammarOption pkgs "java";
}; };

View file

@ -11,11 +11,11 @@ in {
options.vim.languages.lua = { options.vim.languages.lua = {
enable = mkEnableOption "Lua language support"; enable = mkEnableOption "Lua language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Lua Treesitter support" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Lua Treesitter support" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "lua"; package = nvim.types.mkGrammarOption pkgs "lua";
}; };
lsp = { lsp = {
enable = mkEnableOption "Enable Lua LSP support via LuaLS" // {default = config.vim.languages.enableLSP;}; enable = mkEnableOption "Lua LSP support via LuaLS" // {default = config.vim.languages.enableLSP;};
package = mkOption { package = mkOption {
description = "LuaLS package, or the command to run as a list of strings"; description = "LuaLS package, or the command to run as a list of strings";
@ -23,7 +23,7 @@ in {
default = pkgs.lua-language-server; default = pkgs.lua-language-server;
}; };
neodev.enable = mkEnableOption "Enable neodev.nvim integration, useful for neovim plugin developers"; neodev.enable = mkEnableOption "neodev.nvim integration, useful for neovim plugin developers";
}; };
}; };

View file

@ -126,7 +126,7 @@ in {
}; };
lsp = { lsp = {
enable = mkEnableOption "Enable Nix LSP support" // {default = config.vim.languages.enableLSP;}; enable = mkEnableOption "Nix LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption { server = mkOption {
description = "Nix LSP server to use"; description = "Nix LSP server to use";
@ -142,7 +142,7 @@ in {
}; };
format = { format = {
enable = mkEnableOption "Enable Nix formatting" // {default = config.vim.languages.enableFormat;}; enable = mkEnableOption "Nix formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption { type = mkOption {
description = "Nix formatter to use"; description = "Nix formatter to use";

View file

@ -63,7 +63,7 @@ in {
enable = mkEnableOption "PHP language support"; enable = mkEnableOption "PHP language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable PHP treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "PHP treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "php"; package = nvim.types.mkGrammarOption pkgs "php";
}; };

View file

@ -136,7 +136,7 @@ in {
enable = mkEnableOption "Python language support"; enable = mkEnableOption "Python language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Python treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Python treesitter" // {default = config.vim.languages.enableTreesitter;};
package = mkOption { package = mkOption {
description = "Python treesitter grammar to use"; description = "Python treesitter grammar to use";
type = types.package; type = types.package;
@ -145,7 +145,7 @@ in {
}; };
lsp = { lsp = {
enable = mkEnableOption "Enable Python LSP support" // {default = config.vim.languages.enableLSP;}; enable = mkEnableOption "Python LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption { server = mkOption {
description = "Python LSP server to use"; description = "Python LSP server to use";
@ -162,7 +162,7 @@ in {
}; };
format = { format = {
enable = mkEnableOption "Enable Python formatting" // {default = config.vim.languages.enableFormat;}; enable = mkEnableOption "Python formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption { type = mkOption {
description = "Python formatter to use"; description = "Python formatter to use";

View file

@ -12,7 +12,7 @@ in {
enable = mkEnableOption "Rust language support"; enable = mkEnableOption "Rust language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Rust treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Rust treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "rust"; package = nvim.types.mkGrammarOption pkgs "rust";
}; };

View file

@ -72,7 +72,7 @@ in {
}; };
treesitter = { treesitter = {
enable = mkEnableOption "Enable SQL treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "SQL treesitter" // {default = config.vim.languages.enableTreesitter;};
package = mkOption { package = mkOption {
description = "SQL treesitter grammar to use"; description = "SQL treesitter grammar to use";
@ -82,7 +82,7 @@ in {
}; };
lsp = { lsp = {
enable = mkEnableOption "Enable SQL LSP support" // {default = config.vim.languages.enableLSP;}; enable = mkEnableOption "SQL LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption { server = mkOption {
description = "SQL LSP server to use"; description = "SQL LSP server to use";
@ -99,7 +99,7 @@ in {
}; };
format = { format = {
enable = mkEnableOption "Enable SQL formatting" // {default = config.vim.languages.enableFormat;}; enable = mkEnableOption "SQL formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption { type = mkOption {
description = "SQL formatter to use"; description = "SQL formatter to use";
@ -115,7 +115,7 @@ in {
}; };
extraDiagnostics = { extraDiagnostics = {
enable = mkEnableOption "Enable extra SQL diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;}; enable = mkEnableOption "extra SQL diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics { types = lib.nvim.types.diagnostics {
langDesc = "SQL"; langDesc = "SQL";

View file

@ -62,13 +62,13 @@ in {
enable = mkEnableOption "Svelte language support"; enable = mkEnableOption "Svelte language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Svelte treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Svelte treesitter" // {default = config.vim.languages.enableTreesitter;};
sveltePackage = nvim.types.mkGrammarOption pkgs "svelte"; sveltePackage = nvim.types.mkGrammarOption pkgs "svelte";
}; };
lsp = { lsp = {
enable = mkEnableOption "Enable Svelte LSP support" // {default = config.vim.languages.enableLSP;}; enable = mkEnableOption "Svelte LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption { server = mkOption {
description = "Svelte LSP server to use"; description = "Svelte LSP server to use";
@ -85,7 +85,7 @@ in {
}; };
format = { format = {
enable = mkEnableOption "Enable Svelte formatting" // {default = config.vim.languages.enableFormat;}; enable = mkEnableOption "Svelte formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption { type = mkOption {
description = "Svelte formatter to use"; description = "Svelte formatter to use";
@ -101,7 +101,7 @@ in {
}; };
extraDiagnostics = { extraDiagnostics = {
enable = mkEnableOption "Enable extra Svelte diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;}; enable = mkEnableOption "extra Svelte diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics { types = lib.nvim.types.diagnostics {
langDesc = "Svelte"; langDesc = "Svelte";

View file

@ -88,13 +88,13 @@ in {
enable = mkEnableOption "Typescript/Javascript language support"; enable = mkEnableOption "Typescript/Javascript language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Typescript/Javascript treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Typescript/Javascript treesitter" // {default = config.vim.languages.enableTreesitter;};
tsPackage = nvim.types.mkGrammarOption pkgs "tsx"; tsPackage = nvim.types.mkGrammarOption pkgs "tsx";
jsPackage = nvim.types.mkGrammarOption pkgs "javascript"; jsPackage = nvim.types.mkGrammarOption pkgs "javascript";
}; };
lsp = { lsp = {
enable = mkEnableOption "Enable Typescript/Javascript LSP support" // {default = config.vim.languages.enableLSP;}; enable = mkEnableOption "Typescript/Javascript LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption { server = mkOption {
description = "Typescript/Javascript LSP server to use"; description = "Typescript/Javascript LSP server to use";
@ -111,7 +111,7 @@ in {
}; };
format = { format = {
enable = mkEnableOption "Enable Typescript/Javascript formatting" // {default = config.vim.languages.enableFormat;}; enable = mkEnableOption "Typescript/Javascript formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption { type = mkOption {
description = "Typescript/Javascript formatter to use"; description = "Typescript/Javascript formatter to use";
@ -127,7 +127,7 @@ in {
}; };
extraDiagnostics = { extraDiagnostics = {
enable = mkEnableOption "Enable extra Typescript/Javascript diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;}; enable = mkEnableOption "extra Typescript/Javascript diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics { types = lib.nvim.types.diagnostics {
langDesc = "Typescript/Javascript"; langDesc = "Typescript/Javascript";

View file

@ -12,7 +12,7 @@ in {
enable = mkEnableOption "Zig language support"; enable = mkEnableOption "Zig language support";
treesitter = { treesitter = {
enable = mkEnableOption "Enable Zig treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Zig treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "zig"; package = nvim.types.mkGrammarOption pkgs "zig";
}; };

View file

@ -2,7 +2,7 @@
with lib; { with lib; {
options.vim.lsp = { options.vim.lsp = {
nvimCodeActionMenu = { nvimCodeActionMenu = {
enable = mkEnableOption "Enable nvim code action menu"; enable = mkEnableOption "nvim code action menu";
show = { show = {
details = mkEnableOption "Show details" // {default = true;}; details = mkEnableOption "Show details" // {default = true;};

View file

@ -2,7 +2,7 @@
with lib; { with lib; {
options.vim.lsp = { options.vim.lsp = {
trouble = { trouble = {
enable = mkEnableOption "Enable trouble diagnostics viewer"; enable = mkEnableOption "trouble diagnostics viewer";
mappings = { mappings = {
toggle = mkMappingOption "Toggle trouble [trouble]" "<leader>xx"; toggle = mkMappingOption "Toggle trouble [trouble]" "<leader>xx";

View file

@ -22,7 +22,7 @@ with builtins; {
}; };
treesitter = { treesitter = {
enable = mkEnableOption "Enable Orgmode treesitter" // {default = config.vim.languages.enableTreesitter;}; enable = mkEnableOption "Orgmode treesitter" // {default = config.vim.languages.enableTreesitter;};
orgPackage = nvim.types.mkGrammarOption pkgs "org"; orgPackage = nvim.types.mkGrammarOption pkgs "org";
}; };

View file

@ -6,7 +6,7 @@
with lib; with lib;
with builtins; { with builtins; {
options.vim.projects.project-nvim = { options.vim.projects.project-nvim = {
enable = mkEnableOption "Enable project-nvim for project management"; enable = mkEnableOption "project-nvim for project management";
manualMode = mkOption { manualMode = mkOption {
type = types.bool; type = types.bool;

View file

@ -7,7 +7,7 @@
with lib; with lib;
with builtins; { with builtins; {
options.vim.terminal.toggleterm = { options.vim.terminal.toggleterm = {
enable = mkEnableOption "Enable toggleterm as a replacement to built-in terminal command"; enable = mkEnableOption "toggleterm as a replacement to built-in terminal command";
mappings = { mappings = {
open = mkOption { open = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;

View file

@ -23,7 +23,7 @@ in {
# TODO: make per-plugin borders configurable # TODO: make per-plugin borders configurable
plugins = let plugins = let
mkPluginStyleOption = name: { mkPluginStyleOption = name: {
enable = mkEnableOption "whether to enable borders for the ${name} plugin" // {default = cfg.enable;}; enable = mkEnableOption "borders for the ${name} plugin" // {default = cfg.enable;};
style = mkOption { style = mkOption {
type = types.enum (defaultStyles ++ lib.optionals (name != "which-key") ["shadow"]); type = types.enum (defaultStyles ++ lib.optionals (name != "which-key") ["shadow"]);

View file

@ -12,12 +12,12 @@ in {
nvimWebDevicons.enable = mkEnableOption "dev icons. Required for certain plugins [nvim-web-devicons]."; nvimWebDevicons.enable = mkEnableOption "dev icons. Required for certain plugins [nvim-web-devicons].";
scrollBar.enable = mkEnableOption "Enable scrollbar [scrollbar.nvim]"; scrollBar.enable = mkEnableOption "scrollbar [scrollbar.nvim]";
smoothScroll.enable = mkEnableOption "Enable smooth scrolling [cinnamon-nvim]"; smoothScroll.enable = mkEnableOption "smooth scrolling [cinnamon-nvim]";
cellularAutomaton = { cellularAutomaton = {
enable = mkEnableOption "Enable cellular automaton [cellular-automaton]"; enable = mkEnableOption "cellular automaton [cellular-automaton]";
mappings = { mappings = {
makeItRain = mkMappingOption "Make it rain [cellular-automaton]" "<leader>fml"; makeItRain = mkMappingOption "Make it rain [cellular-automaton]" "<leader>fml";
@ -25,7 +25,7 @@ in {
}; };
fidget-nvim = { fidget-nvim = {
enable = mkEnableOption "Enable nvim LSP UI element [fidget-nvim]"; enable = mkEnableOption "nvim LSP UI element [fidget-nvim]";
align = { align = {
bottom = mkOption { bottom = mkOption {
@ -59,7 +59,7 @@ in {
}; };
indentBlankline = { indentBlankline = {
enable = mkEnableOption "Enable indentation guides [indent-blankline]"; enable = mkEnableOption "indentation guides [indent-blankline]";
listChar = mkOption { listChar = mkOption {
type = types.str; type = types.str;