NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-11-22 21:30:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix mkEnableOption usage for autogenerated documentation

Browse source
This commit is contained in:
NotAShelf 2023-06-05 23:10:25 +03:00
parent 5cef662ccf
commit a2b58e17af
No known key found for this signature in database
GPG key ID: F0D14CCB5ED5AA22
55 changed files with 225 additions and 333 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
modules/assistant/copilot/copilot.nix
View file

@ -9,7 +9,7 @@ with builtins; let
cfg = config.vim.assistant.copilot;
in {
options.vim.assistant.copilot = {
enable = mkEnableOption "Enable GitHub Copilot";
enable = mkEnableOption "GitHub Copilot AI assistant";
panel = {
position = mkOption {

2
modules/assistant/tabnine/tabnine.nix
View file

@ -2,7 +2,7 @@
with lib;
with builtins; {
options.vim.assistant.tabnine = {
enable = mkEnableOption "Enable TabNine assistant";
enable = mkEnableOption "Tabnine assistant";
disable_auto_comment = mkOption {
type = types.bool;

12
modules/autopairs/nvim-autopairs/nvim-autopairs.nix
View file

@ -1,17 +1,9 @@
{
lib,
config,
...
}:
{lib, ...}:
with lib;
with builtins; {
options.vim = {
autopairs = {
enable = mkOption {
type = types.bool;
default = false;
description = "Enable autopairs";
};
enable = mkEnableOption "autopairs" // {default = false;};
type = mkOption {
type = types.enum ["nvim-autopairs"];

4
modules/basic/module.nix
View file

@ -7,7 +7,7 @@ with lib;
with builtins; {
options.vim = {
debugMode = {
enable = mkEnableOption "Enable debug mode";
enable = mkEnableOption "debug mode";
level = mkOption {
type = types.int;
default = 20;
@ -151,6 +151,6 @@ with builtins; {
description = "Highlight the text line of the cursor with CursorLine hl-CursorLine";
};
enableLuaLoader = mkEnableOption "Enable the experimental Lua module loader to speed up the start up process";
enableLuaLoader = mkEnableOption "experimental Lua module loader to speed up the start up process";
};
}

2
modules/comments/comment-nvim/comment-nvim.nix
View file

@ -2,7 +2,7 @@
with lib;
with builtins; {
options.vim.comments.comment-nvim = {
enable = mkEnableOption "Enable comment-nvim";
enable = mkEnableOption "smart and powerful comment plugin for neovim comment-nvim";
mappings = {
toggleCurrentLine = mkMappingOption "Toggle current line comment" "gcc";

6
modules/completion/nvim-cmp/nvim-cmp.nix
View file

@ -3,11 +3,7 @@ with lib;
with builtins; {
options.vim = {
autocomplete = {
enable = mkOption {
type = types.bool;
default = false;
description = "enable autocomplete";
};
enable = mkEnableOption "enable autocomplete" // {default = false;};
mappings = {
complete = mkMappingOption "Complete [nvim-cmp]" "<C-Space>";

2
modules/dashboard/alpha/alpha.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.dashboard.alpha = {
enable = mkEnableOption "Enable alpha.nvim";
enable = mkEnableOption "dashboard via alpha.nvim";
};
}

2
modules/dashboard/dashboard-nvim/dashboard-nvim.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.dashboard.dashboard-nvim = {
enable = mkEnableOption "Enable dashboard.nvim";
enable = mkEnableOption "dashboard via dashboard.nvim";
};
}

2
modules/dashboard/startify/startify.nix
View file

@ -6,7 +6,7 @@
with builtins;
with lib; {
options.vim.dashboard.startify = {
enable = mkEnableOption "Enable vim-startify";
enable = mkEnableOption "dashboard via vim-startify";
bookmarks = mkOption {
default = [];

6
modules/filetree/nvimtree-lua/nvimtree-lua.nix
View file

@ -6,11 +6,7 @@
with lib;
with builtins; {
options.vim.filetree.nvimTreeLua = {
enable = mkOption {
type = types.bool;
default = false;
description = "Enable nvim-tree-lua";
};
enable = mkEnableOption "filetree via nvim-tree-lua" // {default = false;};
mappings = {
toggle = mkOption {

2
modules/git/git.nix
View file

@ -2,7 +2,7 @@
with lib;
with builtins; {
options.vim.git = {
enable = mkEnableOption "Git support";
enable = mkEnableOption "git tools via gitsigns";
gitsigns = {
enable = mkEnableOption "gitsigns";

15
modules/languages/clang.nix
View file

@ -47,31 +47,26 @@ in {
};
treesitter = {
enable = mkOption {
description = "Enable C/C++ treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "C/C++ treesitter" // {default = config.vim.languages.enableTreesitter;};
cPackage = nvim.types.mkGrammarOption pkgs "c";
cppPackage = nvim.types.mkGrammarOption pkgs "cpp";
};
lsp = {
enable = mkOption {
description = "Enable clang LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable clang LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "The clang LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "clang LSP server package";
type = types.package;
default = servers.${cfg.lsp.server}.package;
};
opts = mkOption {
description = "Options to pass to clang LSP server";
type = with types; nullOr str;

8
modules/languages/dart/dart.nix
View file

@ -26,16 +26,12 @@ in {
enable = mkEnableOption "Dart language support";
treesitter = {
enable = mkOption {
description = "Enable Dart treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Dart treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "dart";
};
lsp = {
enable = mkEnableOption "Enable Dart LSP support";
enable = mkEnableOption "Dart LSP support";
server = mkOption {
description = "The Dart LSP server to use";
type = with types; enum (attrNames servers);

2
modules/languages/elixir/elixir-tools.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.languages.elixir = {
enable = mkEnableOption "elixir support";
enable = mkEnableOption "Elixir language support";
};
}

15
modules/languages/go.nix
View file

@ -26,25 +26,20 @@ in {
enable = mkEnableOption "Go language support";
treesitter = {
enable = mkOption {
description = "Enable Go treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Go treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "go";
};
lsp = {
enable = mkOption {
description = "Enable Go LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Go LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Go LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "Go LSP server package";
type = types.package;

2
modules/languages/markdown/markdown.nix
View file

@ -9,7 +9,7 @@ with builtins; let
cfg = config.vim.languages.markdown;
in {
options.vim.languages.markdown = {
enable = mkEnableOption "Markdown language support";
enable = mkEnableOption "Markdown markup language support";
glow.enable = mkOption {
type = types.bool;

14
modules/languages/nix.nix
View file

@ -96,11 +96,8 @@ in {
};
lsp = {
enable = mkOption {
description = "Enable Nix LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Nix LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Nix LSP server to use";
type = types.str;
@ -114,11 +111,8 @@ in {
};
format = {
enable = mkOption {
description = "Enable Nix formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable Nix formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "Nix formatter to use";
type = with types; enum (attrNames formats);

22
modules/languages/python.nix
View file

@ -41,11 +41,7 @@ in {
enable = mkEnableOption "Python language support";
treesitter = {
enable = mkOption {
description = "Enable Python treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Python treesitter" // {default = config.vim.languages.enableTreesitter;};
package = mkOption {
description = "Python treesitter grammar to use";
type = types.package;
@ -54,16 +50,14 @@ in {
};
lsp = {
enable = mkOption {
description = "Enable Python LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Python LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Python LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "python LSP server package";
type = types.package;
@ -72,16 +66,14 @@ in {
};
format = {
enable = mkOption {
description = "Enable Python formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable Python formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "Python formatter to use";
type = with types; enum (attrNames formats);
default = defaultFormat;
};
package = mkOption {
description = "Python formatter package";
type = types.package;

14
modules/languages/rust.nix
View file

@ -12,11 +12,7 @@ in {
enable = mkEnableOption "Rust language support";
treesitter = {
enable = mkOption {
description = "Enable Rust treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Rust treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "rust";
};
@ -30,16 +26,14 @@ in {
};
lsp = {
enable = mkOption {
description = "Rust LSP support (rust-analyzer with extra tools)";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Rust LSP support (rust-analyzer with extra tools)" // {default = config.vim.languages.enableLSP;};
package = mkOption {
description = "rust-analyzer package";
type = types.package;
default = pkgs.rust-analyzer;
};
opts = mkOption {
description = "Options to pass to rust analyzer";
type = types.str;

30
modules/languages/sql.nix
View file

@ -68,11 +68,8 @@ in {
};
treesitter = {
enable = mkOption {
description = "Enable SQL treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable SQL treesitter" // {default = config.vim.languages.enableTreesitter;};
package = mkOption {
description = "SQL treesitter grammar to use";
type = types.package;
@ -81,16 +78,14 @@ in {
};
lsp = {
enable = mkOption {
description = "Enable SQL LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable SQL LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "SQL LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "SQL LSP server package";
type = types.package;
@ -99,16 +94,14 @@ in {
};
format = {
enable = mkOption {
description = "Enable SQL formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable SQL formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "SQL formatter to use";
type = with types; enum (attrNames formats);
default = defaultFormat;
};
package = mkOption {
description = "SQL formatter package";
type = types.package;
@ -117,11 +110,8 @@ in {
};
extraDiagnostics = {
enable = mkOption {
description = "Enable extra SQL diagnostics";
type = types.bool;
default = config.vim.languages.enableExtraDiagnostics;
};
enable = mkEnableOption "Enable extra SQL diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics {
langDesc = "SQL";
inherit diagnostics;

30
modules/languages/svelte.nix
View file

@ -58,25 +58,20 @@ in {
enable = mkEnableOption "Svelte language support";
treesitter = {
enable = mkOption {
description = "Enable Svelte treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Svelte treesitter" // {default = config.vim.languages.enableTreesitter;};
sveltePackage = nvim.types.mkGrammarOption pkgs "svelte";
};
lsp = {
enable = mkOption {
description = "Enable Svelte LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Svelte LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Svelte LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "Svelte LSP server package";
type = types.package;
@ -85,16 +80,14 @@ in {
};
format = {
enable = mkOption {
description = "Enable Svelte formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable Svelte formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "Svelte formatter to use";
type = with types; enum (attrNames formats);
default = defaultFormat;
};
package = mkOption {
description = "Svelte formatter package";
type = types.package;
@ -103,11 +96,8 @@ in {
};
extraDiagnostics = {
enable = mkOption {
description = "Enable extra Svelte diagnostics";
type = types.bool;
default = config.vim.languages.enableExtraDiagnostics;
};
enable = mkEnableOption "Enable extra Svelte diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics {
langDesc = "Svelte";
inherit diagnostics;

2
modules/languages/tidal/tidal.nix
View file

@ -6,7 +6,7 @@
with lib;
with builtins; {
options.vim.tidal = {
enable = mkEnableOption "Enable tidalcycles tools and plugins";
enable = mkEnableOption "tidalcycles tools and plugins";
flash = mkOption {
description = ''When sending a paragraph or a single line, vim-tidal will "flash" the selection for some milliseconds'';

29
modules/languages/ts.nix
View file

@ -58,26 +58,20 @@ in {
enable = mkEnableOption "Typescript/Javascript language support";
treesitter = {
enable = mkOption {
description = "Enable Typescript/Javascript treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Typescript/Javascript treesitter" // {default = config.vim.languages.enableTreesitter;};
tsPackage = nvim.types.mkGrammarOption pkgs "tsx";
jsPackage = nvim.types.mkGrammarOption pkgs "javascript";
};
lsp = {
enable = mkOption {
description = "Enable Typescript/Javascript LSP support";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Enable Typescript/Javascript LSP support" // {default = config.vim.languages.enableLSP;};
server = mkOption {
description = "Typescript/Javascript LSP server to use";
type = with types; enum (attrNames servers);
default = defaultServer;
};
package = mkOption {
description = "Typescript/Javascript LSP server package";
type = types.package;
@ -86,16 +80,14 @@ in {
};
format = {
enable = mkOption {
description = "Enable Typescript/Javascript formatting";
type = types.bool;
default = config.vim.languages.enableFormat;
};
enable = mkEnableOption "Enable Typescript/Javascript formatting" // {default = config.vim.languages.enableFormat;};
type = mkOption {
description = "Typescript/Javascript formatter to use";
type = with types; enum (attrNames formats);
default = defaultFormat;
};
package = mkOption {
description = "Typescript/Javascript formatter package";
type = types.package;
@ -104,11 +96,8 @@ in {
};
extraDiagnostics = {
enable = mkOption {
description = "Enable extra Typescript/Javascript diagnostics";
type = types.bool;
default = config.vim.languages.enableExtraDiagnostics;
};
enable = mkEnableOption "Enable extra Typescript/Javascript diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
types = lib.nvim.types.diagnostics {
langDesc = "Typescript/Javascript";
inherit diagnostics;

15
modules/languages/zig.nix
View file

@ -12,24 +12,19 @@ in {
enable = mkEnableOption "SQL language support";
treesitter = {
enable = mkOption {
description = "Enable Zig treesitter";
type = types.bool;
default = config.vim.languages.enableTreesitter;
};
enable = mkEnableOption "Enable Zig treesitter" // {default = config.vim.languages.enableTreesitter;};
package = nvim.types.mkGrammarOption pkgs "zig";
};
lsp = {
enable = mkOption {
description = "Zig LSP support (zls)";
type = types.bool;
default = config.vim.languages.enableLSP;
};
enable = mkEnableOption "Zig LSP support (zls)" // {default = config.vim.languages.enableLSP;};
package = mkOption {
description = "ZLS package";
type = types.package;
default = pkgs.zls;
};
zigPackage = mkOption {
description = "Zig package used by ZLS";
type = types.package;

2
modules/minimap/codewindow/codewindow.nix
View file

@ -1,7 +1,7 @@
{lib, ...}:
with lib; {
options.vim.minimap.codewindow = {
enable = mkEnableOption "Enable codewindow plugin for minimap view";
enable = mkEnableOption "codewindow plugin for minimap view";
mappings = {
open = mkMappingOption "Open minimap [codewindow]" "<leader>mo";

2
modules/minimap/minimap-vim/minimap-vim.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.minimap.minimap-vim = {
enable = mkEnableOption "Enable minimap-vim plugin for minimap view";
enable = mkEnableOption "minimap-vim plugin for minimap view";
};
}

2
modules/notes/mind-nvim/mind-nvim.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.notes.mind-nvim = {
enable = mkEnableOption "The power of trees at your fingertips. ";
enable = mkEnableOption "organizer tool for Neovim.";
};
}

2
modules/notes/obsidian/obsidian.nix
View file

@ -7,7 +7,7 @@ with lib;
with builtins; {
options.vim.notes = {
obsidian = {
enable = mkEnableOption "Complementary neovim plugins for Obsidian editor";
enable = mkEnableOption "complementary neovim plugins for Obsidian editor";
dir = mkOption {
type = types.str;
default = "~/my-vault";

6
modules/notes/orgmode/orgmode.nix
View file

@ -6,15 +6,15 @@
with lib;
with builtins; {
options.vim.notes.orgmode = {
enable = mkEnableOption "Enable nvim-orgmode: Neovim plugin for Emac Orgmode. Get the best of both worlds";
enable = mkEnableOption "nvim-orgmode: Neovim plugin for Emac Orgmode. Get the best of both worlds";
orgAgendaFiles = mkOption {
type = types.str;
default = "{'~/Dropbox/org/*', '~/my-orgs/**/*'}";
default = "{'~/Documents/org/*', '~/my-orgs/**/*'}";
description = "List of org files to be used as agenda files.";
};
orgDefaultNotesFile = mkOption {
type = types.str;
default = "~/Dropbox/org/refile.org";
default = "~/Documents/org/refile.org";
description = "Default org file to be used for notes.";
};
};

2
modules/notes/todo-comments/todo-comments.nix
View file

@ -2,7 +2,7 @@
with lib;
with builtins; {
options.vim.notes.todo-comments = {
enable = mkEnableOption "Enable todo-comments";
enable = mkEnableOption "todo-comments: highlight and search for todo comments like TODO, HACK, BUG in your code base";
patterns = {
highlight = mkOption {

82
modules/projects/project-nvim/config.nix
View file

@ -4,59 +4,49 @@
...
}:
with lib;
with builtins; {
options.vim.projects.project-nvim = {
enable = mkEnableOption "Enable project-nvim for project management";
with builtins; let
cfg = config.vim.projects.project-nvim;
in {
config = mkIf cfg.enable {
vim.startPlugins = [
"project-nvim"
];
manualMode = mkOption {
type = types.bool;
default = true;
description = "don't automatically change the root directory so the user has the option to manually do so using `:ProjectRoot` command";
};
vim.luaConfigRC.project-nvim = nvim.dag.entryAnywhere ''
require('project_nvim').setup({
manual_mode = ${boolToString cfg.manualMode},
detection_methods = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.detectionMethods)} },
# detection methods should accept one or more strings from a list
detectionMethods = mkOption {
type = types.listOf types.str;
default = ["lsp" "pattern"];
description = "Detection methods to use";
};
-- All the patterns used to detect root dir, when **"pattern"** is in
-- detection_methods
patterns = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.patterns)} },
# patterns
patterns = mkOption {
type = types.listOf types.str;
default = [".git" "_darcs" ".hg" ".bzr" ".svn" "Makefile" "package.json" "flake.nix" "cargo.toml"];
description = "Patterns to use for pattern detection method";
};
-- Table of lsp clients to ignore by name
-- eg: { "efm", ... }
ignore_lsp = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.lspIgnored)} },
# table of lsp servers to ignore by name
lspIgnored = mkOption {
type = types.listOf types.str;
default = [];
description = "LSP servers no ignore by name";
};
-- Don't calculate root dir on specific directories
-- Ex: { "~/.cargo/*", ... }
exclude_dirs = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.excludeDirs)} },
excludeDirs = mkOption {
type = types.listOf types.str;
default = [];
description = "Directories to exclude from project root search";
};
-- Show hidden files in telescope
show_hidden = ${boolToString cfg.showHidden},
showHidden = mkOption {
type = types.bool;
default = false;
description = "Show hidden files in telescope picker";
};
-- When set to false, you will get a message when project.nvim changes your
-- directory.
silent_chdir = ${boolToString cfg.silentChdir},
silentChdir = mkOption {
type = types.bool;
default = true;
description = "Silently change directory when changing project";
};
-- What scope to change the directory, valid options are
-- * global (default)
-- * tab
-- * win
scope_chdir = '${toString cfg.scopeChdir}',
scopeChdir = mkOption {
type = types.enum ["global" "tab" "win"];
default = "global";
description = "What scope to change the directory";
};
-- Path where project.nvim will store the project history for use in
-- telescope
datapath = vim.fn.stdpath("data"),
})
'';
};
}

82
modules/projects/project-nvim/project-nvim.nix
View file

@ -4,48 +4,60 @@
...
}:
with lib;
with builtins; let
cfg = config.vim.projects.project-nvim;
in {
config = mkIf cfg.enable {
vim.startPlugins = [
"project-nvim"
];
with builtins; {
options.vim.projects.project-nvim = {
enable = mkEnableOption "Enable project-nvim for project management";
vim.luaConfigRC.project-nvim = nvim.dag.entryAnywhere ''
require('project_nvim').setup({
manual_mode = ${boolToString cfg.manualMode},
detection_methods = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.detectionMethods)} },
manualMode = mkOption {
type = types.bool;
default = true;
description = "don't automatically change the root directory so the user has the option to manually do so using `:ProjectRoot` command";
};
-- All the patterns used to detect root dir, when **"pattern"** is in
-- detection_methods
patterns = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.patterns)} },
# detection methods should accept one or more strings from a list
detectionMethods = mkOption {
type = types.listOf types.str;
default = ["lsp" "pattern"];
description = "Detection methods to use";
};
-- Table of lsp clients to ignore by name
-- eg: { "efm", ... }
ignore_lsp = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.lspIgnored)} },
# patterns
patterns = mkOption {
type = types.listOf types.str;
default = [".git" "_darcs" ".hg" ".bzr" ".svn" "Makefile" "package.json" "flake.nix" "cargo.toml"];
description = "Patterns to use for pattern detection method";
};
-- Don't calculate root dir on specific directories
-- Ex: { "~/.cargo/*", ... }
exclude_dirs = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.excludeDirs)} },
# table of lsp servers to ignore by name
lspIgnored = mkOption {
type = types.listOf types.str;
default = [];
description = "LSP servers no ignore by name";
};
-- Show hidden files in telescope
show_hidden = ${boolToString cfg.showHidden},
excludeDirs = mkOption {
type = types.listOf types.str;
default = [];
description = "Directories to exclude from project root search";
};
-- When set to false, you will get a message when project.nvim changes your
-- directory.
silent_chdir = ${boolToString cfg.silentChdir},
showHidden = mkOption {
type = types.bool;
default = false;
description = "Show hidden files in telescope picker";
};
-- What scope to change the directory, valid options are
-- * global (default)
-- * tab
-- * win
scope_chdir = '${toString cfg.scopeChdir}',
silentChdir = mkOption {
type = types.bool;
default = true;
description = "Silently change directory when changing project";
};
-- Path where project.nvim will store the project history for use in
-- telescope
datapath = vim.fn.stdpath("data"),
})
'';
scopeChdir = mkOption {
type = types.enum ["global" "tab" "win"];
default = "global";
description = "What scope to change the directory";
};
};
}

2
modules/rich-presence/presence-nvim/presence-nvim.nix
View file

@ -6,7 +6,7 @@
with lib;
with builtins; {
options.vim.presence.presence-nvim = {
enable = mkEnableOption "Enable presence.nvim plugin for discord rich presence";
enable = mkEnableOption "presence.nvim plugin for discord rich presence";
image_text = mkOption {
type = types.str;

2
modules/session/nvim-session-manager/nvim-session-manager.nix
View file

@ -6,7 +6,7 @@
with lib;
with builtins; {
options.vim.session.nvim-session-manager = {
enable = mkEnableOption "Enable nvim-session-manager";
enable = mkEnableOption "nvim-session-manager: manage sessions like folders in VSCode";
mappings = {
loadSession = mkOption {

11
modules/snippets/vsnip/vsnip.nix
View file

@ -1,11 +1,6 @@
{
config,
lib,
...
}:
with lib;
with builtins; {
{lib, ...}:
with lib; {
options.vim.snippets.vsnip = {
enable = mkEnableOption "Enable vim-vsnip";
enable = mkEnableOption "vim-vsnip: snippet LSP/VSCode's format";
};
}

21
modules/statusline/lualine/lualine.nix
View file

@ -8,14 +8,10 @@ with builtins; let
supported_themes = import ./supported_themes.nix;
in {
options.vim.statusline.lualine = {
enable = mkEnableOption "lualine";
enable = mkEnableOption "lualine statusline plugin";
icons = {
enable = mkOption {
type = types.bool;
description = "Enable icons for lualine";
default = true;
};
enable = mkEnableOption "icons for lualine" // {default = true;};
};
refresh = {
@ -125,6 +121,7 @@ in {
"mode",
separator = {
left = '▎',
right = ''
},
},
}
@ -184,7 +181,12 @@ in {
{
"diagnostics",
sources = {'nvim_lsp', 'nvim_diagnostic', 'coc'},
symbols = {error = '󰅙 ', warn = ' ', info = ' ', hint = '󰌵 '}
symbols = {error = '󰅙 ', warn = ' ', info = ' ', hint = '󰌵 '},
diagnostics_color = {
color_error = { fg = colors.red },
color_warn = { fg = colors.yellow },
color_info = { fg = colors.cyan },
},
},
}
'';
@ -224,12 +226,7 @@ in {
{
"branch",
icon = ' •',
separator = {
left = '(',
right = ')'
},
color = {bg='none', fg='lavender'},
},
}
'';

4
modules/tabline/nvim-bufferline/nvim-bufferline.nix
View file

@ -2,6 +2,8 @@
with lib;
with builtins; {
options.vim.tabline.nvimBufferline = {
enable = mkEnableOption "nvim-bufferline-lua as a bufferline";
mappings = {
closeCurrent = mkMappingOption "Close buffer" null;
cycleNext = mkMappingOption "Next buffer" "<leader>bn";
@ -13,7 +15,5 @@ with builtins; {
moveNext = mkMappingOption "Move next buffer" "<leader>bmn";
movePrevious = mkMappingOption "Move previous buffer" "<leader>bmp";
};
enable = mkEnableOption "Enable nvim-bufferline-lua as a bufferline";
};
}

6
modules/terminal/toggleterm/toggleterm.nix
View file

@ -15,23 +15,27 @@ with builtins; {
default = "<c-t>";
};
};
direction = mkOption {
type = types.enum ["horizontal" "vertical" "tab" "float"];
default = "horizontal";
description = "Direction of the terminal";
};
enable_winbar = mkOption {
type = types.bool;
default = false;
description = "Enable winbar";
};
lazygit = {
enable = mkEnableOption "Enable LazyGit integration";
enable = mkEnableOption "LazyGit integration";
direction = mkOption {
type = types.enum ["horizontal" "vertical" "tab" "float"];
default = "float";
description = "Direction of the lazygit window";
};
package = mkOption {
type = with types; nullOr package;
default = pkgs.lazygit;

2
modules/ui/colorizer/colorizer.nix
View file

@ -6,7 +6,7 @@
with lib;
with builtins; {
options.vim.ui.colorizer = {
enable = mkEnableOption "Enable nvim-colorizer.lua for color highlighting";
enable = mkEnableOption "nvim-colorizer.lua for color highlighting";
options = {
rgb = mkOption {

2
modules/ui/modes/modes.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.ui.modes-nvim = {
enable = mkEnableOption "Enable modes.nvim UI elements";
enable = mkEnableOption "modes.nvim's prismatic line decorations";
};
}

2
modules/ui/noice/noice.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.ui.noice = {
enable = mkEnableOption "Enable noice-nvim UI modifications";
enable = mkEnableOption "noice-nvim UI modification library";
};
}

8
modules/ui/notifications/nvim-notify/nvim-notify.nix
View file

@ -6,29 +6,34 @@
with lib;
with builtins; {
options.vim.notify.nvim-notify = {
enable = mkEnableOption "Enable nvim-notify plugin";
enable = mkEnableOption "nvim-notify notifications";
stages = mkOption {
type = types.enum ["fade_in_slide_out" "fade_in" "slide_out" "none"];
default = "fade_in_slide_out";
description = "The stages of the notification";
};
timeout = mkOption {
type = types.int;
default = 1000;
description = "The timeout of the notification";
};
background_colour = mkOption {
type = types.str;
default = "#000000";
description = "The background colour of the notification";
};
position = mkOption {
type = types.enum ["top_left" "top_right" "bottom_left" "bottom_right"];
default = "top_right";
description = "The position of the notification";
};
icons = mkOption {
type = types.attrsOf types.str;
description = "The icons of the notification";
default = {
ERROR = "";
WARN = "";
@ -36,7 +41,6 @@ with builtins; {
DEBUG = "";
TRACE = "";
};
description = "The icons of the notification";
};
};
}

2
modules/ui/smartcolumn/smartcolumn.nix
View file

@ -2,7 +2,7 @@
with lib;
with builtins; {
options.vim.ui.smartcolumn = {
enable = mkEnableOption "Enable Smartcolumn line length indicator";
enable = mkEnableOption "line length indicator";
showColumnAt = mkOption {
type = types.nullOr types.int;

2
modules/utility/binds/cheatsheet/cheatsheet.nix
View file

@ -6,6 +6,6 @@
with lib;
with builtins; {
options.vim.binds.cheatsheet = {
enable = mkEnableOption "Enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope";
enable = mkEnableOption "cheatsheet-nvim: searchable cheatsheet for nvim using telescope";
};
}

8
modules/utility/binds/which-key/which-key.nix
View file

@ -1,11 +1,7 @@
{
config,
lib,
...
}:
{lib, ...}:
with lib;
with builtins; {
options.vim.binds.whichKey = {
enable = mkEnableOption "Enable which-key keybind menu";
enable = mkEnableOption "which-key keybind helper menu";
};
}

2
modules/utility/ccc/ccc.nix
View file

@ -2,7 +2,7 @@
with lib;
with builtins; {
options.vim.utility.ccc = {
enable = mkEnableOption "Enable ccc color picker for neovim";
enable = mkEnableOption "ccc color picker for neovim";
mappings = {
quit = mkMappingOption "Cancel and close the UI without replace or insert" "<Esc>";

8
modules/utility/diffview/diffview.nix
View file

@ -1,11 +1,7 @@
{
config,
lib,
...
}:
{lib, ...}:
with lib;
with builtins; {
options.vim.utility.diffview-nvim = {
enable = mkEnableOption "Enable diffview-nvim";
enable = mkEnableOption "diffview-nvim: cycle through diffs for all modified files for any git rev";
};
}

2
modules/utility/gestures/gesture-nvim/gesture-nvim.nix
View file

@ -1,7 +1,7 @@
{lib, ...}:
with lib; {
options.vim.gestures.gesture-nvim = {
enable = mkEnableOption "Enable gesture-nvim plugin";
enable = mkEnableOption "gesture-nvim: mouse gestures";
mappings = {
draw = mkMappingOption "Start drawing [gesture.nvim]" "<LeftDrag>";

8
modules/utility/icon-picker/icon-picker.nix
View file

@ -1,11 +1,7 @@
{
config,
lib,
...
}:
{lib, ...}:
with lib;
with builtins; {
options.vim.utility.icon-picker = {
enable = mkEnableOption "Enable nerdfonts icon picker for nvim";
enable = mkEnableOption "nerdfonts icon picker for nvim";
};
}

2
modules/utility/motion/hop/hop.nix
View file

@ -5,6 +5,6 @@ with lib; {
hop = mkMappingOption "Jump to occurences [hop.nvim]" "<leader>h";
};
enable = mkEnableOption "Enable Hop.nvim plugin (easy motion)";
enable = mkEnableOption "Hop.nvim plugin (easy motion)";
};
}

2
modules/utility/motion/leap/leap.nix
View file

@ -2,7 +2,7 @@
with lib;
with builtins; {
options.vim.utility.motion.leap = {
enable = mkEnableOption "Enable leap.nvim plugin (easy motion)";
enable = mkEnableOption "leap.nvim plugin (easy motion)";
mappings = {
leapForwardTo = mkOption {

5
modules/utility/telescope/config.nix
View file

@ -45,6 +45,11 @@ in {
mkIf config.vim.treesitter.enable
(mkSetBinding mappings.treesitter "<cmd> Telescope treesitter<CR>")
)
(
mkIf config.vim.projects.project-nvim.enable
(mkSetBinding mappings.findProjects "<cmd Telescope projects<CR>")
)
];
vim.luaConfigRC.telescope = nvim.dag.entryAnywhere ''

4
modules/utility/telescope/telescope.nix
View file

@ -3,6 +3,8 @@ with lib;
with builtins; {
options.vim.telescope = {
mappings = {
findProjects = mkMappingOption "Find files [Telescope]" "<leader>fp";
findFiles = mkMappingOption "Find files [Telescope]" "<leader>ff";
liveGrep = mkMappingOption "Live grep [Telescope]" "<leader>fg";
buffers = mkMappingOption "Buffers [Telescope]" "<leader>fb";
@ -26,6 +28,6 @@ with builtins; {
treesitter = mkMappingOption "Treesitter [Telescope]" "<leader>fs";
};
enable = mkEnableOption "Enable multi-purpose telescope utility";
enable = mkEnableOption "telescope.nvim: multi-purpose search & picker utility";
};
}

2
modules/utility/wakatime/vim-wakatime.nix
View file

@ -6,7 +6,7 @@
with lib;
with builtins; {
options.vim.utility.vim-wakatime = {
enable = mkEnableOption "Enable vim-wakatime";
enable = mkEnableOption "vim-wakatime: live code statistics";
cli-package = mkOption {
type = with types; nullOr package;

31
modules/visuals/visuals.nix
View file

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