Skip to content
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

fix enable option descriptions #169

Merged
merged 1 commit into from
Oct 21, 2023
Merged

fix enable option descriptions #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions modules/debugger/nvim-dap/nvim-dap.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{lib, ...}:
with lib; {
options.vim.debugger.nvim-dap = {
enable = mkEnableOption "Enable debugging via nvim-dap";
enable = mkEnableOption "debugging via nvim-dap";

ui = {
enable = mkEnableOption "Enable UI extension for nvim-dap";
enable = mkEnableOption "UI extension for nvim-dap";
autoStart = mkOption {
type = types.bool;
default = true;
Expand Down
2 changes: 1 addition & 1 deletion modules/filetree/nvimtree/nvimtree.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ with builtins; {

type = types.submodule {
options = {
enable = mkEnableOption "Enable diagnostics view in the signcolumn.";
enable = mkEnableOption "diagnostics view in the signcolumn.";

debounceDelay = mkOption {
description = "Idle milliseconds between diagnostic event and update.";
Expand Down
2 changes: 1 addition & 1 deletion modules/languages/clang.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ in {
};

lsp = {
enable = mkEnableOption "Enable clang LSP support" // {default = config.vim.languages.enableLSP;};
enable = mkEnableOption "clang LSP support" // {default = config.vim.languages.enableLSP;};

server = mkOption {
description = "The clang LSP server to use";
Expand Down
2 changes: 1 addition & 1 deletion modules/languages/dart/dart.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ in {
enable = mkEnableOption "Dart language support";

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";
};

Expand Down
4 changes: 2 additions & 2 deletions modules/languages/go.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,13 @@ in {
enable = mkEnableOption "Go language support";

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";
};

lsp = {
enable = mkEnableOption "Enable Go LSP support" // {default = config.vim.languages.enableLSP;};
enable = mkEnableOption "Go LSP support" // {default = config.vim.languages.enableLSP;};

server = mkOption {
description = "Go LSP server to use";
Expand Down
2 changes: 1 addition & 1 deletion modules/languages/java.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ in {
enable = mkEnableOption "Java language support";

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";
};

Expand Down
6 changes: 3 additions & 3 deletions modules/languages/lua.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,19 @@ in {
options.vim.languages.lua = {
enable = mkEnableOption "Lua language support";
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";
};
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 {
description = "LuaLS package, or the command to run as a list of strings";
type = with types; either package (listOf str);
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";
};
};

Expand Down
4 changes: 2 additions & 2 deletions modules/languages/nix.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ in {
};

lsp = {
enable = mkEnableOption "Enable Nix LSP support" // {default = config.vim.languages.enableLSP;};
enable = mkEnableOption "Nix LSP support" // {default = config.vim.languages.enableLSP;};

server = mkOption {
description = "Nix LSP server to use";
Expand All @@ -142,7 +142,7 @@ in {
};

format = {
enable = mkEnableOption "Enable Nix formatting" // {default = config.vim.languages.enableFormat;};
enable = mkEnableOption "Nix formatting" // {default = config.vim.languages.enableFormat;};

type = mkOption {
description = "Nix formatter to use";
Expand Down
2 changes: 1 addition & 1 deletion modules/languages/php.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ in {
enable = mkEnableOption "PHP language support";

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";
};

Expand Down
6 changes: 3 additions & 3 deletions modules/languages/python.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ in {
enable = mkEnableOption "Python language support";

treesitter = {
enable = mkEnableOption "Enable Python treesitter" // {default = config.vim.languages.enableTreesitter;};
enable = mkEnableOption "Python treesitter" // {default = config.vim.languages.enableTreesitter;};
package = mkOption {
description = "Python treesitter grammar to use";
type = types.package;
Expand All @@ -145,7 +145,7 @@ in {
};

lsp = {
enable = mkEnableOption "Enable Python LSP support" // {default = config.vim.languages.enableLSP;};
enable = mkEnableOption "Python LSP support" // {default = config.vim.languages.enableLSP;};

server = mkOption {
description = "Python LSP server to use";
Expand All @@ -162,7 +162,7 @@ in {
};

format = {
enable = mkEnableOption "Enable Python formatting" // {default = config.vim.languages.enableFormat;};
enable = mkEnableOption "Python formatting" // {default = config.vim.languages.enableFormat;};

type = mkOption {
description = "Python formatter to use";
Expand Down
2 changes: 1 addition & 1 deletion modules/languages/rust.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ in {
enable = mkEnableOption "Rust language support";

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";
};

Expand Down
8 changes: 4 additions & 4 deletions modules/languages/sql.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ in {
};

treesitter = {
enable = mkEnableOption "Enable SQL treesitter" // {default = config.vim.languages.enableTreesitter;};
enable = mkEnableOption "SQL treesitter" // {default = config.vim.languages.enableTreesitter;};

package = mkOption {
description = "SQL treesitter grammar to use";
Expand All @@ -82,7 +82,7 @@ in {
};

lsp = {
enable = mkEnableOption "Enable SQL LSP support" // {default = config.vim.languages.enableLSP;};
enable = mkEnableOption "SQL LSP support" // {default = config.vim.languages.enableLSP;};

server = mkOption {
description = "SQL LSP server to use";
Expand All @@ -99,7 +99,7 @@ in {
};

format = {
enable = mkEnableOption "Enable SQL formatting" // {default = config.vim.languages.enableFormat;};
enable = mkEnableOption "SQL formatting" // {default = config.vim.languages.enableFormat;};

type = mkOption {
description = "SQL formatter to use";
Expand All @@ -115,7 +115,7 @@ in {
};

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 {
langDesc = "SQL";
Expand Down
8 changes: 4 additions & 4 deletions modules/languages/svelte.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,13 @@ in {
enable = mkEnableOption "Svelte language support";

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";
};

lsp = {
enable = mkEnableOption "Enable Svelte LSP support" // {default = config.vim.languages.enableLSP;};
enable = mkEnableOption "Svelte LSP support" // {default = config.vim.languages.enableLSP;};

server = mkOption {
description = "Svelte LSP server to use";
Expand All @@ -85,7 +85,7 @@ in {
};

format = {
enable = mkEnableOption "Enable Svelte formatting" // {default = config.vim.languages.enableFormat;};
enable = mkEnableOption "Svelte formatting" // {default = config.vim.languages.enableFormat;};

type = mkOption {
description = "Svelte formatter to use";
Expand All @@ -101,7 +101,7 @@ in {
};

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 {
langDesc = "Svelte";
Expand Down
8 changes: 4 additions & 4 deletions modules/languages/ts.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,13 @@ in {
enable = mkEnableOption "Typescript/Javascript language support";

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";
jsPackage = nvim.types.mkGrammarOption pkgs "javascript";
};

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 {
description = "Typescript/Javascript LSP server to use";
Expand All @@ -111,7 +111,7 @@ in {
};

format = {
enable = mkEnableOption "Enable Typescript/Javascript formatting" // {default = config.vim.languages.enableFormat;};
enable = mkEnableOption "Typescript/Javascript formatting" // {default = config.vim.languages.enableFormat;};

type = mkOption {
description = "Typescript/Javascript formatter to use";
Expand All @@ -127,7 +127,7 @@ in {
};

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 {
langDesc = "Typescript/Javascript";
Expand Down
2 changes: 1 addition & 1 deletion modules/languages/zig.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ in {
enable = mkEnableOption "Zig language support";

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";
};

Expand Down
2 changes: 1 addition & 1 deletion modules/lsp/nvim-code-action-menu/nvim-code-action-menu.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
with lib; {
options.vim.lsp = {
nvimCodeActionMenu = {
enable = mkEnableOption "Enable nvim code action menu";
enable = mkEnableOption "nvim code action menu";

show = {
details = mkEnableOption "Show details" // {default = true;};
Expand Down
2 changes: 1 addition & 1 deletion modules/lsp/trouble/trouble.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
with lib; {
options.vim.lsp = {
trouble = {
enable = mkEnableOption "Enable trouble diagnostics viewer";
enable = mkEnableOption "trouble diagnostics viewer";

mappings = {
toggle = mkMappingOption "Toggle trouble [trouble]" "<leader>xx";
Expand Down
2 changes: 1 addition & 1 deletion modules/notes/orgmode/orgmode.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ with builtins; {
};

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";
};
Expand Down
2 changes: 1 addition & 1 deletion modules/projects/project-nvim/project-nvim.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
with lib;
with builtins; {
options.vim.projects.project-nvim = {
enable = mkEnableOption "Enable project-nvim for project management";
enable = mkEnableOption "project-nvim for project management";

manualMode = mkOption {
type = types.bool;
Expand Down
2 changes: 1 addition & 1 deletion modules/terminal/toggleterm/toggleterm.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
with lib;
with builtins; {
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 = {
open = mkOption {
type = types.nullOr types.str;
Expand Down
2 changes: 1 addition & 1 deletion modules/ui/borders/borders.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ in {
# TODO: make per-plugin borders configurable
plugins = let
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 {
type = types.enum (defaultStyles ++ lib.optionals (name != "which-key") ["shadow"]);
Expand Down
10 changes: 5 additions & 5 deletions modules/visuals/visuals.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ in {

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 = {
enable = mkEnableOption "Enable cellular automaton [cellular-automaton]";
enable = mkEnableOption "cellular automaton [cellular-automaton]";

mappings = {
makeItRain = mkMappingOption "Make it rain [cellular-automaton]" "<leader>fml";
};
};

fidget-nvim = {
enable = mkEnableOption "Enable nvim LSP UI element [fidget-nvim]";
enable = mkEnableOption "nvim LSP UI element [fidget-nvim]";

align = {
bottom = mkOption {
Expand Down Expand Up @@ -59,7 +59,7 @@ in {
};

indentBlankline = {
enable = mkEnableOption "Enable indentation guides [indent-blankline]";
enable = mkEnableOption "indentation guides [indent-blankline]";

listChar = mkOption {
type = types.str;
Expand Down