Skip to content

Commit

Permalink
wrapper/rc: explicitly add tabstop & shiftwidth to vim.options
Browse files Browse the repository at this point in the history
Defaults are taken from Neovim's :help tags for those options to avoid intrusive/confusing behaviour.
  • Loading branch information
NotAShelf committed Dec 12, 2024
1 parent 73660af commit a0a5775
Showing 1 changed file with 32 additions and 16 deletions.
48 changes: 32 additions & 16 deletions modules/wrapper/rc/options.nix
Original file line number Diff line number Diff line change
Expand Up @@ -126,16 +126,14 @@ in {

example = {"some_variable" = 42;};
description = ''
An attribute set containing global variable values
for storing vim variables as early as possible. If
populated, this option will set vim variables in the
built luaConfigRC as the first item.
A freeform attribute set containing global variable values for setting vim
variables as early as possible. If populated, this option will set vim variables
in the built {option}`luaConfigRC` as the first item.
::: {.note}
`{foo = "bar";}` will set `vim.g.foo` to "bar", where
the type of `bar` in the resulting Lua value will be
inferred from the type of the value in the `{name = value;}`
pair passed to the option.
`{foo = "bar";}` will set `vim.g.foo` to "bar", where the type of `bar` in the
resulting Lua value will be inferred from the type of the value in the
`{name = value;}` pair passed to the option.
:::
'';
};
Expand Down Expand Up @@ -212,21 +210,39 @@ in {
default = true;
description = "Enable word wrapping.";
};

tabstop = mkOption {
type = int;
default = 8; # Neovim default
description = ''
Number of spaces that a `<Tab>` in the file counts for. Also see
the {command}`:retab` command, and the {option}`softtabstop` option.
'';
};

shiftwidth = mkOption {
type = int;
default = 8; # Neovim default
description = ''
Number of spaces to use for each step of (auto)indent. Used for
{option}`cindent`, `>>`, `<<`, etc.
When zero the {option}`tabstop` value will be used.
'';
};
};
};

example = {visualbell = true;};
description = ''
An attribute set containing vim options to be set
as early as possible. If populated, this option will
set vim options in the built luaConfigRC after `basic`
and before `pluginConfigs` DAG entries.
A freeform attribute set containing vim options to be set as early as possible.
If populated, this option will set vim options in the built {option}`luaConfigRC`
after `basic` and before `pluginConfigs` DAG entries.
::: {.note}
`{foo = "bar";}` will set `vim.o.foo` to "bar", where
the type of `bar` in the resulting Lua value will be
inferred from the type of the value in the`{name = value;}`
pair passed to the option.
`{foo = "bar";}` will set `vim.o.foo` to "bar", where the type of `bar` in the
resulting Lua value will be inferred from the type of the value in the
`{name = value;}` pair passed to the option.
:::
'';
};
Expand Down

0 comments on commit a0a5775

Please sign in to comment.