From cacb0221d9642c5ab5437cb5c6cc43344ea9648b Mon Sep 17 00:00:00 2001 From: Arpit Chakladar Date: Fri, 10 Apr 2026 23:41:56 +0530 Subject: Added documentation comments for the tools configs --- modules/tools/nixvim/plugins/cmp.nix | 1 + modules/tools/nixvim/plugins/comment.nix | 1 + modules/tools/nixvim/plugins/default.nix | 1 + modules/tools/nixvim/plugins/gitsigns.nix | 1 + modules/tools/nixvim/plugins/indent-blankline.nix | 1 + modules/tools/nixvim/plugins/lsp.nix | 1 + modules/tools/nixvim/plugins/lualine.nix | 1 + modules/tools/nixvim/plugins/luasnip.nix | 1 + modules/tools/nixvim/plugins/noice.nix | 1 + modules/tools/nixvim/plugins/notify.nix | 1 + modules/tools/nixvim/plugins/nvim-tree.nix | 1 + modules/tools/nixvim/plugins/treesitter.nix | 1 + modules/tools/nixvim/plugins/web-devicons.nix | 1 + modules/tools/nixvim/plugins/which-key.nix | 1 + 14 files changed, 14 insertions(+) (limited to 'modules/tools/nixvim/plugins') diff --git a/modules/tools/nixvim/plugins/cmp.nix b/modules/tools/nixvim/plugins/cmp.nix index 855a4d5..62803f6 100644 --- a/modules/tools/nixvim/plugins/cmp.nix +++ b/modules/tools/nixvim/plugins/cmp.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Cmp - Completion plugin (nvim-cmp) for auto-completion { config.programs.nixvim.plugins.cmp = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/comment.nix b/modules/tools/nixvim/plugins/comment.nix index 7032997..aa22577 100644 --- a/modules/tools/nixvim/plugins/comment.nix +++ b/modules/tools/nixvim/plugins/comment.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Comment - Comment toggling plugin (comment.nvim) { config.programs.nixvim.plugins.comment = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/default.nix b/modules/tools/nixvim/plugins/default.nix index 05f9802..7b5a487 100644 --- a/modules/tools/nixvim/plugins/default.nix +++ b/modules/tools/nixvim/plugins/default.nix @@ -1,5 +1,6 @@ { ... }: +# Plugins - Collection of nixvim plugin configurations { imports = [ ./cmp.nix diff --git a/modules/tools/nixvim/plugins/gitsigns.nix b/modules/tools/nixvim/plugins/gitsigns.nix index 3b49ceb..4770dba 100644 --- a/modules/tools/nixvim/plugins/gitsigns.nix +++ b/modules/tools/nixvim/plugins/gitsigns.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Gitsigns - Git status in the sign column (gitsigns.nvim) { config.programs.nixvim.plugins.gitsigns = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/indent-blankline.nix b/modules/tools/nixvim/plugins/indent-blankline.nix index 34334ba..eee2e1f 100644 --- a/modules/tools/nixvim/plugins/indent-blankline.nix +++ b/modules/tools/nixvim/plugins/indent-blankline.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Indent-blankline - Visual indentation guides (indent-blankline.nvim) { config.programs.nixvim.plugins.indent-blankline = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/lsp.nix b/modules/tools/nixvim/plugins/lsp.nix index da05068..07f4073 100644 --- a/modules/tools/nixvim/plugins/lsp.nix +++ b/modules/tools/nixvim/plugins/lsp.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# LSP - Language Server Protocol configuration (nvim-lspconfig) { config.programs.nixvim.plugins.lsp = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/lualine.nix b/modules/tools/nixvim/plugins/lualine.nix index 204bc44..c1d6fe1 100644 --- a/modules/tools/nixvim/plugins/lualine.nix +++ b/modules/tools/nixvim/plugins/lualine.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Lualine - Statusline configuration (lualine.nvim) { config.programs.nixvim.plugins.lualine = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/luasnip.nix b/modules/tools/nixvim/plugins/luasnip.nix index dfa0618..e1890ea 100644 --- a/modules/tools/nixvim/plugins/luasnip.nix +++ b/modules/tools/nixvim/plugins/luasnip.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Luasnip - Snippet engine for Neovim (Lua-based) { config.programs.nixvim.plugins.luasnip = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/noice.nix b/modules/tools/nixvim/plugins/noice.nix index 313df4b..1c04544 100644 --- a/modules/tools/nixvim/plugins/noice.nix +++ b/modules/tools/nixvim/plugins/noice.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Noice - Modern UI for Neovim (cmdline, popupmenu, messages) { config.programs.nixvim.plugins.noice = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/notify.nix b/modules/tools/nixvim/plugins/notify.nix index 7f77536..ca64ecb 100644 --- a/modules/tools/nixvim/plugins/notify.nix +++ b/modules/tools/nixvim/plugins/notify.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Notify - Notification plugin (nvim-notify) - currently disabled { config.programs.nixvim.plugins.notify = lib.mkIf config.tools.nixvim.enable { enable = false; diff --git a/modules/tools/nixvim/plugins/nvim-tree.nix b/modules/tools/nixvim/plugins/nvim-tree.nix index 19398a3..7f6bf70 100644 --- a/modules/tools/nixvim/plugins/nvim-tree.nix +++ b/modules/tools/nixvim/plugins/nvim-tree.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Nvim-tree - File explorer sidebar (nvim-tree.lua) { config.programs.nixvim.plugins.nvim-tree = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/treesitter.nix b/modules/tools/nixvim/plugins/treesitter.nix index d62d250..9421851 100644 --- a/modules/tools/nixvim/plugins/treesitter.nix +++ b/modules/tools/nixvim/plugins/treesitter.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Treesitter - Syntax highlighting and parsing (nvim-treesitter) { config.programs.nixvim.plugins.treesitter = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/web-devicons.nix b/modules/tools/nixvim/plugins/web-devicons.nix index 4d70fcb..d180fc5 100644 --- a/modules/tools/nixvim/plugins/web-devicons.nix +++ b/modules/tools/nixvim/plugins/web-devicons.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Web-devicons - File icons for various file types (nvim-web-devicons) { config.programs.nixvim.plugins.web-devicons = lib.mkIf config.tools.nixvim.enable { enable = true; diff --git a/modules/tools/nixvim/plugins/which-key.nix b/modules/tools/nixvim/plugins/which-key.nix index 8b78dcc..c157666 100644 --- a/modules/tools/nixvim/plugins/which-key.nix +++ b/modules/tools/nixvim/plugins/which-key.nix @@ -1,5 +1,6 @@ { config, lib, ... }: +# Which-key - Popup for keybindings (which-key.nvim) { config.programs.nixvim.plugins.which-key = lib.mkIf config.tools.nixvim.enable { enable = true; -- cgit v1.2.3