mirror of
				https://github.com/NotAShelf/nvf.git
				synced 2025-10-31 11:02:37 +00:00 
			
		
		
		
	docs: clarify plugin option documentation
This commit is contained in:
		
					parent
					
						
							
								f7e860d6e5
							
						
					
				
			
			
				commit
				
					
						6fff5303b0
					
				
			
		
					 31 changed files with 45 additions and 46 deletions
				
			
		|  | @ -10,7 +10,7 @@ with builtins; { | |||
|       enable = mkOption { | ||||
|         type = types.bool; | ||||
|         default = false; | ||||
|         description = "enable autopairs"; | ||||
|         description = "Enable autopairs"; | ||||
|       }; | ||||
| 
 | ||||
|       type = mkOption { | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.comments.comment-nvim = { | ||||
|     enable = mkEnableOption "comment-nvim"; | ||||
|     enable = mkEnableOption "Enable comment-nvim"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -8,7 +8,7 @@ with builtins; let | |||
|   cfg = config.vim.comments.kommentary; | ||||
| in { | ||||
|   options.vim.comments.kommentary = { | ||||
|     enable = mkEnableOption "kommentary"; | ||||
|     enable = mkEnableOption "Enable kommentary"; | ||||
|   }; | ||||
| 
 | ||||
|   config = mkIf cfg.enable { | ||||
|  |  | |||
|  | @ -10,7 +10,7 @@ with builtins; { | |||
|       enable = mkOption { | ||||
|         type = types.bool; | ||||
|         default = false; | ||||
|         description = "enable autocomplete"; | ||||
|         description = "Enable autocomplete via nvim-cmp"; | ||||
|       }; | ||||
| 
 | ||||
|       type = mkOption { | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.dashboard.alpha = { | ||||
|     enable = mkEnableOption "alpha"; | ||||
|     enable = mkEnableOption "Enable alpha.nvim"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -13,8 +13,7 @@ in { | |||
|     ]; | ||||
| 
 | ||||
|     vim.luaConfigRC.dashboard-nvim = nvim.dag.entryAnywhere '' | ||||
|       require("dashboard").setup{ | ||||
|       } | ||||
|       require("dashboard").setup{} | ||||
|     ''; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.dashboard.dashboard-nvim = { | ||||
|     enable = mkEnableOption "dashboard-nvim"; | ||||
|     enable = mkEnableOption "Enable dashboard.nvim"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,7 +6,7 @@ | |||
| with builtins; | ||||
| with lib; { | ||||
|   options.vim.dashboard.startify = { | ||||
|     enable = mkEnableOption "Enable startify"; | ||||
|     enable = mkEnableOption "Enable vim-startify"; | ||||
| 
 | ||||
|     bookmarks = mkOption { | ||||
|       default = []; | ||||
|  |  | |||
|  | @ -7,7 +7,7 @@ with lib; | |||
| with builtins; { | ||||
|   options.vim.lsp = { | ||||
|     lightbulb = { | ||||
|       enable = mkEnableOption "lightbulb for code actions. Requires emoji font"; | ||||
|       enable = mkEnableOption "Lightbulb for code actions. Requires an emoji font"; | ||||
|     }; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -9,7 +9,7 @@ with builtins; let | |||
|   cfg = config.vim.lsp; | ||||
| in { | ||||
|   options.vim.lsp = { | ||||
|     enable = mkEnableOption "neovim lsp support"; | ||||
|     enable = mkEnableOption "Enable neovim lsp support. Requires language specific LSPs to be anabled to take effect"; | ||||
|     formatOnSave = mkEnableOption "Format on save"; | ||||
|     nix = { | ||||
|       enable = mkEnableOption "Nix LSP"; | ||||
|  | @ -45,7 +45,7 @@ in { | |||
|             }, | ||||
|           }, | ||||
|         ''; | ||||
|         description = "options to pass to rust analyzer"; | ||||
|         description = "Options to pass to rust analyzer"; | ||||
|       }; | ||||
|     }; | ||||
|     python = mkEnableOption "Python LSP"; | ||||
|  |  | |||
|  | @ -7,7 +7,7 @@ with lib; | |||
| with builtins; { | ||||
|   options.vim.lsp = { | ||||
|     nvimCodeActionMenu = { | ||||
|       enable = mkEnableOption "nvim code action menu"; | ||||
|       enable = mkEnableOption "Enable nvim code action menu"; | ||||
|     }; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -7,7 +7,7 @@ with lib; | |||
| with builtins; { | ||||
|   options.vim.lsp = { | ||||
|     trouble = { | ||||
|       enable = mkEnableOption "trouble diagnostics viewer"; | ||||
|       enable = mkEnableOption "Enable trouble diagnostics viewer"; | ||||
|     }; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -8,7 +8,7 @@ with builtins; let | |||
|   cfg = config.vim.markdown; | ||||
| in { | ||||
|   options.vim.markdown = { | ||||
|     enable = mkEnableOption "markdown tools and plugins"; | ||||
|     enable = mkEnableOption "Enable markdown tools and plugins"; | ||||
|   }; | ||||
| 
 | ||||
|   config = mkIf (cfg.enable) { | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.minimap.codewindow = { | ||||
|     enable = mkEnableOption "Enable minimap-vim plugin"; | ||||
|     enable = mkEnableOption "Enable codewindow plugin for minimap view"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.minimap.minimap-vim = { | ||||
|     enable = mkEnableOption "Enable minimap-vim plugin"; | ||||
|     enable = mkEnableOption "Enable minimap-vim plugin for minimap view"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,7 +6,7 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.notes.orgmode = { | ||||
|     enable = mkEnableOption "Neovim plugin for Emac Orgmode. Get the best of both worlds."; | ||||
|     enable = mkEnableOption "Enable nvim-orgmode: Neovim plugin for Emac Orgmode. Get the best of both worlds"; | ||||
|     orgAgendaFiles = mkOption { | ||||
|       type = types.str; | ||||
|       default = "{'~/Dropbox/org/*', '~/my-orgs/**/*'}"; | ||||
|  |  | |||
|  | @ -6,7 +6,7 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.notes.todo-comments = { | ||||
|     enable = mkEnableOption "todo-comments"; | ||||
|     enable = mkEnableOption "Enable todo-comments"; | ||||
| 
 | ||||
|     patterns = { | ||||
|       highlight = mkOption { | ||||
|  |  | |||
|  | @ -6,7 +6,7 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.presence.presence-nvim = { | ||||
|     enable = mkEnableOption "Enable presence.nvim plugin"; | ||||
|     enable = mkEnableOption "Enable presence.nvim plugin for discord rich presence"; | ||||
| 
 | ||||
|     image_text = mkOption { | ||||
|       type = types.str; | ||||
|  |  | |||
|  | @ -10,7 +10,7 @@ in { | |||
|   options.vim.statusline.lualine = { | ||||
|     enable = mkOption { | ||||
|       type = types.bool; | ||||
|       description = "Enable lualine"; | ||||
|       description = "Enable lualine statusline"; | ||||
|       default = true; | ||||
|     }; | ||||
| 
 | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.tabline.nvimBufferline = { | ||||
|     enable = mkEnableOption "nvim-bufferline-lua"; | ||||
|     enable = mkEnableOption "Enable nvim-bufferline-lua as a bufferline"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -12,7 +12,7 @@ in { | |||
|   options.vim.theme = { | ||||
|     enable = mkOption { | ||||
|       type = types.bool; | ||||
|       description = "Enable Theme"; | ||||
|       description = "Enable theming"; | ||||
|     }; | ||||
| 
 | ||||
|     name = mkOption { | ||||
|  |  | |||
|  | @ -6,7 +6,7 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.tidal = { | ||||
|     enable = mkEnableOption "tidal tools and plugins"; | ||||
|     enable = mkEnableOption "Enable tidalcycles tools and plugins"; | ||||
| 
 | ||||
|     flash = mkOption { | ||||
|       description = ''When sending a paragraph or a single line, vim-tidal will "flash" the selection for some milliseconds''; | ||||
|  |  | |||
|  | @ -10,19 +10,19 @@ with builtins; { | |||
|     enable = mkOption { | ||||
|       default = false; | ||||
|       type = types.bool; | ||||
|       description = "enable tree-sitter [nvim-treesitter]"; | ||||
|       description = "Enable tree-sitter [nvim-treesitter]"; | ||||
|     }; | ||||
| 
 | ||||
|     fold = mkOption { | ||||
|       default = false; | ||||
|       type = types.bool; | ||||
|       description = "enable fold with tree-sitter"; | ||||
|       description = "Enable fold with tree-sitter"; | ||||
|     }; | ||||
| 
 | ||||
|     autotagHtml = mkOption { | ||||
|       default = false; | ||||
|       type = types.bool; | ||||
|       description = "enable autoclose and rename html tag [nvim-ts-autotag]"; | ||||
|       description = "Enable autoclose and rename html tag [nvim-ts-autotag]"; | ||||
|     }; | ||||
| 
 | ||||
|     grammars = mkOption { | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.ui.noice = { | ||||
|     enable = mkEnableOption "noice-nvim"; | ||||
|     enable = mkEnableOption "Enable noice-nvim UI modifications"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.binds.cheatsheet = { | ||||
|     enable = mkEnableOption "Searchable cheatsheet for nvim using telescope"; | ||||
|     enable = mkEnableOption "Enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.binds.whichKey = { | ||||
|     enable = mkEnableOption "which-key menu"; | ||||
|     enable = mkEnableOption "Enable which-key keybind menu"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.utility.colorizer = { | ||||
|     enable = mkEnableOption "ccc color picker for neovim"; | ||||
|     enable = mkEnableOption "Enable ccc color picker for neovim"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.utility.icon-picker = { | ||||
|     enable = mkEnableOption "Nerdfonts icon picker for nvim"; | ||||
|     enable = mkEnableOption "Enable nerdfonts icon picker for nvim"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.telescope = { | ||||
|     enable = mkEnableOption "enable telescope"; | ||||
|     enable = mkEnableOption "Enable multi-purpose telescope utility"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -6,6 +6,6 @@ | |||
| with lib; | ||||
| with builtins; { | ||||
|   options.vim.utility.venn-nvim = { | ||||
|     enable = mkEnableOption "draw ASCII diagrams in Neovim"; | ||||
|     enable = mkEnableOption "Enable venn.nvim: draw ASCII diagrams in Neovim"; | ||||
|   }; | ||||
| } | ||||
|  |  | |||
|  | @ -8,56 +8,56 @@ with builtins; { | |||
|   options.vim.visuals = { | ||||
|     enable = mkOption { | ||||
|       type = types.bool; | ||||
|       description = "visual enhancements"; | ||||
|       description = "Enable visual enhancements"; | ||||
|       default = false; | ||||
|     }; | ||||
| 
 | ||||
|     nvimWebDevicons.enable = mkOption { | ||||
|       type = types.bool; | ||||
|       description = "enable dev icons. required for certain plugins [nvim-web-devicons]"; | ||||
|       description = "Enable dev icons. required for certain plugins [nvim-web-devicons]"; | ||||
|       default = false; | ||||
|     }; | ||||
| 
 | ||||
|     lspkind.enable = mkOption { | ||||
|       type = types.bool; | ||||
|       description = "enable vscode-like pictograms for lsp [lspkind]"; | ||||
|       description = "Enable vscode-like pictograms for lsp [lspkind]"; | ||||
|       default = false; | ||||
|     }; | ||||
| 
 | ||||
|     scrollBar.enable = mkOption { | ||||
|       type = types.bool; | ||||
|       description = "enable scrollbar [scrollbar.nvim]"; | ||||
|       description = "Enable scrollbar [scrollbar.nvim]"; | ||||
|       default = false; | ||||
|     }; | ||||
| 
 | ||||
|     smoothScroll.enable = mkOption { | ||||
|       type = types.bool; | ||||
|       description = "enable smooth scrolling [cinnamon-nvim]"; | ||||
|       description = "Enable smooth scrolling [cinnamon-nvim]"; | ||||
|       default = false; | ||||
|     }; | ||||
| 
 | ||||
|     cellularAutomaton.enable = mkOption { | ||||
|       type = types.bool; | ||||
|       description = "enable cellular automaton [cellular-automaton]"; | ||||
|       description = "Enable cellular automaton [cellular-automaton]"; | ||||
|       default = false; | ||||
|     }; | ||||
| 
 | ||||
|     fidget-nvim = { | ||||
|       enable = mkOption { | ||||
|         type = types.bool; | ||||
|         description = "enable nvim LSP UI element [fidget-nvim]"; | ||||
|         description = "Enable nvim LSP UI element [fidget-nvim]"; | ||||
|         default = false; | ||||
|       }; | ||||
|       align = { | ||||
|         bottom = mkOption { | ||||
|           type = types.bool; | ||||
|           description = "align to bottom"; | ||||
|           description = "Align to bottom"; | ||||
|           default = true; | ||||
|         }; | ||||
| 
 | ||||
|         right = mkOption { | ||||
|           type = types.bool; | ||||
|           description = "align to right"; | ||||
|           description = "Align to right"; | ||||
|           default = true; | ||||
|         }; | ||||
|       }; | ||||
|  | @ -66,20 +66,20 @@ with builtins; { | |||
|     cursorWordline = { | ||||
|       enable = mkOption { | ||||
|         type = types.bool; | ||||
|         description = "enable word and delayed line highlight [nvim-cursorline]"; | ||||
|         description = "Enable word and delayed line highlight [nvim-cursorline]"; | ||||
|         default = false; | ||||
|       }; | ||||
| 
 | ||||
|       lineTimeout = mkOption { | ||||
|         type = types.int; | ||||
|         description = "time in milliseconds for cursorline to appear"; | ||||
|         description = "Time in milliseconds for cursorline to appear"; | ||||
|       }; | ||||
|     }; | ||||
| 
 | ||||
|     indentBlankline = { | ||||
|       enable = mkOption { | ||||
|         type = types.bool; | ||||
|         description = "enable indentation guides [indent-blankline]"; | ||||
|         description = "Enable indentation guides [indent-blankline]"; | ||||
|         default = false; | ||||
|       }; | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 NotAShelf
				NotAShelf