NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-09-09 20:01:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Merge pull request #1138 from ky-bean/autocmd-doc-fix
Some checks are pending
Set up binary cache / cachix (default) (push) Waiting to run
Details
Set up binary cache / cachix (maximal) (push) Waiting to run
Details
Set up binary cache / cachix (nix) (push) Waiting to run
Details
Treewide Checks / Validate flake (push) Waiting to run
Details
Treewide Checks / Check formatting (push) Waiting to run
Details
Treewide Checks / Check source tree for typos (push) Waiting to run
Details
Treewide Checks / Validate documentation builds (push) Waiting to run
Details
Treewide Checks / Validate hyperlinks in documentation sources (push) Waiting to run
Details
Treewide Checks / Validate Editorconfig conformance (push) Waiting to run
Details
Build and deploy documentation / Check latest commit (push) Waiting to run
Details
Build and deploy documentation / publish (push) Blocked by required conditions
Details

Browse source 
docs: fix referenes to erroneous `lib.nvim.types.luaInline`
This commit is contained in:
raf 2025-09-09 08:59:58 +03:00 • committed by GitHub
commit c7944a48a3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/manual/configuring/autocmds.md
View file

@ -43,7 +43,7 @@ with the following options:
| `enable` | `bool` | `true` | Enables or disables this autocommand definition. | `true` |
| `event` | `nullOr (listOf str)` | `null` | **Required.** List of Neovim events that trigger this autocommand (e.g., `BufWritePre`, `FileType`). | `[ "BufWritePre" ]` |
| `pattern` | `nullOr (listOf str)` | `null` | List of file patterns (globs) to match against (e.g., `*.py`, `*`). If `null`, matches all files for the given event. | `[ "*.lua", "*.nix" ]` |
| `callback` | `nullOr luaInline` | `null` | A Lua function to execute when the event triggers. Use `lib.nvim.types.luaInline` or `lib.options.literalExpression "mkLuaInline '''...'''"`. **Cannot be used with `command`.** | `lib.nvim.types.luaInline "function() print('File saved!') end"` |
| `callback` | `nullOr luaInline` | `null` | A Lua function to execute when the event triggers. Use `lib.generators.mkLuaInline`. **Cannot be used with `command`.** | `lib.generators.mkLuaInline "function() print('File saved!') end"` |
| `command` | `nullOr str` | `null` | A Vimscript command to execute when the event triggers. **Cannot be used with `callback`.** | `"echo 'File saved!'"` |
| `group` | `nullOr str` | `null` | The name of an `augroup` (defined in `vim.augroups`) to associate this autocommand with. | `"MyCustomAuGroup"` |
| `desc` | `nullOr str` | `null` | A description for the autocommand (useful for introspection). | `"Format buffer on save"` |
@ -71,7 +71,7 @@ Vimscript) for the same autocommand. Choose one.
pattern = [ "*.lua" ];
group = "UserSetup";
desc = "Notify after saving Lua file";
callback = lib.nvim.types.luaInline ''
callback = lib.generators.mkLuaInline ''
function()
vim.notify("Lua file saved!", vim.log.levels.INFO)
end

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

@ -38,7 +38,7 @@
type = nullOr luaInline;
default = null;
example = literalExpression ''
mkLuaInline '''
lib.generators.mkLuaInline '''
function()
print("Saving a Lua file...")
end