treewide: fix typos (nix-community#1217)

r6t · Mar 7, 2024 · 233feeb · 233feeb
1 parent e9564ac
commit 233feeb
Show file tree

Hide file tree

Showing 50 changed files with 123 additions and 96 deletions.
diff --git a/flake-modules/dev/default.nix b/flake-modules/dev/default.nix
@@ -16,6 +16,7 @@
             "plugins/lsp/language-servers/rust-analyzer-config.nix"
           ];
         };
+        typos.enable = true;
       };
     };
   };

diff --git a/flake-modules/dev/devshell.nix b/flake-modules/dev/devshell.nix
@@ -52,7 +52,7 @@
 
             doc_derivation=$(${nix} build .#docs --no-link --print-out-paths)
 
-            echo -e "\n=> Documentation succesfully built ('$doc_derivation')"
+            echo -e "\n=> Documentation successfully built ('$doc_derivation')"
 
             port=8000
             echo -e "\n=> Now open your browser and navigate to 'localhost:$port'\n"

diff --git a/flake-modules/templates.nix b/flake-modules/templates.nix
@@ -37,7 +37,7 @@
       in
         result;
 
-      templateFlakeOuputs = callFlake {
+      templateFlakeOutputs = callFlake {
         inputs = {
           inherit (inputs) flake-parts nixpkgs;
           nixvim = self;
@@ -47,7 +47,7 @@
         sourceInfo = {};
       };
 
-      templateChecks = templateFlakeOuputs.checks.${system};
+      templateChecks = templateFlakeOutputs.checks.${system};
     in
       lib.concatMapAttrs
       (

diff --git a/lib/vim-plugin.nix b/lib/vim-plugin.nix
@@ -140,7 +140,7 @@ with lib; {
           {
             inherit extraPackages;
             globals = mapAttrs' (n: nameValuePair (globalPrefix + n)) globals;
-            # does this evaluate package? it would not be desired to evaluate pacakge if we use another package.
+            # does this evaluate package? it would not be desired to evaluate package if we use another package.
             extraPlugins = extraPlugins ++ optional (defaultPackage != null) cfg.package;
           }
           (extraConfig cfg)

diff --git a/plugins/TEMPLATE.nix b/plugins/TEMPLATE.nix
@@ -12,7 +12,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
 
   maintainers = [lib.maintainers.MyName]; # TODO replace with your name
 
-  # Optionnally, explicitly declare some options. You don't have to.
+  # Optionally, explicitly declare some options. You don't have to.
   settingsOptions = {
     foo = helpers.defaultNullOpts.mkUnsignedInt 97 ''
       The best birth year.
@@ -23,7 +23,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
     '';
   };
 
-  # Optionnally, provide an example for the `settings` option.
+  # Optionally, provide an example for the `settings` option.
   settingsExample = {
     foo = 42;
     bar.__raw = "function() print('hello') end";

diff --git a/plugins/bufferlines/barbar.nix b/plugins/bufferlines/barbar.nix
@@ -43,8 +43,8 @@ with lib; let
     };
 
     separator = {
-      left = helpers.defaultNullOpts.mkStr "▎" "Left seperator";
-      right = helpers.defaultNullOpts.mkStr "" "Right seperator";
+      left = helpers.defaultNullOpts.mkStr "▎" "Left separator";
+      right = helpers.defaultNullOpts.mkStr "" "Right separator";
     };
   };
 
@@ -186,7 +186,7 @@ in {
         "asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP"
         ''
           New buffer letters are assigned in this order.
-          This order is optimal for the qwerty keyboard layout but might need adjustement for other layouts.
+          This order is optimal for the qwerty keyboard layout but might need adjustment for other layouts.
         '';
 
       sidebarFiletypes =
@@ -251,7 +251,7 @@ in {
               diagnostics =
                 /*
                 Because the keys of this lua table are not strings (but
-                `vim.diagnostic.severity.XXXX`), we have to manualy build a raw lua string here.
+                `vim.diagnostic.severity.XXXX`), we have to manually build a raw lua string here.
                 */
                 let
                   setIcons = filterAttrs (n: v: v != null) cfg.icons.diagnostics;

diff --git a/plugins/colorschemes/base16.nix b/plugins/colorschemes/base16.nix
@@ -55,7 +55,7 @@ in {
               );
           })
         ''
-          Optionaly, you can provide a table specifying your colors to the setup function.
+          Optionally, you can provide a table specifying your colors to the setup function.
 
           Example:
           ```nix

diff --git a/plugins/colorschemes/nord.nix b/plugins/colorschemes/nord.nix
@@ -32,7 +32,7 @@ helpers.vim-plugin.mkVimPlugin config {
     '';
 
     borders = helpers.defaultNullOpts.mkBool false ''
-      Enable the border between verticaly split windows visable.
+      Enable the border between vertically split windows.
     '';
 
     disable_background = helpers.defaultNullOpts.mkBool false ''

diff --git a/plugins/completion/cmp/sources/cmp-tabby.nix b/plugins/completion/cmp/sources/cmp-tabby.nix
@@ -13,7 +13,7 @@ in {
     helpers.neovim-plugin.extraOptionsOptions
     // {
       host = helpers.defaultNullOpts.mkStr "http://localhost:5000" ''
-        The adress of the tabby host server.
+        The address of the tabby host server.
       '';
 
       maxLines = helpers.defaultNullOpts.mkUnsignedInt 100 ''

diff --git a/plugins/completion/copilot-lua.nix b/plugins/completion/copilot-lua.nix
@@ -132,7 +132,7 @@ in {
           https://github.com/zbirenbaum/copilot.lua/blob/master/SettingsOpts.md.
           These options are specific to the copilot lsp and can be used to customize its behavior.
 
-          Ensure that the `name` field is not overriden as is is used for efficiency reasons in
+          Ensure that the `name` field is not overridden as is is used for efficiency reasons in
           numerous checks to verify copilot is actually running.
 
           See `:h vim.lsp.start_client` for list of options.

diff --git a/plugins/dap/dapHelpers.nix b/plugins/dap/dapHelpers.nix
@@ -102,7 +102,7 @@ with lib; rec {
       request = mkOption {
         type = types.enum ["attach" "launch"];
         description = ''
-          Indicates whether the debug adapter should launch a debugee or attach to one that is already running.
+          Indicates whether the debug adapter should launch a debuggee or attach to one that is already running.
         '';
       };
 

diff --git a/plugins/dap/default.nix b/plugins/dap/default.nix
@@ -30,7 +30,7 @@ in
         };
 
         configurations = helpers.mkNullOrOption (with types; attrsOf (listOf dapHelpers.configurationOption)) ''
-          Debugee configurations, see `:h dap-configuration` for more info.
+          Debuggee configurations, see `:h dap-configuration` for more info.
         '';
 
         signs = helpers.mkCompositeOption "Signs for dap." {
@@ -40,7 +40,7 @@ in
 
           dapLogPoint = mkSignOption "L" "Sign for log points.";
 
-          dapStopped = mkSignOption "→" "Sign to indicate where the debugee is stopped.";
+          dapStopped = mkSignOption "→" "Sign to indicate where the debuggee is stopped.";
 
           dapBreakpointRejected = mkSignOption "R" "Sign to indicate breakpoints rejected by the debug adapter.";
         };

diff --git a/plugins/filetrees/neo-tree.nix b/plugins/filetrees/neo-tree.nix
@@ -13,7 +13,7 @@ in {
     (
       mkRemovedOptionModule
       (basePluginPath ++ ["sourceSelector" "tabLabels"])
-      "Use `plugins.neo-tree.sourceSelector.sources` to achieve the same functionnality."
+      "Use `plugins.neo-tree.sourceSelector.sources` to achieve the same functionality."
     )
     (
       mkRemovedOptionModule

diff --git a/plugins/git/diffview.nix b/plugins/git/diffview.nix
@@ -328,7 +328,7 @@ in {
             '';
 
             s = mkNullStr ''
-              Look for differences that change the number of occurences of
+              Look for differences that change the number of occurrences of
               the specified pattern (extended regular expression) in a
               file.
             '';

diff --git a/plugins/languages/clangd-extensions.nix b/plugins/languages/clangd-extensions.nix
@@ -13,7 +13,7 @@ with lib; let
   borderOpt = helpers.defaultNullOpts.mkBorder "none" "clangd-extensions" "";
 in {
   # All of those warnings were introduced on 08/22/2023.
-  # TODO: Remove them in ~2 monts (Oct. 2023).
+  # TODO: Remove them in ~2 months (Oct. 2023).
   imports =
     [
       (

diff --git a/plugins/languages/lean.nix b/plugins/languages/lean.nix
@@ -182,7 +182,7 @@ in {
 
       stderr = {
         enable = helpers.defaultNullOpts.mkBool true ''
-          Redirect Lean's stderr messages somehwere (to a buffer by default).
+          Redirect Lean's stderr messages somewhere (to a buffer by default).
         '';
 
         height = helpers.defaultNullOpts.mkPositiveInt 5 "Height of the window.";

diff --git a/plugins/languages/markdown-preview.nix b/plugins/languages/markdown-preview.nix
@@ -119,7 +119,7 @@ with helpers.vim-plugin;
                   Scroll type:
                   - "middle": The cursor position is always shown at the middle of the preview page.
                   - "top": The vim top viewport is always shown at the top of the preview page.
-                  - "relative": The cursor position is always shown at the relative positon of the preview page.
+                  - "relative": The cursor position is always shown at the relative position of the preview page.
                 '';
 
               hide_yaml_meta = helpers.defaultNullOpts.mkBool true ''

diff --git a/plugins/languages/rustaceanvim.nix b/plugins/languages/rustaceanvim.nix
@@ -107,7 +107,7 @@ in {
             '';
 
           pipe = helpers.mkNullOrStr ''
-            Overide the pipe symbol in the shell command.
+            Override the pipe symbol in the shell command.
             Useful if using a shell that is not supported by this plugin.
           '';
         };

diff --git a/plugins/languages/sniprun.nix b/plugins/languages/sniprun.nix
@@ -33,7 +33,7 @@ in {
         mkList ''["Classic" "VirtualTextOk"]''
         ''
           You can combo different display modes as desired and with the 'Ok' or 'Err' suffix to filter
-          only sucessful runs (or errored-out runs respectively)
+          only successful runs (or errored-out runs respectively)
 
           Example:
           ```nix

diff --git a/plugins/languages/treesitter/treesitter-refactor.nix b/plugins/languages/treesitter/treesitter-refactor.nix
@@ -69,7 +69,7 @@ with lib; {
           description = ''
             go to the definition of the symbol under the cursor or use vim.lsp.buf.definition if
             the symbol can not be resolved. You can use your own fallback function if create a
-            mapping fo `lua require'nvim-treesitter.refactor.navigation(nil, fallback_function)<cr>`.
+            mapping for `lua require'nvim-treesitter.refactor.navigation(nil, fallback_function)<cr>`.
           '';
         };
         listDefinitions = mkOption {

diff --git a/plugins/languages/treesitter/treesitter.nix b/plugins/languages/treesitter/treesitter.nix
@@ -180,9 +180,9 @@ in {
           require('nvim-treesitter.configs').setup(${helpers.toLuaObject tsOptions})
         ''
         + (optionalString (cfg.languageRegister != {}) ''
-          __parserFiltypeMappings = ${helpers.toLuaObject cfg.languageRegister}
+          __parserFiletypeMappings = ${helpers.toLuaObject cfg.languageRegister}
 
-          for parser_name, ft in pairs(__parserFiltypeMappings) do
+          for parser_name, ft in pairs(__parserFiletypeMappings) do
             require('vim.treesitter.language').register(parser_name, ft)
           end
         '');

diff --git a/plugins/languages/treesitter/ts-context-commentstring.nix b/plugins/languages/treesitter/ts-context-commentstring.nix
@@ -20,7 +20,7 @@ with lib; {
         type = types.bool;
         default = true;
         description = ''
-          Whethter to skip backwards compatibility routines and speed up loading.
+          Whether to skip backwards compatibility routines and speed up loading.
         '';
         example = false;
       };

diff --git a/plugins/languages/typescript-tools.nix b/plugins/languages/typescript-tools.nix
@@ -126,7 +126,7 @@ in {
         "WARNING: Experimental feature also in VSCode, disabled by default because it might impact server performance.";
 
       disableMemberCodeLens = helpers.defaultNullOpts.mkBool true ''
-        By default code lenses are displayed on all referencable values. Display less by removing member references from lenses.
+        By default code lenses are displayed on all referenceable values. Display less by removing member references from lenses.
       '';
 
       jsxCloseTag = {

diff --git a/plugins/lsp/language-servers/nixd.nix b/plugins/lsp/language-servers/nixd.nix
@@ -38,7 +38,7 @@ in {
     options = {
       enable = helpers.defaultNullOpts.mkBool true ''
         Enable option completion task.
-        If you are writting a package, disable this
+        If you are writing a package, disable this
       '';
 
       target = {
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ @@
                 "plugins/lsp/language-servers/rust-analyzer-config.nix"
               ];
             };
+            typos.enable = true;
           };
         };
       };
@@ Expand Down @@