NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-12-11 22:53:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

treewide: replace auto option links with {option} role

Browse source
This commit is contained in:
Ching Pei Yang 2025-12-11 15:15:58 +01:00
commit da8c682af7
No known key found for this signature in database
GPG key ID: B3841364253DC4C8
16 changed files with 58 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/manual/configuring/custom-plugins.md
View file

@ -19,7 +19,7 @@ as a module.
:::{.info}
To add a plugin to your runtime, you will need to add it to
[](#opt-vim.startPlugins) list in your configuration. This is akin to cloning a
{option}`vim.startPlugins` list in your configuration. This is akin to cloning a
plugin to `~/.config/nvim`, but they are only ever placed in the Nix store and
never exposed to the outside world for purity and full isolation.

6
docs/manual/configuring/custom-plugins/legacy-method.md
View file

@ -1,8 +1,8 @@
# Legacy Method {#sec-legacy-method}
Prior to version **0.5**, the method of adding new plugins was adding the plugin
package to [](#opt-vim.startPlugins) and adding its configuration as a DAG under
one of `vim.configRC` or [](#opt-vim.luaConfigRC). While `configRC` has been
package to {option}`vim.startPlugins` and adding its configuration as a DAG under
one of `vim.configRC` or {option}`vim.luaConfigRC`. While `configRC` has been
deprecated, users who have not yet updated to 0.5 or those who prefer a more
hands-on approach may choose to use the old method where the load order of the
plugins is explicitly determined by DAGs without internal abstractions.
@ -10,7 +10,7 @@ plugins is explicitly determined by DAGs without internal abstractions.
## Adding New Plugins {#sec-adding-new-plugins}
To add a plugin not available in **nvf** as a module to your configuration using
the legacy method, you must add it to [](#opt-vim.startPlugins) in order to make
the legacy method, you must add it to {option}`vim.startPlugins` in order to make
it available to Neovim at runtime.
```nix

2
docs/manual/configuring/custom-plugins/non-lazy-method.md
View file

@ -2,7 +2,7 @@
As of version **0.5**, we have a more extensive API for configuring plugins that
should be preferred over the legacy method. This API is available as
[](#opt-vim.extraPlugins). Instead of using DAGs exposed by the library
{option}`vim.extraPlugins`. Instead of using DAGs exposed by the library
_directly_, you may use the extra plugin module as follows:
```nix

10
docs/manual/release-notes/rl-0.1.md
View file

@ -15,7 +15,7 @@ DAG implementation are from them.
longer defined. If you use hare and would like it added back, please file an
issue.
- [](#opt-vim.startPlugins) & [](#opt-vim.optPlugins) are now an enum of
- {option}`vim.startPlugins) & [](#opt-vim.optPlugins` are now an enum of
`string` for options sourced from the flake inputs. Users can still provide
vim plugin packages.
@ -28,13 +28,13 @@ DAG implementation are from them.
[relevant discourse post]: https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees
- Treesitter grammars are now configurable with
[](#opt-vim.treesitter.grammars). Utilizes the nixpkgs `nvim-treesitter`
{option}`vim.treesitter.grammars`. Utilizes the nixpkgs `nvim-treesitter`
plugin rather than a custom input in order to take advantage of build support
of pinned versions. See the [relevant discourse post] for more information.
Packages can be found under the `vimPlugins.nvim-treesitter.builtGrammars`
namespace.
- `vim.configRC` and [](#opt-vim.luaConfigRC) are now of type DAG lines. This
- `vim.configRC` and {option}`vim.luaConfigRC` are now of type DAG lines. This
allows for ordering of the config. Usage is the same is in home-manager's
`home.activation` option.
@ -44,5 +44,5 @@ vim.luaConfigRC = lib.nvim.dag.entryAnywhere "config here"
[MoritzBoehme](https://github.com/MoritzBoehme):
- `catppuccin` theme is now available as a neovim theme [](#opt-vim.theme.style)
and Lualine theme [](#opt-vim.statusline.lualine.theme).
- `catppuccin` theme is now available as a neovim theme {option}`vim.theme.style`
and Lualine theme {option}`vim.statusline.lualine.theme`.

10
docs/manual/release-notes/rl-0.3.md
View file

@ -39,7 +39,7 @@ soon.
[discourse]: https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees
- Treesitter grammars are now configurable with
[](#opt-vim.treesitter.grammars). Utilizes the nixpkgs `nvim-treesitter`
{option}`vim.treesitter.grammars`. Utilizes the nixpkgs `nvim-treesitter`
plugin rather than a custom input in order to take advantage of build support
of pinned versions. See [discourse] for more information. Packages can be
found under the `pkgs.vimPlugins.nvim-treesitter.builtGrammars` attribute.
@ -50,20 +50,20 @@ soon.
- A new section has been added for language support: `vim.languages.<language>`.
- The options `enableLSP` [](#opt-vim.languages.enableTreesitter), etc. will
- The options `enableLSP` {option}`vim.languages.enableTreesitter`, etc. will
enable the respective section for all languages that have been enabled.
- All LSP languages have been moved here
- `plantuml` and `markdown` have been moved here
- A new section has been added for `html`. The old
`vim.treesitter.autotagHtml` can be found at
[](#opt-vim.languages.html.treesitter.autotagHtml).
{option}`vim.languages.html.treesitter.autotagHtml`.
- `vim.git.gitsigns.codeActions` has been added, allowing you to turn on
Gitsigns' code actions.
- Removed the plugins document in the docs. Was too unwieldy to keep updated.
- `vim.visual.lspkind` has been moved to [](#opt-vim.lsp.lspkind.enable)
- `vim.visual.lspkind` has been moved to {option}`vim.lsp.lspkind.enable`
- Improved handling of completion formatting. When setting
`vim.autocomplete.sources`, can also include optional menu mapping. And can
@ -74,7 +74,7 @@ soon.
by using `null` rather than `""` now.
- Transparency has been made optional and has been disabled by default.
[](#opt-vim.theme.transparent) option can be used to enable or disable
{option}`vim.theme.transparent` option can be used to enable or disable
transparency for your configuration.
- Fixed deprecated configuration method for Tokyonight, and added new style

12
docs/manual/release-notes/rl-0.5.md
View file

@ -15,14 +15,14 @@
- Fixed a bug where cmp's close and scrollDocs mappings wasn't working
- Streamlined and simplified extra plugin API with the addition of
[](#opt-vim.extraPlugins)
{option}`vim.extraPlugins`
- Allow using command names in place of LSP packages to avoid automatic
installation
- Add lua LSP and Treesitter support, and neodev.nvim plugin support
- Add [](#opt-vim.lsp.mappings.toggleFormatOnSave) keybind
- Add {option}`vim.lsp.mappings.toggleFormatOnSave` keybind
[amanse](https://github.com/amanse):
@ -50,10 +50,10 @@
- Added GitHub Copilot to nvim-cmp completion sources.
- Added [](#opt-vim.ui.borders.enable) for global and individual plugin border
- Added {option}`vim.ui.borders.enable` for global and individual plugin border
configuration.
- LSP integrated breadcrumbs with [](#opt-vim.ui.breadcrumbs.enable) through
- LSP integrated breadcrumbs with {option}`vim.ui.breadcrumbs.enable` through
nvim-navic
- LSP navigation helper with nvim-navbuddy, depends on nvim-navic (automatically
@ -64,14 +64,14 @@
- Fixed mismatching Zig language description
- Added support for `statix` and `deadnix` through
[](#opt-vim.languages.nix.extraDiagnostics.types)
{option}`vim.languages.nix.extraDiagnostics.types`
- Added `lsp_lines` plugin for showing diagnostic messages
- Added a configuration option for choosing the leader key
- The package used for neovim is now customizable by the user, using
[](#opt-vim.package). For best results, always use an unwrapped package
{option}`vim.package`. For best results, always use an unwrapped package
- Added highlight-undo plugin for highlighting undo/redo targets

8
docs/manual/release-notes/rl-0.6.md
View file

@ -48,7 +48,7 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
- Added Terraform language support.
- Added `ChatGPT.nvim`, which can be enabled with
[](#opt-vim.assistant.chatgpt.enable). Do keep in mind that this option
{option}`vim.assistant.chatgpt.enable`. Do keep in mind that this option
requires `OPENAI_API_KEY` environment variable to be set.
[donnerinoern](https://github.com/donnerinoern):
@ -159,7 +159,7 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
arguments to take `luaBefore`, `luaConfig` and `luaAfter` as strings, which
are then concatted inside a lua block.
- Added [](#opt-vim.luaConfigPre) and [](#opt-vim.luaConfigPost) for inserting
- Added {option}`vim.luaConfigPre) and [](#opt-vim.luaConfigPost` for inserting
verbatim Lua configuration before and after the resolved Lua DAG respectively.
Both of those options take strings as the type, so you may read the contents
of a Lua file from a given path.
@ -172,12 +172,12 @@ vim.api.nvim_set_keymap('n', '<leader>a', ':lua camelToSnake()<CR>', { noremap =
- Exposed `withRuby`, `withNodeJs`, `withPython3`, and `python3Packages` from
the `makeNeovimConfig` function under their respective options.
- Added [](#opt-vim.extraPackages) for appending additional packages to the
- Added {option}`vim.extraPackages` for appending additional packages to the
wrapper PATH, making said packages available while inside the Neovim session.
- Made Treesitter options configurable, and moved treesitter-context to
`setupOpts` while it is enabled.
- Added [](#opt-vim.notify.nvim-notify.setupOpts.render) which takes either a
- Added {option}`vim.notify.nvim-notify.setupOpts.render` which takes either a
string of enum, or a Lua function. The default is "compact", but you may
change it according to nvim-notify documentation.

32
docs/manual/release-notes/rl-0.7.md
View file

@ -98,7 +98,7 @@ options that were under `vim` as convenient shorthands for `vim.o.*` options.
::: {.warning}
As v0.7 features the addition of [](#opt-vim.options), those options are now
As v0.7 features the addition of {option}`vim.options`, those options are now
considered as deprecated. You should migrate to the appropriate options in the
`vim.options` submodule.
@ -108,7 +108,7 @@ The changes are, in no particular order:
- `colourTerm`, `mouseSupport`, `cmdHeight`, `updateTime`, `mapTime`,
`cursorlineOpt`, `splitBelow`, `splitRight`, `autoIndent` and `wordWrap` have
been mapped to their [](#opt-vim.options) equivalents. Please see the module
been mapped to their {option}`vim.options` equivalents. Please see the module
definition for the updated options.
- `tabWidth` has been **removed** as it lead to confusing behaviour. You can
@ -125,7 +125,7 @@ The changes are, in no particular order:
[frothymarrow](https://github.com/frothymarrow):
- Modified type for
[](#opt-vim.visuals.fidget-nvim.setupOpts.progress.display.overrides) from
{option}`vim.visuals.fidget-nvim.setupOpts.progress.display.overrides` from
`anything` to a `submodule` for better type checking.
- Fix null `vim.lsp.mappings` generating an error and not being filtered out.
@ -134,7 +134,7 @@ The changes are, in no particular order:
group for `Normal`, `NormalFloat`, `LineNr`, `SignColumn` and optionally
`NvimTreeNormal` to `none`.
- Fix [](#opt-vim.ui.smartcolumn.setupOpts.custom_colorcolumn) using the wrong
- Fix {option}`vim.ui.smartcolumn.setupOpts.custom_colorcolumn` using the wrong
type `int` instead of the expected type `string`.
[horriblename](https://github.com/horriblename):
@ -216,18 +216,18 @@ The changes are, in no particular order:
- Remove `autopairs.type`, and rename `autopairs.enable` to
`autopairs.nvim-autopairs.enable`. The new
[](#opt-vim.autopairs.nvim-autopairs.enable) supports `setupOpts` format by
{option}`vim.autopairs.nvim-autopairs.enable` supports `setupOpts` format by
default.
- Refactor of `nvim-cmp` and completion related modules
- Remove `autocomplete.type` in favor of per-plugin enable options such as
[](#opt-vim.autocomplete.nvim-cmp.enable).
{option}`vim.autocomplete.nvim-cmp.enable`.
- Deprecate legacy Vimsnip in favor of Luasnip, and integrate
friendly-snippets for bundled snippets. [](#opt-vim.snippets.luasnip.enable)
friendly-snippets for bundled snippets. {option}`vim.snippets.luasnip.enable`
can be used to toggle Luasnip.
- Add sorting function options for completion sources under
[](#opt-vim.autocomplete.nvim-cmp.setupOpts.sorting.comparators)
{option}`vim.autocomplete.nvim-cmp.setupOpts.sorting.comparators`
- Add C# support under `vim.languages.csharp`, with support for both
omnisharp-roslyn and csharp-language-server.
@ -297,11 +297,11 @@ The changes are, in no particular order:
Lualine. Only `vim.ui.breadcrumbs.lualine.winbar` is supported for the time
being.
- [](#opt-vim.ui.breadcrumbs.lualine.winbar.enable) has been added to allow
- {option}`vim.ui.breadcrumbs.lualine.winbar.enable` has been added to allow
controlling the default behaviour of the `nvim-navic` component on Lualine,
which used to occupy `winbar.lualine_c` as long as breadcrumbs are enabled.
- `vim.ui.breadcrumbs.alwaysRender` has been renamed to
[](#opt-vim.ui.breadcrumbs.lualine.winbar.alwaysRender) to be conform to the
{option}`vim.ui.breadcrumbs.lualine.winbar.alwaysRender` to be conform to the
new format.
- Add [basedpyright](https://github.com/detachhead/basedpyright) as a Python LSP
@ -310,10 +310,10 @@ The changes are, in no particular order:
- Add [python-lsp-server](https://github.com/python-lsp/python-lsp-server) as an
additional Python LSP server.
- Add [](#opt-vim.options) to set `vim.o` values in in your nvf configuration
- Add {option}`vim.options` to set `vim.o` values in in your nvf configuration
without using additional Lua. See option documentation for more details.
- Add [](#opt-vim.dashboard.dashboard-nvim.setupOpts) to allow user
- Add {option}`vim.dashboard.dashboard-nvim.setupOpts` to allow user
configuration for [dashboard.nvim](https://github.com/nvimdev/dashboard-nvim)
- Update `lualine.nvim` input and add missing themes:
@ -321,7 +321,7 @@ The changes are, in no particular order:
- Adds `ayu`, `gruvbox_dark`, `iceberg`, `moonfly`, `onedark`,
`powerline_dark` and `solarized_light` themes.
- Add [](#opt-vim.spellcheck.extraSpellWords) to allow adding arbitrary
- Add {option}`vim.spellcheck.extraSpellWords` to allow adding arbitrary
spellfiles to Neovim's runtime with ease.
- Add combined nvf configuration (`config.vim`) into the final package's
@ -375,9 +375,9 @@ The changes are, in no particular order:
[nezia1](https://github.com/nezia1):
- Add [biome](https://github.com/biomejs/biome) support for Typescript, CSS and
Svelte. Enable them via [](#opt-vim.languages.ts.format.type),
[](#opt-vim.languages.css.format.type) and
[](#opt-vim.languages.svelte.format.type) respectively.
Svelte. Enable them via {option}`vim.languages.ts.format.type`,
{option}`vim.languages.css.format.type` and
{option}`vim.languages.svelte.format.type` respectively.
- Replace [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt) with
[nixfmt](https://github.com/NixOS/nixfmt) (nixfmt-rfc-style).

16
docs/manual/release-notes/rl-0.8.md
View file

@ -21,7 +21,7 @@
- `vim.useSystemClipboard` has been deprecated as a part of removing most
top-level convenience options, and should instead be configured in the new
module interface. You may set [](#opt-vim.clipboard.registers) appropriately
module interface. You may set {option}`vim.clipboard.registers` appropriately
to configure Neovim to use the system clipboard.
- Changed which-key group used for gitsigns from `<leader>g` to `<leader>h` to
@ -54,16 +54,16 @@
- Add [render-markdown.nvim] under
`languages.markdown.extensions.render-markdown-nvim`.
- Implement [](#opt-vim.git.gitsigns.setupOpts) for user-specified setup table
- Implement {option}`vim.git.gitsigns.setupOpts` for user-specified setup table
in gitsigns configuration.
- [](#opt-vim.options.mouse) no longer compares values to an enum of available
- {option}`vim.options.mouse` no longer compares values to an enum of available
mouse modes. This means you can provide any string without the module system
warning you that it is invalid. Do keep in mind that this value is no longer
checked, so you will be responsible for ensuring its validity.
- Deprecate `vim.enableEditorconfig` in favor of
[](#opt-vim.globals.editorconfig).
{option}`vim.globals.editorconfig`.
- Deprecate rnix-lsp as it has been abandoned and archived upstream.
@ -72,7 +72,7 @@
your Editorconfig configuration, or use an autocommand to set indentation
values for buffers with the Nix filetype.
- Add [](#opt-vim.lsp.lightbulb.autocmd.enable) for manually managing the
- Add {option}`vim.lsp.lightbulb.autocmd.enable` for manually managing the
previously managed lightbulb autocommand.
- A warning will occur if [](#opt-vim.lsp.lightbulb.autocmd.enable) and
`vim.lsp.lightbulb.setupOpts.autocmd.enabled` are both set at the same time.
@ -85,7 +85,7 @@
- Add [yazi.nvim] as a companion plugin for Yazi, the terminal file manager.
- Add [](#opt-vim.autocmds) and [](#opt-vim.augroups) to allow declaring
- Add {option}`vim.autocmds) and [](#opt-vim.augroups` to allow declaring
autocommands via Nix.
- Fix plugin `setupOpts` for yanky.nvim and assert if shada is configured as a
@ -107,7 +107,7 @@
`vim.utility.oil-nvim`.
- Add `vim.diagnostics` to interact with Neovim's diagnostics module. Available
options for `vim.diagnostic.config()` can now be customized through the
[](#opt-vim.diagnostics.config) in nvf.
{option}`vim.diagnostics.config` in nvf.
- Add `vim.clipboard` module for easily managing Neovim clipboard providers and
relevant packages in a simple UI.
@ -209,7 +209,7 @@
- Add [fzf-lua](https://github.com/ibhagwan/fzf-lua) in `vim.fzf-lua`
- Add [rainbow-delimiters](https://github.com/HiPhish/rainbow-delimiters.nvim)
in `vim.visuals.rainbow-delimiters`
- Add options to define highlights under [](#opt-vim.highlight)
- Add options to define highlights under {option}`vim.highlight`
[kaktu5](https://github.com/kaktu5):

4
docs/manual/tips/pure-lua-config.md
View file

@ -36,7 +36,7 @@ manner.
This will add the `nvim` directory, or rather, the _store path_ that will be
realised after your flake gets copied to the Nix store, to Neovim's runtime
directory. You may now create a `lua/myconfig` directory within this nvim
directory, and call it with [](#opt-vim.luaConfigRC).
directory, and call it with {option}`vim.luaConfigRC`.
```nix
{pkgs, ...}: {
@ -90,7 +90,7 @@ vim.keymap.set("n", " ", "<Nop>", { silent = true, remap = false })
vim.g.mapleader = " "
```
The following Nix configuration via [](#opt-vim.luaConfigRC) will allow loading
The following Nix configuration via {option}`vim.luaConfigRC` will allow loading
this
```nix

2
modules/neovim/init/clipboard.nix
View file

@ -15,7 +15,7 @@ in {
clipboard = {
enable = mkEnableOption ''
clipboard management for Neovim. Users may still choose to manage their
clipboard through [](#opt-vim.options) should they wish to avoid using
clipboard through {option}`vim.options` should they wish to avoid using
this module.
'';

2
modules/plugins/treesitter/ts-context/context.nix
View file

@ -62,7 +62,7 @@ in {
default = "outer";
description = ''
Which context lines to discard if
[](#opt-vim.treesitter.context.setupOpts.max_lines) is exceeded.
{option}`vim.treesitter.context.setupOpts.max_lines` is exceeded.
'';
};

2
modules/plugins/utility/telescope/telescope.nix
View file

@ -43,7 +43,7 @@
default = ["${pkgs.fd}/bin/fd"];
description = ''
Command to use for finding files. If using an executable from {env}`PATH` then you must
make sure that the package is available in [](#opt-vim.extraPackages).
make sure that the package is available in {option}`vim.extraPackages`.
'';
};

2
modules/plugins/visuals/fidget-nvim/fidget.nix
View file

@ -180,7 +180,7 @@ in {
overrides = mkOption {
description = ''
Overrides the default configuration for a notification group defined
in [](#opt-vim.visuals.fidget-nvim.setupOpts.notification.configs).
in {option}`vim.visuals.fidget-nvim.setupOpts.notification.configs`.
If any of the fields are null, the value from the default
configuration is used.

2
modules/wrapper/lazy/lazy.nix
View file

@ -121,7 +121,7 @@
description = ''
Lua code to run after plugin is loaded. This will be wrapped in a function.
If [](#opt-vim.lazy.plugins._name_.setupModule) is provided, the setup will be ran before `after`.
If {option}`vim.lazy.plugins._name_.setupModule` is provided, the setup will be ran before `after`.
'';
};

4
modules/wrapper/rc/options.nix
View file

@ -284,9 +284,9 @@ in {
default = "";
defaultText = literalMD ''
By default, this option will **append** paths in
[](#opt-vim.additionalRuntimePaths)
{option}`vim.additionalRuntimePaths`
to the `runtimepath` and enable the experimental Lua module loader
if [](#opt-vim.enableLuaLoader) is set to true.
if {option}`vim.enableLuaLoader` is set to true.
'';
example = literalExpression "\${builtins.readFile ./my-lua-config-pre.lua}";