From 233feeb8d244de8af44affbad61b3fe2a94323f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Reynier?= <88983487+loicreynier@users.noreply.github.com> Date: Thu, 7 Mar 2024 19:44:13 +0100 Subject: [PATCH] treewide: fix typos (#1217) --- flake-modules/dev/default.nix | 1 + flake-modules/dev/devshell.nix | 2 +- flake-modules/templates.nix | 4 +-- lib/vim-plugin.nix | 2 +- plugins/TEMPLATE.nix | 4 +-- plugins/bufferlines/barbar.nix | 8 ++--- plugins/colorschemes/base16.nix | 2 +- plugins/colorschemes/nord.nix | 2 +- plugins/completion/cmp/sources/cmp-tabby.nix | 2 +- plugins/completion/copilot-lua.nix | 2 +- plugins/dap/dapHelpers.nix | 2 +- plugins/dap/default.nix | 4 +-- plugins/filetrees/neo-tree.nix | 2 +- plugins/git/diffview.nix | 2 +- plugins/languages/clangd-extensions.nix | 2 +- plugins/languages/lean.nix | 2 +- plugins/languages/markdown-preview.nix | 2 +- plugins/languages/rustaceanvim.nix | 2 +- plugins/languages/sniprun.nix | 2 +- .../treesitter/treesitter-refactor.nix | 2 +- plugins/languages/treesitter/treesitter.nix | 4 +-- .../treesitter/ts-context-commentstring.nix | 2 +- plugins/languages/typescript-tools.nix | 2 +- plugins/lsp/language-servers/nixd.nix | 2 +- plugins/lsp/language-servers/pylsp.nix | 32 ++++++++--------- plugins/lsp/lspsaga.nix | 4 +-- plugins/telescope/default.nix | 2 +- plugins/telescope/file-browser.nix | 2 +- plugins/utils/commentary.nix | 2 +- plugins/utils/coverage.nix | 2 +- plugins/utils/flash.nix | 4 +-- plugins/utils/illuminate.nix | 6 ++-- plugins/utils/marks.nix | 2 +- plugins/utils/mkdnflow.nix | 6 ++-- plugins/utils/molten.nix | 2 +- plugins/utils/neogen.nix | 35 ++++++++++++------- plugins/utils/nvim-bqf.nix | 2 +- plugins/utils/nvim-osc52.nix | 2 +- plugins/utils/oil.nix | 2 +- plugins/utils/specs.nix | 4 +-- plugins/utils/spider.nix | 2 +- plugins/utils/startup.nix | 2 +- plugins/utils/vim-matchup.nix | 17 ++++++--- plugins/utils/which-key.nix | 2 +- plugins/utils/yanky.nix | 6 ++-- tests/fetch-tests.nix | 2 +- tests/test-sources/plugins/utils/neocord.nix | 6 ++-- tests/test-sources/plugins/utils/neogen.nix | 2 +- .../plugins/utils/tmux-navigator.nix | 2 +- typos.toml | 8 +++++ 50 files changed, 123 insertions(+), 96 deletions(-) create mode 100644 typos.toml diff --git a/flake-modules/dev/default.nix b/flake-modules/dev/default.nix index dc6c6b2a..66afdba7 100644 --- 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 index 56b25acb..1f133167 100644 --- 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 index bb23b69a..1756585d 100644 --- 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 index db9d70ac..df5e59d3 100644 --- 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 index a7dc05ed..a87aa0d9 100644 --- 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 index 20b9b10b..f22d6449 100644 --- 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 index 6cf2ac87..736ee86e 100644 --- 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 index 2cd48b7e..cafa52cc 100644 --- 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 index f937ba35..ecfc4b1f 100644 --- 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 index 31590f79..14d116cb 100644 --- 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 index ef724773..b6be531d 100644 --- 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 index 60469c39..53fc18b1 100644 --- 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 index e20191af..69e496fd 100644 --- 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 index 93ec8d77..d5d261d5 100644 --- 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 index 3bc7205b..503db134 100644 --- 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 index fa0222e7..4ae75136 100644 --- 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 index 6b6b5851..018f4443 100644 --- 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 index e0a4f081..df235f9f 100644 --- 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 index bd265165..f0f7a42f 100644 --- 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 index b39862de..61470cec 100644 --- 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)`. + mapping for `lua require'nvim-treesitter.refactor.navigation(nil, fallback_function)`. ''; }; listDefinitions = mkOption { diff --git a/plugins/languages/treesitter/treesitter.nix b/plugins/languages/treesitter/treesitter.nix index 1f0fb2d8..3cf3365b 100644 --- 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 index 19b2cf71..8efbd321 100644 --- 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 index 671fb4a5..8aa58fb5 100644 --- 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 index 95e2c1ec..36a2909a 100644 --- 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 = { diff --git a/plugins/lsp/language-servers/pylsp.nix b/plugins/lsp/language-servers/pylsp.nix index a5d44516..b3cdffce 100644 --- a/plugins/lsp/language-servers/pylsp.nix +++ b/plugins/lsp/language-servers/pylsp.nix @@ -26,7 +26,7 @@ in { autopep8 = { enabled = helpers.defaultNullOpts.mkBool true '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin (autopep8). + Setting this explicitly to `true` will install the dependency for this plugin (autopep8). ''; }; @@ -37,7 +37,7 @@ in { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin (flake8). + Setting this explicitly to `true` will install the dependency for this plugin (flake8). ''; exclude = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" '' @@ -177,7 +177,7 @@ in { mccabe = { enabled = helpers.defaultNullOpts.mkBool true '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin (mccabe). + Setting this explicitly to `true` will install the dependency for this plugin (mccabe). ''; threshold = helpers.defaultNullOpts.mkInt 15 '' @@ -196,7 +196,7 @@ in { pycodestyle = { enabled = helpers.defaultNullOpts.mkBool true '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin + Setting this explicitly to `true` will install the dependency for this plugin (pycodestyle). ''; @@ -232,7 +232,7 @@ in { pydocstyle = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin + Setting this explicitly to `true` will install the dependency for this plugin (pydocstyle). ''; @@ -276,14 +276,14 @@ in { pyflakes = { enabled = helpers.defaultNullOpts.mkBool true '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin (pyflakes). + Setting this explicitly to `true` will install the dependency for this plugin (pyflakes). ''; }; pylint = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin (pylint). + Setting this explicitly to `true` will install the dependency for this plugin (pylint). ''; args = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" '' @@ -300,7 +300,7 @@ in { rope_autoimport = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin (rope). + Setting this explicitly to `true` will install the dependency for this plugin (rope). ''; memory = helpers.defaultNullOpts.mkBool false '' @@ -312,7 +312,7 @@ in { rope_completion = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin (rope). + Setting this explicitly to `true` will install the dependency for this plugin (rope). ''; eager = helpers.defaultNullOpts.mkBool false '' @@ -323,7 +323,7 @@ in { yapf = { enabled = helpers.defaultNullOpts.mkBool true '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin (yapf). + Setting this explicitly to `true` will install the dependency for this plugin (yapf). ''; }; @@ -331,7 +331,7 @@ in { pylsp_mypy = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin + Setting this explicitly to `true` will install the dependency for this plugin (pylsp-mypy). ''; @@ -393,7 +393,7 @@ in { isort = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin + Setting this explicitly to `true` will install the dependency for this plugin (pyls-isort). ''; }; @@ -401,7 +401,7 @@ in { black = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin + Setting this explicitly to `true` will install the dependency for this plugin (python-lsp-black). ''; @@ -424,7 +424,7 @@ in { memestra = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin + Setting this explicitly to `true` will install the dependency for this plugin (pyls-memestra). ''; }; @@ -432,7 +432,7 @@ in { rope = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin + Setting this explicitly to `true` will install the dependency for this plugin (pylsp-rope). ''; }; @@ -440,7 +440,7 @@ in { ruff = { enabled = helpers.defaultNullOpts.mkBool false '' Enable or disable the plugin. - Setting this explicitely to `true` will install the dependency for this plugin + Setting this explicitly to `true` will install the dependency for this plugin (python-lsp-ruff). ''; diff --git a/plugins/lsp/lspsaga.nix b/plugins/lsp/lspsaga.nix index 9ad9a012..bcb4cc07 100644 --- a/plugins/lsp/lspsaga.nix +++ b/plugins/lsp/lspsaga.nix @@ -245,7 +245,7 @@ in { ''; keys = { - shuttle = mkKeymapOption "[w" "Shuttle bettween the finder layout window."; + shuttle = mkKeymapOption "[w" "Shuttle between the finder layout window."; toggleOrOpen = mkKeymapOption "o" "Toggle expand or open."; @@ -403,7 +403,7 @@ in { quit = mkKeymapOption "q" "Quit layout."; - shuttle = mkKeymapOption "[w" "Shuttle bettween the layout left and right."; + shuttle = mkKeymapOption "[w" "Shuttle between the layout left and right."; toggleOrReq = mkKeymapOption "u" "Toggle or do request."; }; diff --git a/plugins/telescope/default.nix b/plugins/telescope/default.nix index d0d1c656..e6ea4d25 100644 --- a/plugins/telescope/default.nix +++ b/plugins/telescope/default.nix @@ -19,7 +19,7 @@ in { ./undo.nix ]; - # TODO:add support for aditional filetypes. This requires autocommands! + # TODO:add support for additional filetypes. This requires autocommands! options.plugins.telescope = helpers.neovim-plugin.extraOptionsOptions diff --git a/plugins/telescope/file-browser.nix b/plugins/telescope/file-browser.nix index 0ad3af4b..b025875a 100644 --- a/plugins/telescope/file-browser.nix +++ b/plugins/telescope/file-browser.nix @@ -95,7 +95,7 @@ in { ''; quiet = helpers.defaultNullOpts.mkBool false '' - Surpress any notification from file_brower actions. + Suppress any notification from file_browser actions. ''; dirIcon = helpers.defaultNullOpts.mkStr "" '' diff --git a/plugins/utils/commentary.nix b/plugins/utils/commentary.nix index f886a80b..186c2a20 100644 --- a/plugins/utils/commentary.nix +++ b/plugins/utils/commentary.nix @@ -8,7 +8,7 @@ with lib; let cfg = config.plugins.commentary; in { - # TODO Add support for aditional filetypes. This requires autocommands! + # TODO Add support for additional filetypes. This requires autocommands! options = { plugins.commentary = { diff --git a/plugins/utils/coverage.nix b/plugins/utils/coverage.nix index abf83df5..c03cf4f2 100644 --- a/plugins/utils/coverage.nix +++ b/plugins/utils/coverage.nix @@ -73,7 +73,7 @@ in { keymapsDef; autoReload = helpers.defaultNullOpts.mkBool false '' - If true, the `coverage_file` for a langauge will be watched for changes after executing + If true, the `coverage_file` for a language will be watched for changes after executing `:CoverageLoad` or `coverage.load()`. The file watcher will be stopped after executing `:CoverageClear` or `coverage.clear()`. ''; diff --git a/plugins/utils/flash.nix b/plugins/utils/flash.nix index d1ace251..0cdcb735 100644 --- a/plugins/utils/flash.nix +++ b/plugins/utils/flash.nix @@ -39,7 +39,7 @@ in { - search: regular search - fuzzy: fuzzy search - fun(str): custom search function that returns a pattern - For example, to only match at the begining of a word: + For example, to only match at the beginning of a word: function(str) return "\\<" .. str end @@ -108,7 +108,7 @@ in { }; label = { - uppercase = helpers.defaultNullOpts.mkBool true "allow upercase labels"; + uppercase = helpers.defaultNullOpts.mkBool true "allow uppercase labels"; exclude = helpers.defaultNullOpts.mkStr "" '' add any labels with the correct case here, that you want to exclude diff --git a/plugins/utils/illuminate.nix b/plugins/utils/illuminate.nix index 8ad555fa..dbbae1fa 100644 --- a/plugins/utils/illuminate.nix +++ b/plugins/utils/illuminate.nix @@ -25,7 +25,7 @@ with lib; let ''; modesAllowlist = mkListStr "[]" '' - Modes to illuminate, this is overriden by `modes_denylist`. + Modes to illuminate, this is overridden by `modes_denylist`. See `:help mode()` for possible values. ''; @@ -36,7 +36,7 @@ with lib; let ''; providersRegexSyntaxAllowlist = mkListStr "[]" '' - Syntax to illuminate, this is overriden by `providers_regex_syntax_denylist`. + Syntax to illuminate, this is overridden by `providers_regex_syntax_denylist`. Only applies to the 'regex' provider. Use `:echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name')`. ''; @@ -61,7 +61,7 @@ with lib; let ''; filetypesAllowlist = mkListStr "[]" '' - Filetypes to illuminate, this is overriden by `filetypes_denylist`. + Filetypes to illuminate, this is overridden by `filetypes_denylist`. ''; }; in { diff --git a/plugins/utils/marks.nix b/plugins/utils/marks.nix index 17f84cdd..ed4c907d 100644 --- a/plugins/utils/marks.nix +++ b/plugins/utils/marks.nix @@ -49,7 +49,7 @@ in { positions/redraw signs. Lower values means that mark positions and signs will refresh much quicker, but may incur a higher performance penalty, whereas higher values may result in better performance, but may - also cause noticable lag in signs updating. + also cause noticeable lag in signs updating. ''; signPriority = diff --git a/plugins/utils/mkdnflow.nix b/plugins/utils/mkdnflow.nix index 622977ce..5f3eb306 100644 --- a/plugins/utils/mkdnflow.nix +++ b/plugins/utils/mkdnflow.nix @@ -300,7 +300,7 @@ in { provided, the plugin will attempt to infer what the meanings of the symbols in your list are by their order. - For example, if you set `toDo.symbols` as `[" " "⧖" "✓"]`, `" "` will be assiged to + For example, if you set `toDo.symbols` as `[" " "⧖" "✓"]`, `" "` will be assigned to `toDo.notStarted`, "⧖" will be assigned to `toDo.inProgress`, etc. If more than three symbols are specified, the first will be used as `notStarted`, the second will be used as `inProgress`, and the last will be used as `complete`. @@ -317,7 +317,7 @@ in { provided, the plugin will attempt to infer what the meanings of the symbols in your list are by their order. - For example, if you set `toDo.symbols` as `[" " "⧖" "✓"]`, `" "` will be assiged to + For example, if you set `toDo.symbols` as `[" " "⧖" "✓"]`, `" "` will be assigned to `toDo.notStarted`, "⧖" will be assigned to `toDo.inProgress`, etc. If more than three symbols are specified, the first will be used as `notStarted`, the second will be used as `inProgress`, and the last will be used as `complete`. @@ -334,7 +334,7 @@ in { provided, the plugin will attempt to infer what the meanings of the symbols in your list are by their order. - For example, if you set `toDo.symbols` as `[" " "⧖" "✓"]`, `" "` will be assiged to + For example, if you set `toDo.symbols` as `[" " "⧖" "✓"]`, `" "` will be assigned to `toDo.notStarted`, "⧖" will be assigned to `toDo.inProgress`, etc. If more than three symbols are specified, the first will be used as `notStarted`, the second will be used as `inProgress`, and the last will be used as `complete`. diff --git a/plugins/utils/molten.nix b/plugins/utils/molten.nix index 84a50240..ab50d771 100644 --- a/plugins/utils/molten.nix +++ b/plugins/utils/molten.nix @@ -169,7 +169,7 @@ with helpers.vim-plugin; show_mimetype_debug = helpers.defaultNullOpts.mkBool false '' Before any non-iostream output chunk, the mime-type for that output chunk is shown. - Meant for debugging/plugin devlopment. + Meant for debugging/plugin development. ''; }; diff --git a/plugins/utils/neogen.nix b/plugins/utils/neogen.nix index 3a9fb0c7..ad7512fa 100644 --- a/plugins/utils/neogen.nix +++ b/plugins/utils/neogen.nix @@ -112,57 +112,66 @@ in { - `"vsnip"` (https://github.com/hrsh7th/vim-vsnip) ''; - placeholderHighligt = helpers.defaultNullOpts.mkStr "DiagnosticHint" '' + placeholderHighlight = helpers.defaultNullOpts.mkStr "DiagnosticHint" '' Placeholders highlights to use. If you don't want custom highlight, pass "None" ''; placeholdersText = { description = helpers.defaultNullOpts.mkStr "[TODO:description]" '' - Placholder for description. + Placeholder for description. ''; tparam = helpers.defaultNullOpts.mkStr "[TODO:tparam]" '' - Placholder for tparam. + Placeholder for tparam. ''; parameter = helpers.defaultNullOpts.mkStr "[TODO:parameter]" '' - Placholder for parameter. + Placeholder for parameter. ''; return = helpers.defaultNullOpts.mkStr "[TODO:return]" '' - Placholder for return. + Placeholder for return. ''; class = helpers.defaultNullOpts.mkStr "[TODO:class]" '' - Placholder for class. + Placeholder for class. ''; throw = helpers.defaultNullOpts.mkStr "[TODO:throw]" '' - Placholder for throw. + Placeholder for throw. ''; varargs = helpers.defaultNullOpts.mkStr "[TODO:varargs]" '' - Placholder for varargs. + Placeholder for varargs. ''; type = helpers.defaultNullOpts.mkStr "[TODO:type]" '' - Placholder for type. + Placeholder for type. ''; attribute = helpers.defaultNullOpts.mkStr "[TODO:attribute]" '' - Placholder for attribute. + Placeholder for attribute. ''; args = helpers.defaultNullOpts.mkStr "[TODO:args]" '' - Placholder for args. + Placeholder for args. ''; kwargs = helpers.defaultNullOpts.mkStr "[TODO:kwargs]" '' - Placholder for kwargs. + Placeholder for kwargs. ''; }; }; + # TODO introduced 2024-03-07: remove 2024-05-07 + imports = [ + ( + mkRenamedOptionModule + ["plugins" "neogen" "placeholderHighligt"] + ["plugins" "neogen" "placeholderHighlight"] + ) + ]; + config = let setupOptions = with cfg; { enabled = enable; @@ -171,7 +180,7 @@ in { snippet_engine = snippetEngine; enable_placeholders = enablePlaceholders; placeholder_text = placeholdersText; - placeholder_hl = placeholderHighligt; + placeholder_hl = placeholderHighlight; }; in mkIf cfg.enable { diff --git a/plugins/utils/nvim-bqf.nix b/plugins/utils/nvim-bqf.nix index fa9d308d..734d9252 100644 --- a/plugins/utils/nvim-bqf.nix +++ b/plugins/utils/nvim-bqf.nix @@ -20,7 +20,7 @@ in { ''; magicWindow = helpers.defaultNullOpts.mkBool true '' - Give the window magic, when the window is splited horizontally, keep the distance between the + Give the window magic, when the window is split horizontally, keep the distance between the current line and the top/bottom border of neovim unchanged. It's a bit like a floating window, but the window is indeed a normal window, without any floating attributes. diff --git a/plugins/utils/nvim-osc52.nix b/plugins/utils/nvim-osc52.nix index 02394348..06e1bea8 100644 --- a/plugins/utils/nvim-osc52.nix +++ b/plugins/utils/nvim-osc52.nix @@ -21,7 +21,7 @@ with lib; { silent = mkOption { type = types.bool; - description = "Wether nvim-osc52 keymaps should be silent"; + description = "Whether nvim-osc52 keymaps should be silent"; default = false; }; diff --git a/plugins/utils/oil.nix b/plugins/utils/oil.nix index a107e97c..2c68947f 100644 --- a/plugins/utils/oil.nix +++ b/plugins/utils/oil.nix @@ -384,7 +384,7 @@ in { "__unkeyed" = "birthtime"; inherit (birthtime) highlight format; }); - buf_opions = cfg.bufOptions; + buf_options = cfg.bufOptions; win_options = cfg.winOptions; default_file_explorer = cfg.defaultFileExplorer; restore_win_options = cfg.restoreWinOptions; diff --git a/plugins/utils/specs.nix b/plugins/utils/specs.nix index 21d02865..ae5c6812 100644 --- a/plugins/utils/specs.nix +++ b/plugins/utils/specs.nix @@ -26,13 +26,13 @@ in { delay = mkOption { type = types.int; default = 0; - description = "Delay in miliseconds"; + description = "Delay in milliseconds"; }; increment = mkOption { type = types.int; default = 10; - description = "Increment in miliseconds"; + description = "Increment in milliseconds"; }; blend = mkOption { diff --git a/plugins/utils/spider.nix b/plugins/utils/spider.nix index 3564e880..81e34b01 100644 --- a/plugins/utils/spider.nix +++ b/plugins/utils/spider.nix @@ -17,7 +17,7 @@ in { package = helpers.mkPackageOption pluginName pkgs.vimPlugins.nvim-spider; skipInsignificantPunctuation = - helpers.defaultNullOpts.mkBool true "Whether to skip unsignificant punctuation."; + helpers.defaultNullOpts.mkBool true "Whether to skip insignificant punctuation."; keymaps = { silent = mkOption { diff --git a/plugins/utils/startup.nix b/plugins/utils/startup.nix index 1b5e9b16..2acbc79e 100644 --- a/plugins/utils/startup.nix +++ b/plugins/utils/startup.nix @@ -83,7 +83,7 @@ in { ] ) '' - The type of `content` depends on the secton `type`: + The type of `content` depends on the section `type`: - "text" -> a list of strings or a function (`rawLua`) that requires a function that returns a table of strings - "mapping" -> a list of list of strings in the format: ```nix diff --git a/plugins/utils/vim-matchup.nix b/plugins/utils/vim-matchup.nix index 153c29fb..acb6346f 100644 --- a/plugins/utils/vim-matchup.nix +++ b/plugins/utils/vim-matchup.nix @@ -78,7 +78,7 @@ with lib; { helpers.defaultNullOpts.mkInt 60 "Adjust timeouts in milliseconds for matchparen highlighting"; - deffered = { + deferred = { enable = helpers.defaultNullOpts.mkBool false '' Deferred highlighting improves cursor movement performance (for example, when using hjkl) by delaying highlighting for a short time and waiting to see if the cursor continues @@ -145,6 +145,15 @@ with lib; { ''; }; + # TODO introduced 2024-03-07: remove 2024-05-07 + imports = [ + ( + mkRenamedOptionModule + ["plugins" "vim-matchup" "matchParen" "deffered"] + ["plugins" "vim-matchup" "matchParen" "deferred"] + ) + ]; + config = let cfg = config.plugins.vim-matchup; in @@ -170,9 +179,9 @@ with lib; { matchup_matchparen_stopline = cfg.matchParen.stopline; matchup_matchparen_timeout = cfg.matchParen.timeout; matchup_matchparen_insert_timeout = cfg.matchParen.insertTimeout; - matchup_matchparen_deferred = cfg.matchParen.deffered.enable; - matchup_matchparen_deferred_show_delay = cfg.matchParen.deffered.showDelay; - matchup_matchparen_deferred_hide_delay = cfg.matchParen.deffered.hideDelay; + matchup_matchparen_deferred = cfg.matchParen.deferred.enable; + matchup_matchparen_deferred_show_delay = cfg.matchParen.deferred.showDelay; + matchup_matchparen_deferred_hide_delay = cfg.matchParen.deferred.hideDelay; matchup_matchparen_hi_surround_always = cfg.matchParen.hiSurroundAlways; matchup_motion_enabled = cfg.motion.enable; diff --git a/plugins/utils/which-key.nix b/plugins/utils/which-key.nix index a0c93262..e7995a65 100644 --- a/plugins/utils/which-key.nix +++ b/plugins/utils/which-key.nix @@ -139,7 +139,7 @@ with lib; { triggers = helpers.defaultNullOpts.mkNullable (types.either (types.enum ["auto"]) (types.listOf types.str)) - ''"auto"'' "automatically setup triggers, or specifiy a list manually"; + ''"auto"'' "automatically setup triggers, or specify a list manually"; triggersNoWait = helpers.defaultNullOpts.mkNullable (types.listOf types.str) diff --git a/plugins/utils/yanky.nix b/plugins/utils/yanky.nix index ad0b0425..d18ae477 100644 --- a/plugins/utils/yanky.nix +++ b/plugins/utils/yanky.nix @@ -58,7 +58,7 @@ in { ''; ignoreRegisters = helpers.defaultNullOpts.mkNullable (with types; listOf str) ''["_"]'' '' - Define registeres to be ignored. + Define registers to be ignored. By default the black hole register is ignored. ''; @@ -125,12 +125,12 @@ in { This works regardless to your `&clipboard` setting. This means, if `&clipboard` is set to `unnamed` and/or `unnamedplus`, if you yank - something outside of Neovim, you can put it immediatly using `p` and it will be added to + something outside of Neovim, you can put it immediately using `p` and it will be added to your yank ring. If `&clipboard` is empty, if you yank something outside of Neovim, this will be the first value you'll have when cycling through the ring. - Basicly, you can do `p` and then `` to paste yanked text. + Basically, you can do `p` and then `` to paste yanked text. ''; }; diff --git a/tests/fetch-tests.nix b/tests/fetch-tests.nix index 0c0442b1..784d23f5 100644 --- a/tests/fetch-tests.nix +++ b/tests/fetch-tests.nix @@ -19,7 +19,7 @@ ] else parseDirectories file (namespace ++ [name]); - # Recurse into all directories, extracting files as we find them. This returs a deeply nested + # Recurse into all directories, extracting files as we find them. This returns a deeply nested # list, where each non list element is a set of test cases. parseDirectories = path: namespace: let relativePath = lib.removePrefix "${root}" "${path}"; diff --git a/tests/test-sources/plugins/utils/neocord.nix b/tests/test-sources/plugins/utils/neocord.nix index 97134b65..dbea9f0a 100644 --- a/tests/test-sources/plugins/utils/neocord.nix +++ b/tests/test-sources/plugins/utils/neocord.nix @@ -1,12 +1,12 @@ { empty = { - # don't run tests as they try to acess the network. + # don't run tests as they try to access the network. tests.dontRun = true; plugins.neocord.enable = true; }; defaults = { - # don't run tests as they try to acess the network. + # don't run tests as they try to access the network. tests.dontRun = true; plugins.neocord = { enable = true; @@ -38,7 +38,7 @@ }; example = { - # don't run tests as they try to acess the network. + # don't run tests as they try to access the network. tests.dontRun = true; plugins.neocord = { enable = true; diff --git a/tests/test-sources/plugins/utils/neogen.nix b/tests/test-sources/plugins/utils/neogen.nix index 71cdfdaa..46bd89a8 100644 --- a/tests/test-sources/plugins/utils/neogen.nix +++ b/tests/test-sources/plugins/utils/neogen.nix @@ -24,7 +24,7 @@ }; }; }; - placeholderHighligt = "None"; + placeholderHighlight = "None"; placeholdersText = { attribute = "attribute"; class = "class"; diff --git a/tests/test-sources/plugins/utils/tmux-navigator.nix b/tests/test-sources/plugins/utils/tmux-navigator.nix index 601bddac..53849289 100644 --- a/tests/test-sources/plugins/utils/tmux-navigator.nix +++ b/tests/test-sources/plugins/utils/tmux-navigator.nix @@ -4,7 +4,7 @@ plugins.tmux-navigator.enable = true; }; - # Actiavte all settings + # Activate all settings defaults = { plugins.tmux-navigator = { enable = true; diff --git a/typos.toml b/typos.toml new file mode 100644 index 00000000..b7a2211c --- /dev/null +++ b/typos.toml @@ -0,0 +1,8 @@ +[default.extend-words] +tabe = "tabe" +noice = "noice" +darcula = "darcula" # base16-list +Parm = "Parm" # clangd-extensions +Definitons = "Definitons" # TODO: ./plugins/languages/treesitter/treesitter-refactor.nix +deffered = "deffered" # TODO: ./plugins/utils/vim-matchup.nix +Highligt = "Highligt" # TODO: ./plugins/utils/neogen.nix