From 3fd743fe80e4fad96d6661f068e88d1c645ebf75 Mon Sep 17 00:00:00 2001 From: municorn Date: Mon, 9 Oct 2023 07:58:51 -0500 Subject: [PATCH] docs: fix grammar, spelling, and text for `enable` options --- CONTRIBUTING.md | 2 +- plugins/colorschemes/gruvbox.nix | 2 +- plugins/completion/coq.nix | 2 +- plugins/git/gitmessenger.nix | 2 +- plugins/git/gitsigns.nix | 2 +- plugins/languages/clangd-extensions.nix | 2 +- plugins/languages/treesitter/treesitter-refactor.nix | 2 +- plugins/lsp/fidget.nix | 2 +- plugins/snippets/luasnip/default.nix | 2 +- plugins/telescope/file-browser.nix | 2 +- plugins/telescope/fzf-native.nix | 2 +- plugins/telescope/fzy-native.nix | 2 +- plugins/telescope/media-files.nix | 2 +- plugins/utils/comment-nvim.nix | 2 +- plugins/utils/easyescape.nix | 2 +- plugins/utils/hardtime.nix | 2 +- plugins/utils/presence-nvim.nix | 2 +- plugins/utils/tmux-navigator.nix | 2 +- plugins/utils/todo-comments.nix | 2 +- plugins/utils/undotree.nix | 2 +- plugins/utils/vim-matchup.nix | 4 ++-- wrappers/hm.nix | 2 +- wrappers/nixos.nix | 2 +- 23 files changed, 24 insertions(+), 24 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 194edd3490..635c97007b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ This can then be passed to `pkgs.wrapNeovimUnstable` to generate a derivation th All the options that nixvim expose end up in those three places. This is done in the `modules/output.nix` file. -The guiding principle of nixvim is too only add to the `init.lua` what the user added to the configuration. This means that we must trim out all the options that were not set. +The guiding principle of nixvim is to only add to the `init.lua` what the user added to the configuration. This means that we must trim out all the options that were not set. This is done by making most of the options of the type `types.nullOr ....`, and not setting any option that is null. diff --git a/plugins/colorschemes/gruvbox.nix b/plugins/colorschemes/gruvbox.nix index 4ca6aeae8c..f1b4e30e90 100644 --- a/plugins/colorschemes/gruvbox.nix +++ b/plugins/colorschemes/gruvbox.nix @@ -16,7 +16,7 @@ in { package = helpers.mkPackageOption "gruvbox" pkgs.vimPlugins.gruvbox-nvim; italics = mkEnableOption "italics"; - bold = mkEnableOption "bold"; + bold = mkEnableOption "bold text"; underline = mkEnableOption "underlined text"; undercurl = mkEnableOption "undercurled text"; diff --git a/plugins/completion/coq.nix b/plugins/completion/coq.nix index 45b7a269da..225746da60 100644 --- a/plugins/completion/coq.nix +++ b/plugins/completion/coq.nix @@ -14,7 +14,7 @@ in { package = helpers.mkPackageOption "coq-nvim" pkgs.vimPlugins.coq_nvim; - installArtifacts = mkEnableOption "Install coq-artifacts"; + installArtifacts = mkEnableOption "and install coq-artifacts"; autoStart = mkOption { type = with types; nullOr (oneOf [bool (enum ["shut-up"])]); diff --git a/plugins/git/gitmessenger.nix b/plugins/git/gitmessenger.nix index d254b988f1..77f1590d71 100644 --- a/plugins/git/gitmessenger.nix +++ b/plugins/git/gitmessenger.nix @@ -8,7 +8,7 @@ with lib; let helpers = import ../helpers.nix args; in { options.plugins.gitmessenger = { - enable = mkEnableOption "Enable the gitmessenger plugin"; + enable = mkEnableOption "gitmessenger"; package = helpers.mkPackageOption "git-messenger" pkgs.vimPlugins.git-messenger-vim; diff --git a/plugins/git/gitsigns.nix b/plugins/git/gitsigns.nix index fa964d1528..cc4e0ce423 100644 --- a/plugins/git/gitsigns.nix +++ b/plugins/git/gitsigns.nix @@ -36,7 +36,7 @@ with lib; let }; in { options.plugins.gitsigns = { - enable = mkEnableOption "Enable gitsigns plugin"; + enable = mkEnableOption "gitsigns plugin"; package = helpers.mkPackageOption "gitsigns" pkgs.vimPlugins.gitsigns-nvim; signs = { add = signOptions { diff --git a/plugins/languages/clangd-extensions.nix b/plugins/languages/clangd-extensions.nix index fd7d0f8a29..821950bf4d 100644 --- a/plugins/languages/clangd-extensions.nix +++ b/plugins/languages/clangd-extensions.nix @@ -58,7 +58,7 @@ in { options.plugins.clangd-extensions = helpers.extraOptionsOptions // { - enable = mkEnableOption "clangd_extensions, plugin implementing clangd LSP extensions"; + enable = mkEnableOption "clangd_extensions, plugins implementing clangd LSP extensions"; package = helpers.mkPackageOption "clangd_extensions.nvim" pkgs.vimPlugins.clangd_extensions-nvim; diff --git a/plugins/languages/treesitter/treesitter-refactor.nix b/plugins/languages/treesitter/treesitter-refactor.nix index 1b4978b708..331ed2bf84 100644 --- a/plugins/languages/treesitter/treesitter-refactor.nix +++ b/plugins/languages/treesitter/treesitter-refactor.nix @@ -36,7 +36,7 @@ in { }; highlightCurrentScope = { inherit disable; - enable = mkEnableOption "highlights the block from the current scope where the cursor is."; + enable = mkEnableOption "highlighting the block from the current scope where the cursor is"; }; smartRename = { inherit disable; diff --git a/plugins/lsp/fidget.nix b/plugins/lsp/fidget.nix index 511510b2a2..2286015e08 100644 --- a/plugins/lsp/fidget.nix +++ b/plugins/lsp/fidget.nix @@ -12,7 +12,7 @@ in { plugins.fidget = helpers.extraOptionsOptions // { - enable = mkEnableOption "Enable fidget."; + enable = mkEnableOption "fidget"; package = helpers.mkPackageOption "fidget" pkgs.vimPlugins.fidget-nvim; diff --git a/plugins/snippets/luasnip/default.nix b/plugins/snippets/luasnip/default.nix index 059277db50..0c5bdd2212 100644 --- a/plugins/snippets/luasnip/default.nix +++ b/plugins/snippets/luasnip/default.nix @@ -9,7 +9,7 @@ with lib; let helpers = import ../../helpers.nix {inherit lib;}; in { options.plugins.luasnip = { - enable = mkEnableOption "Enable luasnip"; + enable = mkEnableOption "luasnip"; package = helpers.mkPackageOption "luasnip" pkgs.vimPlugins.luasnip; diff --git a/plugins/telescope/file-browser.nix b/plugins/telescope/file-browser.nix index a3b3fae0d6..e85cfc173b 100644 --- a/plugins/telescope/file-browser.nix +++ b/plugins/telescope/file-browser.nix @@ -25,7 +25,7 @@ with lib; let }; in { options.plugins.telescope.extensions.file_browser = { - enable = mkEnableOption "File browser extension for telescope"; + enable = mkEnableOption "file browser extension for telescope"; package = helpers.mkPackageOption "telescope file_browser" pkgs.vimPlugins.telescope-file-browser-nvim; diff --git a/plugins/telescope/fzf-native.nix b/plugins/telescope/fzf-native.nix index 78a2476e39..32717d538e 100644 --- a/plugins/telescope/fzf-native.nix +++ b/plugins/telescope/fzf-native.nix @@ -9,7 +9,7 @@ with lib; let helpers = import ../helpers.nix {inherit lib;}; in { options.plugins.telescope.extensions.fzf-native = { - enable = mkEnableOption "Enable fzf-native"; + enable = mkEnableOption "fzf-native"; package = helpers.mkPackageOption "telescope extension fzf-native" pkgs.vimPlugins.telescope-fzf-native-nvim; diff --git a/plugins/telescope/fzy-native.nix b/plugins/telescope/fzy-native.nix index 4235ad79c4..101c8dbd1a 100644 --- a/plugins/telescope/fzy-native.nix +++ b/plugins/telescope/fzy-native.nix @@ -8,7 +8,7 @@ with lib; let cfg = config.plugins.telescope.extensions.fzy-native; in { options.plugins.telescope.extensions.fzy-native = { - enable = mkEnableOption "Enable fzy-native"; + enable = mkEnableOption "fzy-native"; overrideGenericSorter = mkOption { type = types.nullOr types.bool; diff --git a/plugins/telescope/media-files.nix b/plugins/telescope/media-files.nix index 77b16963f2..1a565f0f96 100644 --- a/plugins/telescope/media-files.nix +++ b/plugins/telescope/media-files.nix @@ -9,7 +9,7 @@ with lib; let helpers = import ../helpers.nix {inherit lib;}; in { options.plugins.telescope.extensions.media_files = { - enable = mkEnableOption "Enable media_files extension for telescope"; + enable = mkEnableOption "media_files extension for telescope"; package = helpers.mkPackageOption "telescope extension media_files" pkgs.vimPlugins.telescope-media-files-nvim; diff --git a/plugins/utils/comment-nvim.nix b/plugins/utils/comment-nvim.nix index 5799da9749..0436022030 100644 --- a/plugins/utils/comment-nvim.nix +++ b/plugins/utils/comment-nvim.nix @@ -10,7 +10,7 @@ with lib; let in { options = { plugins.comment-nvim = { - enable = mkEnableOption "Enable comment-nvim"; + enable = mkEnableOption "comment-nvim"; package = helpers.mkPackageOption "comment-nvim" pkgs.vimPlugins.comment-nvim; diff --git a/plugins/utils/easyescape.nix b/plugins/utils/easyescape.nix index 7a8a6b0d59..dcb3bac86b 100644 --- a/plugins/utils/easyescape.nix +++ b/plugins/utils/easyescape.nix @@ -10,7 +10,7 @@ with lib; let in { options = { plugins.easyescape = { - enable = mkEnableOption "Enable easyescape"; + enable = mkEnableOption "easyescape"; package = helpers.mkPackageOption "easyescape" pkgs.vimPlugins.vim-easyescape; }; diff --git a/plugins/utils/hardtime.nix b/plugins/utils/hardtime.nix index 527bb9e6cb..8adc59f9e6 100644 --- a/plugins/utils/hardtime.nix +++ b/plugins/utils/hardtime.nix @@ -12,7 +12,7 @@ in { plugins.hardtime = helpers.extraOptionsOptions // { - enable = mkEnableOption "Enable hardtime."; + enable = mkEnableOption "hardtime"; package = helpers.mkPackageOption "hardtime" pkgs.vimPlugins.hardtime-nvim; diff --git a/plugins/utils/presence-nvim.nix b/plugins/utils/presence-nvim.nix index 216855e490..7b9e82b939 100644 --- a/plugins/utils/presence-nvim.nix +++ b/plugins/utils/presence-nvim.nix @@ -12,7 +12,7 @@ in { plugins.presence-nvim = helpers.extraOptionsOptions // { - enable = mkEnableOption "Enable presence-nvim."; + enable = mkEnableOption "presence-nvim"; package = helpers.mkPackageOption "presence-nvim" pkgs.vimPlugins.presence-nvim; # General options. diff --git a/plugins/utils/tmux-navigator.nix b/plugins/utils/tmux-navigator.nix index c4539cb9c1..e811680554 100644 --- a/plugins/utils/tmux-navigator.nix +++ b/plugins/utils/tmux-navigator.nix @@ -9,7 +9,7 @@ with lib; let helpers = import ../helpers.nix {inherit lib;}; in { options.plugins.tmux-navigator = { - enable = mkEnableOption "Enable Tmux-Navigator (see https://github.com/christoomey/vim-tmux-navigator for tmux installation instruction)"; + enable = mkEnableOption "Tmux-Navigator (see https://github.com/christoomey/vim-tmux-navigator for tmux installation instruction)"; package = helpers.mkPackageOption "tmux-navigator" pkgs.vimPlugins.tmux-navigator; diff --git a/plugins/utils/todo-comments.nix b/plugins/utils/todo-comments.nix index eb06e2e8f4..5cb9b0e1b6 100644 --- a/plugins/utils/todo-comments.nix +++ b/plugins/utils/todo-comments.nix @@ -19,7 +19,7 @@ in { plugins.todo-comments = helpers.extraOptionsOptions // { - enable = mkEnableOption "Enable todo-comments."; + enable = mkEnableOption "todo-comments"; package = helpers.mkPackageOption diff --git a/plugins/utils/undotree.nix b/plugins/utils/undotree.nix index eac38bd6f0..230716694a 100644 --- a/plugins/utils/undotree.nix +++ b/plugins/utils/undotree.nix @@ -10,7 +10,7 @@ with lib; let in { options = { plugins.undotree = { - enable = mkEnableOption "Enable undotree"; + enable = mkEnableOption "undotree"; package = helpers.mkPackageOption "undotree" pkgs.vimPlugins.undotree; diff --git a/plugins/utils/vim-matchup.nix b/plugins/utils/vim-matchup.nix index 275dfc62b7..1951a2672a 100644 --- a/plugins/utils/vim-matchup.nix +++ b/plugins/utils/vim-matchup.nix @@ -8,12 +8,12 @@ with lib; let helpers = import ../helpers.nix args; in { options.plugins.vim-matchup = { - enable = mkEnableOption "Enable vim-matchup"; + enable = mkEnableOption "vim-matchup"; package = helpers.mkPackageOption "vim-matchup" pkgs.vimPlugins.vim-matchup; treesitterIntegration = { - enable = mkEnableOption "Enable treesitter integration"; + enable = mkEnableOption "treesitter integration"; disable = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" "Languages for each to disable this module"; diff --git a/wrappers/hm.nix b/wrappers/hm.nix index a10abdc9d5..6fe79201e4 100644 --- a/wrappers/hm.nix +++ b/wrappers/hm.nix @@ -20,7 +20,7 @@ in { { options = { enable = mkEnableOption "nixvim"; - defaultEditor = mkEnableOption "Set nixvim as the default editor"; + defaultEditor = mkEnableOption "nixvim as the default editor"; }; } ] diff --git a/wrappers/nixos.nix b/wrappers/nixos.nix index ec924f032b..c8ee38656f 100644 --- a/wrappers/nixos.nix +++ b/wrappers/nixos.nix @@ -20,7 +20,7 @@ in { { options = { enable = mkEnableOption "nixvim"; - defaultEditor = mkEnableOption "Set nixvim as the default editor"; + defaultEditor = mkEnableOption "nixvim as the default editor"; }; config.wrapRc = mkForce true; }