treewide: fix typos (#1217)

This commit is contained in:
Loïc Reynier 2024-03-07 19:44:13 +01:00 committed by GitHub
parent e9564ac336
commit 233feeb8d2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
50 changed files with 123 additions and 96 deletions

View file

@ -16,6 +16,7 @@
"plugins/lsp/language-servers/rust-analyzer-config.nix" "plugins/lsp/language-servers/rust-analyzer-config.nix"
]; ];
}; };
typos.enable = true;
}; };
}; };
}; };

View file

@ -52,7 +52,7 @@
doc_derivation=$(${nix} build .#docs --no-link --print-out-paths) 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 port=8000
echo -e "\n=> Now open your browser and navigate to 'localhost:$port'\n" echo -e "\n=> Now open your browser and navigate to 'localhost:$port'\n"

View file

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

View file

@ -140,7 +140,7 @@ with lib; {
{ {
inherit extraPackages; inherit extraPackages;
globals = mapAttrs' (n: nameValuePair (globalPrefix + n)) globals; 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; extraPlugins = extraPlugins ++ optional (defaultPackage != null) cfg.package;
} }
(extraConfig cfg) (extraConfig cfg)

View file

@ -12,7 +12,7 @@ helpers.neovim-plugin.mkNeovimPlugin config {
maintainers = [lib.maintainers.MyName]; # TODO replace with your name 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 = { settingsOptions = {
foo = helpers.defaultNullOpts.mkUnsignedInt 97 '' foo = helpers.defaultNullOpts.mkUnsignedInt 97 ''
The best birth year. 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 = { settingsExample = {
foo = 42; foo = 42;
bar.__raw = "function() print('hello') end"; bar.__raw = "function() print('hello') end";

View file

@ -43,8 +43,8 @@ with lib; let
}; };
separator = { separator = {
left = helpers.defaultNullOpts.mkStr "" "Left seperator"; left = helpers.defaultNullOpts.mkStr "" "Left separator";
right = helpers.defaultNullOpts.mkStr "" "Right seperator"; right = helpers.defaultNullOpts.mkStr "" "Right separator";
}; };
}; };
@ -186,7 +186,7 @@ in {
"asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP" "asdfjkl;ghnmxcvbziowerutyqpASDFJKLGHNMXCVBZIOWERUTYQP"
'' ''
New buffer letters are assigned in this order. 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 = sidebarFiletypes =
@ -251,7 +251,7 @@ in {
diagnostics = diagnostics =
/* /*
Because the keys of this lua table are not strings (but 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 let
setIcons = filterAttrs (n: v: v != null) cfg.icons.diagnostics; setIcons = filterAttrs (n: v: v != null) cfg.icons.diagnostics;

View file

@ -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: Example:
```nix ```nix

View file

@ -32,7 +32,7 @@ helpers.vim-plugin.mkVimPlugin config {
''; '';
borders = helpers.defaultNullOpts.mkBool false '' 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 '' disable_background = helpers.defaultNullOpts.mkBool false ''

View file

@ -13,7 +13,7 @@ in {
helpers.neovim-plugin.extraOptionsOptions helpers.neovim-plugin.extraOptionsOptions
// { // {
host = helpers.defaultNullOpts.mkStr "http://localhost:5000" '' 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 '' maxLines = helpers.defaultNullOpts.mkUnsignedInt 100 ''

View file

@ -132,7 +132,7 @@ in {
https://github.com/zbirenbaum/copilot.lua/blob/master/SettingsOpts.md. 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. 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. numerous checks to verify copilot is actually running.
See `:h vim.lsp.start_client` for list of options. See `:h vim.lsp.start_client` for list of options.

View file

@ -102,7 +102,7 @@ with lib; rec {
request = mkOption { request = mkOption {
type = types.enum ["attach" "launch"]; type = types.enum ["attach" "launch"];
description = '' 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.
''; '';
}; };

View file

@ -30,7 +30,7 @@ in
}; };
configurations = helpers.mkNullOrOption (with types; attrsOf (listOf dapHelpers.configurationOption)) '' 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." { signs = helpers.mkCompositeOption "Signs for dap." {
@ -40,7 +40,7 @@ in
dapLogPoint = mkSignOption "L" "Sign for log points."; 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."; dapBreakpointRejected = mkSignOption "R" "Sign to indicate breakpoints rejected by the debug adapter.";
}; };

View file

@ -13,7 +13,7 @@ in {
( (
mkRemovedOptionModule mkRemovedOptionModule
(basePluginPath ++ ["sourceSelector" "tabLabels"]) (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 mkRemovedOptionModule

View file

@ -328,7 +328,7 @@ in {
''; '';
s = mkNullStr '' 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 the specified pattern (extended regular expression) in a
file. file.
''; '';

View file

@ -13,7 +13,7 @@ with lib; let
borderOpt = helpers.defaultNullOpts.mkBorder "none" "clangd-extensions" ""; borderOpt = helpers.defaultNullOpts.mkBorder "none" "clangd-extensions" "";
in { in {
# All of those warnings were introduced on 08/22/2023. # 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 = imports =
[ [
( (

View file

@ -182,7 +182,7 @@ in {
stderr = { stderr = {
enable = helpers.defaultNullOpts.mkBool true '' 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."; height = helpers.defaultNullOpts.mkPositiveInt 5 "Height of the window.";

View file

@ -119,7 +119,7 @@ with helpers.vim-plugin;
Scroll type: Scroll type:
- "middle": The cursor position is always shown at the middle of the preview page. - "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. - "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 '' hide_yaml_meta = helpers.defaultNullOpts.mkBool true ''

View file

@ -107,7 +107,7 @@ in {
''; '';
pipe = helpers.mkNullOrStr '' 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. Useful if using a shell that is not supported by this plugin.
''; '';
}; };

View file

@ -33,7 +33,7 @@ in {
mkList ''["Classic" "VirtualTextOk"]'' mkList ''["Classic" "VirtualTextOk"]''
'' ''
You can combo different display modes as desired and with the 'Ok' or 'Err' suffix to filter 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: Example:
```nix ```nix

View file

@ -69,7 +69,7 @@ with lib; {
description = '' description = ''
go to the definition of the symbol under the cursor or use vim.lsp.buf.definition if 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 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 { listDefinitions = mkOption {

View file

@ -180,9 +180,9 @@ in {
require('nvim-treesitter.configs').setup(${helpers.toLuaObject tsOptions}) require('nvim-treesitter.configs').setup(${helpers.toLuaObject tsOptions})
'' ''
+ (optionalString (cfg.languageRegister != {}) '' + (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) require('vim.treesitter.language').register(parser_name, ft)
end end
''); '');

View file

@ -20,7 +20,7 @@ with lib; {
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = ''
Whethter to skip backwards compatibility routines and speed up loading. Whether to skip backwards compatibility routines and speed up loading.
''; '';
example = false; example = false;
}; };

View file

@ -126,7 +126,7 @@ in {
"WARNING: Experimental feature also in VSCode, disabled by default because it might impact server performance."; "WARNING: Experimental feature also in VSCode, disabled by default because it might impact server performance.";
disableMemberCodeLens = helpers.defaultNullOpts.mkBool true '' 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 = { jsxCloseTag = {

View file

@ -38,7 +38,7 @@ in {
options = { options = {
enable = helpers.defaultNullOpts.mkBool true '' enable = helpers.defaultNullOpts.mkBool true ''
Enable option completion task. Enable option completion task.
If you are writting a package, disable this If you are writing a package, disable this
''; '';
target = { target = {

View file

@ -26,7 +26,7 @@ in {
autopep8 = { autopep8 = {
enabled = helpers.defaultNullOpts.mkBool true '' enabled = helpers.defaultNullOpts.mkBool true ''
Enable or disable the plugin. 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 '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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) "[]" '' exclude = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" ''
@ -177,7 +177,7 @@ in {
mccabe = { mccabe = {
enabled = helpers.defaultNullOpts.mkBool true '' enabled = helpers.defaultNullOpts.mkBool true ''
Enable or disable the plugin. 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 '' threshold = helpers.defaultNullOpts.mkInt 15 ''
@ -196,7 +196,7 @@ in {
pycodestyle = { pycodestyle = {
enabled = helpers.defaultNullOpts.mkBool true '' enabled = helpers.defaultNullOpts.mkBool true ''
Enable or disable the plugin. 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). (pycodestyle).
''; '';
@ -232,7 +232,7 @@ in {
pydocstyle = { pydocstyle = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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). (pydocstyle).
''; '';
@ -276,14 +276,14 @@ in {
pyflakes = { pyflakes = {
enabled = helpers.defaultNullOpts.mkBool true '' enabled = helpers.defaultNullOpts.mkBool true ''
Enable or disable the plugin. 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 = { pylint = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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) "[]" '' args = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" ''
@ -300,7 +300,7 @@ in {
rope_autoimport = { rope_autoimport = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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 '' memory = helpers.defaultNullOpts.mkBool false ''
@ -312,7 +312,7 @@ in {
rope_completion = { rope_completion = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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 '' eager = helpers.defaultNullOpts.mkBool false ''
@ -323,7 +323,7 @@ in {
yapf = { yapf = {
enabled = helpers.defaultNullOpts.mkBool true '' enabled = helpers.defaultNullOpts.mkBool true ''
Enable or disable the plugin. 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 = { pylsp_mypy = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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). (pylsp-mypy).
''; '';
@ -393,7 +393,7 @@ in {
isort = { isort = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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). (pyls-isort).
''; '';
}; };
@ -401,7 +401,7 @@ in {
black = { black = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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). (python-lsp-black).
''; '';
@ -424,7 +424,7 @@ in {
memestra = { memestra = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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). (pyls-memestra).
''; '';
}; };
@ -432,7 +432,7 @@ in {
rope = { rope = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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). (pylsp-rope).
''; '';
}; };
@ -440,7 +440,7 @@ in {
ruff = { ruff = {
enabled = helpers.defaultNullOpts.mkBool false '' enabled = helpers.defaultNullOpts.mkBool false ''
Enable or disable the plugin. 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). (python-lsp-ruff).
''; '';

View file

@ -245,7 +245,7 @@ in {
''; '';
keys = { 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."; toggleOrOpen = mkKeymapOption "o" "Toggle expand or open.";
@ -403,7 +403,7 @@ in {
quit = mkKeymapOption "q" "Quit layout."; 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."; toggleOrReq = mkKeymapOption "u" "Toggle or do request.";
}; };

View file

@ -19,7 +19,7 @@ in {
./undo.nix ./undo.nix
]; ];
# TODO:add support for aditional filetypes. This requires autocommands! # TODO:add support for additional filetypes. This requires autocommands!
options.plugins.telescope = options.plugins.telescope =
helpers.neovim-plugin.extraOptionsOptions helpers.neovim-plugin.extraOptionsOptions

View file

@ -95,7 +95,7 @@ in {
''; '';
quiet = helpers.defaultNullOpts.mkBool false '' quiet = helpers.defaultNullOpts.mkBool false ''
Surpress any notification from file_brower actions. Suppress any notification from file_browser actions.
''; '';
dirIcon = helpers.defaultNullOpts.mkStr "" '' dirIcon = helpers.defaultNullOpts.mkStr "" ''

View file

@ -8,7 +8,7 @@
with lib; let with lib; let
cfg = config.plugins.commentary; cfg = config.plugins.commentary;
in { in {
# TODO Add support for aditional filetypes. This requires autocommands! # TODO Add support for additional filetypes. This requires autocommands!
options = { options = {
plugins.commentary = { plugins.commentary = {

View file

@ -73,7 +73,7 @@ in {
keymapsDef; keymapsDef;
autoReload = helpers.defaultNullOpts.mkBool false '' 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()`. `:CoverageLoad` or `coverage.load()`.
The file watcher will be stopped after executing `:CoverageClear` or `coverage.clear()`. The file watcher will be stopped after executing `:CoverageClear` or `coverage.clear()`.
''; '';

View file

@ -39,7 +39,7 @@ in {
- search: regular search - search: regular search
- fuzzy: fuzzy search - fuzzy: fuzzy search
- fun(str): custom search function that returns a pattern - 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) function(str)
return "\\<" .. str return "\\<" .. str
end end
@ -108,7 +108,7 @@ in {
}; };
label = { label = {
uppercase = helpers.defaultNullOpts.mkBool true "allow upercase labels"; uppercase = helpers.defaultNullOpts.mkBool true "allow uppercase labels";
exclude = helpers.defaultNullOpts.mkStr "" '' exclude = helpers.defaultNullOpts.mkStr "" ''
add any labels with the correct case here, that you want to exclude add any labels with the correct case here, that you want to exclude

View file

@ -25,7 +25,7 @@ with lib; let
''; '';
modesAllowlist = mkListStr "[]" '' 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. See `:help mode()` for possible values.
''; '';
@ -36,7 +36,7 @@ with lib; let
''; '';
providersRegexSyntaxAllowlist = mkListStr "[]" '' 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. Only applies to the 'regex' provider.
Use `:echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name')`. Use `:echo synIDattr(synIDtrans(synID(line('.'), col('.'), 1)), 'name')`.
''; '';
@ -61,7 +61,7 @@ with lib; let
''; '';
filetypesAllowlist = mkListStr "[]" '' filetypesAllowlist = mkListStr "[]" ''
Filetypes to illuminate, this is overriden by `filetypes_denylist`. Filetypes to illuminate, this is overridden by `filetypes_denylist`.
''; '';
}; };
in { in {

View file

@ -49,7 +49,7 @@ in {
positions/redraw signs. positions/redraw signs.
Lower values means that mark positions and signs will refresh much quicker, but may incur a 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 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 = signPriority =

View file

@ -300,7 +300,7 @@ in {
provided, the plugin will attempt to infer what the meanings of the symbols in your list provided, the plugin will attempt to infer what the meanings of the symbols in your list
are by their order. 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. `toDo.notStarted`, "" will be assigned to `toDo.inProgress`, etc.
If more than three symbols are specified, the first will be used as `notStarted`, the 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`. 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 provided, the plugin will attempt to infer what the meanings of the symbols in your list
are by their order. 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. `toDo.notStarted`, "" will be assigned to `toDo.inProgress`, etc.
If more than three symbols are specified, the first will be used as `notStarted`, the 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`. 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 provided, the plugin will attempt to infer what the meanings of the symbols in your list
are by their order. 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. `toDo.notStarted`, "" will be assigned to `toDo.inProgress`, etc.
If more than three symbols are specified, the first will be used as `notStarted`, the 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`. second will be used as `inProgress`, and the last will be used as `complete`.

View file

@ -169,7 +169,7 @@ with helpers.vim-plugin;
show_mimetype_debug = helpers.defaultNullOpts.mkBool false '' show_mimetype_debug = helpers.defaultNullOpts.mkBool false ''
Before any non-iostream output chunk, the mime-type for that output chunk is shown. 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.
''; '';
}; };

View file

@ -112,57 +112,66 @@ in {
- `"vsnip"` (https://github.com/hrsh7th/vim-vsnip) - `"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" Placeholders highlights to use. If you don't want custom highlight, pass "None"
''; '';
placeholdersText = { placeholdersText = {
description = helpers.defaultNullOpts.mkStr "[TODO:description]" '' description = helpers.defaultNullOpts.mkStr "[TODO:description]" ''
Placholder for description. Placeholder for description.
''; '';
tparam = helpers.defaultNullOpts.mkStr "[TODO:tparam]" '' tparam = helpers.defaultNullOpts.mkStr "[TODO:tparam]" ''
Placholder for tparam. Placeholder for tparam.
''; '';
parameter = helpers.defaultNullOpts.mkStr "[TODO:parameter]" '' parameter = helpers.defaultNullOpts.mkStr "[TODO:parameter]" ''
Placholder for parameter. Placeholder for parameter.
''; '';
return = helpers.defaultNullOpts.mkStr "[TODO:return]" '' return = helpers.defaultNullOpts.mkStr "[TODO:return]" ''
Placholder for return. Placeholder for return.
''; '';
class = helpers.defaultNullOpts.mkStr "[TODO:class]" '' class = helpers.defaultNullOpts.mkStr "[TODO:class]" ''
Placholder for class. Placeholder for class.
''; '';
throw = helpers.defaultNullOpts.mkStr "[TODO:throw]" '' throw = helpers.defaultNullOpts.mkStr "[TODO:throw]" ''
Placholder for throw. Placeholder for throw.
''; '';
varargs = helpers.defaultNullOpts.mkStr "[TODO:varargs]" '' varargs = helpers.defaultNullOpts.mkStr "[TODO:varargs]" ''
Placholder for varargs. Placeholder for varargs.
''; '';
type = helpers.defaultNullOpts.mkStr "[TODO:type]" '' type = helpers.defaultNullOpts.mkStr "[TODO:type]" ''
Placholder for type. Placeholder for type.
''; '';
attribute = helpers.defaultNullOpts.mkStr "[TODO:attribute]" '' attribute = helpers.defaultNullOpts.mkStr "[TODO:attribute]" ''
Placholder for attribute. Placeholder for attribute.
''; '';
args = helpers.defaultNullOpts.mkStr "[TODO:args]" '' args = helpers.defaultNullOpts.mkStr "[TODO:args]" ''
Placholder for args. Placeholder for args.
''; '';
kwargs = helpers.defaultNullOpts.mkStr "[TODO:kwargs]" '' 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 config = let
setupOptions = with cfg; { setupOptions = with cfg; {
enabled = enable; enabled = enable;
@ -171,7 +180,7 @@ in {
snippet_engine = snippetEngine; snippet_engine = snippetEngine;
enable_placeholders = enablePlaceholders; enable_placeholders = enablePlaceholders;
placeholder_text = placeholdersText; placeholder_text = placeholdersText;
placeholder_hl = placeholderHighligt; placeholder_hl = placeholderHighlight;
}; };
in in
mkIf cfg.enable { mkIf cfg.enable {

View file

@ -20,7 +20,7 @@ in {
''; '';
magicWindow = helpers.defaultNullOpts.mkBool true '' 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. 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 It's a bit like a floating window, but the window is indeed a normal window, without any
floating attributes. floating attributes.

View file

@ -21,7 +21,7 @@ with lib; {
silent = mkOption { silent = mkOption {
type = types.bool; type = types.bool;
description = "Wether nvim-osc52 keymaps should be silent"; description = "Whether nvim-osc52 keymaps should be silent";
default = false; default = false;
}; };

View file

@ -384,7 +384,7 @@ in {
"__unkeyed" = "birthtime"; "__unkeyed" = "birthtime";
inherit (birthtime) highlight format; inherit (birthtime) highlight format;
}); });
buf_opions = cfg.bufOptions; buf_options = cfg.bufOptions;
win_options = cfg.winOptions; win_options = cfg.winOptions;
default_file_explorer = cfg.defaultFileExplorer; default_file_explorer = cfg.defaultFileExplorer;
restore_win_options = cfg.restoreWinOptions; restore_win_options = cfg.restoreWinOptions;

View file

@ -26,13 +26,13 @@ in {
delay = mkOption { delay = mkOption {
type = types.int; type = types.int;
default = 0; default = 0;
description = "Delay in miliseconds"; description = "Delay in milliseconds";
}; };
increment = mkOption { increment = mkOption {
type = types.int; type = types.int;
default = 10; default = 10;
description = "Increment in miliseconds"; description = "Increment in milliseconds";
}; };
blend = mkOption { blend = mkOption {

View file

@ -17,7 +17,7 @@ in {
package = helpers.mkPackageOption pluginName pkgs.vimPlugins.nvim-spider; package = helpers.mkPackageOption pluginName pkgs.vimPlugins.nvim-spider;
skipInsignificantPunctuation = skipInsignificantPunctuation =
helpers.defaultNullOpts.mkBool true "Whether to skip unsignificant punctuation."; helpers.defaultNullOpts.mkBool true "Whether to skip insignificant punctuation.";
keymaps = { keymaps = {
silent = mkOption { silent = mkOption {

View file

@ -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 - "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: - "mapping" -> a list of list of strings in the format:
```nix ```nix

View file

@ -78,7 +78,7 @@ with lib; {
helpers.defaultNullOpts.mkInt 60 helpers.defaultNullOpts.mkInt 60
"Adjust timeouts in milliseconds for matchparen highlighting"; "Adjust timeouts in milliseconds for matchparen highlighting";
deffered = { deferred = {
enable = helpers.defaultNullOpts.mkBool false '' enable = helpers.defaultNullOpts.mkBool false ''
Deferred highlighting improves cursor movement performance (for example, when using hjkl) 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 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 config = let
cfg = config.plugins.vim-matchup; cfg = config.plugins.vim-matchup;
in in
@ -170,9 +179,9 @@ with lib; {
matchup_matchparen_stopline = cfg.matchParen.stopline; matchup_matchparen_stopline = cfg.matchParen.stopline;
matchup_matchparen_timeout = cfg.matchParen.timeout; matchup_matchparen_timeout = cfg.matchParen.timeout;
matchup_matchparen_insert_timeout = cfg.matchParen.insertTimeout; matchup_matchparen_insert_timeout = cfg.matchParen.insertTimeout;
matchup_matchparen_deferred = cfg.matchParen.deffered.enable; matchup_matchparen_deferred = cfg.matchParen.deferred.enable;
matchup_matchparen_deferred_show_delay = cfg.matchParen.deffered.showDelay; matchup_matchparen_deferred_show_delay = cfg.matchParen.deferred.showDelay;
matchup_matchparen_deferred_hide_delay = cfg.matchParen.deffered.hideDelay; matchup_matchparen_deferred_hide_delay = cfg.matchParen.deferred.hideDelay;
matchup_matchparen_hi_surround_always = cfg.matchParen.hiSurroundAlways; matchup_matchparen_hi_surround_always = cfg.matchParen.hiSurroundAlways;
matchup_motion_enabled = cfg.motion.enable; matchup_motion_enabled = cfg.motion.enable;

View file

@ -139,7 +139,7 @@ with lib; {
triggers = triggers =
helpers.defaultNullOpts.mkNullable helpers.defaultNullOpts.mkNullable
(types.either (types.enum ["auto"]) (types.listOf types.str)) (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 = triggersNoWait =
helpers.defaultNullOpts.mkNullable (types.listOf types.str) helpers.defaultNullOpts.mkNullable (types.listOf types.str)

View file

@ -58,7 +58,7 @@ in {
''; '';
ignoreRegisters = helpers.defaultNullOpts.mkNullable (with types; listOf str) ''["_"]'' '' 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. By default the black hole register is ignored.
''; '';
@ -125,12 +125,12 @@ in {
This works regardless to your `&clipboard` setting. This works regardless to your `&clipboard` setting.
This means, if `&clipboard` is set to `unnamed` and/or `unnamedplus`, if you yank 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. your yank ring.
If `&clipboard` is empty, if you yank something outside of Neovim, this will be the first 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. value you'll have when cycling through the ring.
Basicly, you can do `p` and then `<c-p>` to paste yanked text. Basically, you can do `p` and then `<c-p>` to paste yanked text.
''; '';
}; };

View file

@ -19,7 +19,7 @@
] ]
else parseDirectories file (namespace ++ [name]); 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. # list, where each non list element is a set of test cases.
parseDirectories = path: namespace: let parseDirectories = path: namespace: let
relativePath = lib.removePrefix "${root}" "${path}"; relativePath = lib.removePrefix "${root}" "${path}";

View file

@ -1,12 +1,12 @@
{ {
empty = { 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; tests.dontRun = true;
plugins.neocord.enable = true; plugins.neocord.enable = true;
}; };
defaults = { 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; tests.dontRun = true;
plugins.neocord = { plugins.neocord = {
enable = true; enable = true;
@ -38,7 +38,7 @@
}; };
example = { 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; tests.dontRun = true;
plugins.neocord = { plugins.neocord = {
enable = true; enable = true;

View file

@ -24,7 +24,7 @@
}; };
}; };
}; };
placeholderHighligt = "None"; placeholderHighlight = "None";
placeholdersText = { placeholdersText = {
attribute = "attribute"; attribute = "attribute";
class = "class"; class = "class";

View file

@ -4,7 +4,7 @@
plugins.tmux-navigator.enable = true; plugins.tmux-navigator.enable = true;
}; };
# Actiavte all settings # Activate all settings
defaults = { defaults = {
plugins.tmux-navigator = { plugins.tmux-navigator = {
enable = true; enable = true;

8
typos.toml Normal file
View file

@ -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