mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 08:35:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: fix grammar, spelling, and text for enable options

Browse source
This commit is contained in:
municorn 2023-10-09 07:58:51 -05:00 • committed by Gaétan Lepage
parent 7014569cbf
commit 3fd743fe80
23 changed files with 24 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -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. 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. This is done by making most of the options of the type `types.nullOr ....`, and not setting any option that is null.

2
plugins/colorschemes/gruvbox.nix
View file

@ -16,7 +16,7 @@ in {
package = helpers.mkPackageOption "gruvbox" pkgs.vimPlugins.gruvbox-nvim; package = helpers.mkPackageOption "gruvbox" pkgs.vimPlugins.gruvbox-nvim;
italics = mkEnableOption "italics"; italics = mkEnableOption "italics";
bold = mkEnableOption "bold"; bold = mkEnableOption "bold text";
underline = mkEnableOption "underlined text"; underline = mkEnableOption "underlined text";
undercurl = mkEnableOption "undercurled text"; undercurl = mkEnableOption "undercurled text";

2
plugins/completion/coq.nix
View file

@ -14,7 +14,7 @@ in {
package = helpers.mkPackageOption "coq-nvim" pkgs.vimPlugins.coq_nvim; package = helpers.mkPackageOption "coq-nvim" pkgs.vimPlugins.coq_nvim;
installArtifacts = mkEnableOption "Install coq-artifacts"; installArtifacts = mkEnableOption "and install coq-artifacts";
autoStart = mkOption { autoStart = mkOption {
type = with types; nullOr (oneOf [bool (enum ["shut-up"])]); type = with types; nullOr (oneOf [bool (enum ["shut-up"])]);

2
plugins/git/gitmessenger.nix
View file

@ -8,7 +8,7 @@ with lib; let
helpers = import ../helpers.nix args; helpers = import ../helpers.nix args;
in { in {
options.plugins.gitmessenger = { options.plugins.gitmessenger = {
enable = mkEnableOption "Enable the gitmessenger plugin"; enable = mkEnableOption "gitmessenger";
package = helpers.mkPackageOption "git-messenger" pkgs.vimPlugins.git-messenger-vim; package = helpers.mkPackageOption "git-messenger" pkgs.vimPlugins.git-messenger-vim;

2
plugins/git/gitsigns.nix
View file

@ -36,7 +36,7 @@ with lib; let
}; };
in { in {
options.plugins.gitsigns = { options.plugins.gitsigns = {
enable = mkEnableOption "Enable gitsigns plugin"; enable = mkEnableOption "gitsigns plugin";
package = helpers.mkPackageOption "gitsigns" pkgs.vimPlugins.gitsigns-nvim; package = helpers.mkPackageOption "gitsigns" pkgs.vimPlugins.gitsigns-nvim;
signs = { signs = {
add = signOptions { add = signOptions {

2
plugins/languages/clangd-extensions.nix
View file

@ -58,7 +58,7 @@ in {
options.plugins.clangd-extensions = options.plugins.clangd-extensions =
helpers.extraOptionsOptions helpers.extraOptionsOptions
// { // {
enable = mkEnableOption "clangd_extensions, plugin implementing clangd LSP extensions"; enable = mkEnableOption "clangd_extensions, plugins implementing clangd LSP extensions";
package = package =
helpers.mkPackageOption "clangd_extensions.nvim" pkgs.vimPlugins.clangd_extensions-nvim; helpers.mkPackageOption "clangd_extensions.nvim" pkgs.vimPlugins.clangd_extensions-nvim;

2
plugins/languages/treesitter/treesitter-refactor.nix
View file

@ -36,7 +36,7 @@ in {
}; };
highlightCurrentScope = { highlightCurrentScope = {
inherit disable; 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 = { smartRename = {
inherit disable; inherit disable;

2
plugins/lsp/fidget.nix
View file

@ -12,7 +12,7 @@ in {
plugins.fidget = plugins.fidget =
helpers.extraOptionsOptions helpers.extraOptionsOptions
// { // {
enable = mkEnableOption "Enable fidget."; enable = mkEnableOption "fidget";
package = helpers.mkPackageOption "fidget" pkgs.vimPlugins.fidget-nvim; package = helpers.mkPackageOption "fidget" pkgs.vimPlugins.fidget-nvim;

2
plugins/snippets/luasnip/default.nix
View file

@ -9,7 +9,7 @@ with lib; let
helpers = import ../../helpers.nix {inherit lib;}; helpers = import ../../helpers.nix {inherit lib;};
in { in {
options.plugins.luasnip = { options.plugins.luasnip = {
enable = mkEnableOption "Enable luasnip"; enable = mkEnableOption "luasnip";
package = helpers.mkPackageOption "luasnip" pkgs.vimPlugins.luasnip; package = helpers.mkPackageOption "luasnip" pkgs.vimPlugins.luasnip;

2
plugins/telescope/file-browser.nix
View file

@ -25,7 +25,7 @@ with lib; let
}; };
in { in {
options.plugins.telescope.extensions.file_browser = { 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; package = helpers.mkPackageOption "telescope file_browser" pkgs.vimPlugins.telescope-file-browser-nvim;

2
plugins/telescope/fzf-native.nix
View file

@ -9,7 +9,7 @@ with lib; let
helpers = import ../helpers.nix {inherit lib;}; helpers = import ../helpers.nix {inherit lib;};
in { in {
options.plugins.telescope.extensions.fzf-native = { 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; package = helpers.mkPackageOption "telescope extension fzf-native" pkgs.vimPlugins.telescope-fzf-native-nvim;

2
plugins/telescope/fzy-native.nix
View file

@ -8,7 +8,7 @@ with lib; let
cfg = config.plugins.telescope.extensions.fzy-native; cfg = config.plugins.telescope.extensions.fzy-native;
in { in {
options.plugins.telescope.extensions.fzy-native = { options.plugins.telescope.extensions.fzy-native = {
enable = mkEnableOption "Enable fzy-native"; enable = mkEnableOption "fzy-native";
overrideGenericSorter = mkOption { overrideGenericSorter = mkOption {
type = types.nullOr types.bool; type = types.nullOr types.bool;

2
plugins/telescope/media-files.nix
View file

@ -9,7 +9,7 @@ with lib; let
helpers = import ../helpers.nix {inherit lib;}; helpers = import ../helpers.nix {inherit lib;};
in { in {
options.plugins.telescope.extensions.media_files = { 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; package = helpers.mkPackageOption "telescope extension media_files" pkgs.vimPlugins.telescope-media-files-nvim;

2
plugins/utils/comment-nvim.nix
View file

@ -10,7 +10,7 @@ with lib; let
in { in {
options = { options = {
plugins.comment-nvim = { plugins.comment-nvim = {
enable = mkEnableOption "Enable comment-nvim"; enable = mkEnableOption "comment-nvim";
package = helpers.mkPackageOption "comment-nvim" pkgs.vimPlugins.comment-nvim; package = helpers.mkPackageOption "comment-nvim" pkgs.vimPlugins.comment-nvim;

2
plugins/utils/easyescape.nix
View file

@ -10,7 +10,7 @@ with lib; let
in { in {
options = { options = {
plugins.easyescape = { plugins.easyescape = {
enable = mkEnableOption "Enable easyescape"; enable = mkEnableOption "easyescape";
package = helpers.mkPackageOption "easyescape" pkgs.vimPlugins.vim-easyescape; package = helpers.mkPackageOption "easyescape" pkgs.vimPlugins.vim-easyescape;
}; };

2
plugins/utils/hardtime.nix
View file

@ -12,7 +12,7 @@ in {
plugins.hardtime = plugins.hardtime =
helpers.extraOptionsOptions helpers.extraOptionsOptions
// { // {
enable = mkEnableOption "Enable hardtime."; enable = mkEnableOption "hardtime";
package = helpers.mkPackageOption "hardtime" pkgs.vimPlugins.hardtime-nvim; package = helpers.mkPackageOption "hardtime" pkgs.vimPlugins.hardtime-nvim;

2
plugins/utils/presence-nvim.nix
View file

@ -12,7 +12,7 @@ in {
plugins.presence-nvim = plugins.presence-nvim =
helpers.extraOptionsOptions helpers.extraOptionsOptions
// { // {
enable = mkEnableOption "Enable presence-nvim."; enable = mkEnableOption "presence-nvim";
package = helpers.mkPackageOption "presence-nvim" pkgs.vimPlugins.presence-nvim; package = helpers.mkPackageOption "presence-nvim" pkgs.vimPlugins.presence-nvim;
# General options. # General options.

2
plugins/utils/tmux-navigator.nix
View file

@ -9,7 +9,7 @@ with lib; let
helpers = import ../helpers.nix {inherit lib;}; helpers = import ../helpers.nix {inherit lib;};
in { in {
options.plugins.tmux-navigator = { 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; package = helpers.mkPackageOption "tmux-navigator" pkgs.vimPlugins.tmux-navigator;

2
plugins/utils/todo-comments.nix
View file

@ -19,7 +19,7 @@ in {
plugins.todo-comments = plugins.todo-comments =
helpers.extraOptionsOptions helpers.extraOptionsOptions
// { // {
enable = mkEnableOption "Enable todo-comments."; enable = mkEnableOption "todo-comments";
package = package =
helpers.mkPackageOption helpers.mkPackageOption

2
plugins/utils/undotree.nix
View file

@ -10,7 +10,7 @@ with lib; let
in { in {
options = { options = {
plugins.undotree = { plugins.undotree = {
enable = mkEnableOption "Enable undotree"; enable = mkEnableOption "undotree";
package = helpers.mkPackageOption "undotree" pkgs.vimPlugins.undotree; package = helpers.mkPackageOption "undotree" pkgs.vimPlugins.undotree;

4
plugins/utils/vim-matchup.nix
View file

@ -8,12 +8,12 @@ with lib; let
helpers = import ../helpers.nix args; helpers = import ../helpers.nix args;
in { in {
options.plugins.vim-matchup = { options.plugins.vim-matchup = {
enable = mkEnableOption "Enable vim-matchup"; enable = mkEnableOption "vim-matchup";
package = helpers.mkPackageOption "vim-matchup" pkgs.vimPlugins.vim-matchup; package = helpers.mkPackageOption "vim-matchup" pkgs.vimPlugins.vim-matchup;
treesitterIntegration = { treesitterIntegration = {
enable = mkEnableOption "Enable treesitter integration"; enable = mkEnableOption "treesitter integration";
disable = disable =
helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]"
"Languages for each to disable this module"; "Languages for each to disable this module";

2
wrappers/hm.nix
View file

@ -20,7 +20,7 @@ in {
{ {
options = { options = {
enable = mkEnableOption "nixvim"; enable = mkEnableOption "nixvim";
defaultEditor = mkEnableOption "Set nixvim as the default editor"; defaultEditor = mkEnableOption "nixvim as the default editor";
}; };
} }
] ]

2
wrappers/nixos.nix
View file

@ -20,7 +20,7 @@ in {
{ {
options = { options = {
enable = mkEnableOption "nixvim"; enable = mkEnableOption "nixvim";
defaultEditor = mkEnableOption "Set nixvim as the default editor"; defaultEditor = mkEnableOption "nixvim as the default editor";
}; };
config.wrapRc = mkForce true; config.wrapRc = mkForce true;
} }