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

Compare commits

base: NotAShelf:ba9ce8bb3a0a0fd8d32740b12dc8cf67c938e0dc
Branches Tags
NotAShelf:main
NotAShelf:gh-pages
NotAShelf:notashelf/push-ysqzsqxwlsml
NotAShelf:v0.8
NotAShelf:notashelf/push-lnklzrqrwnym
NotAShelf:notashelf/push-qzzvtnwpuqmr
NotAShelf:notashelf/push-kxltupyypnpo
NotAShelf:machine-tests
NotAShelf:weekly-plugin-bumps
NotAShelf:feline
NotAShelf:get-edgy
NotAShelf:v0.7
NotAShelf:v0.6
NotAShelf:v0.5
NotAShelf:v0.4
NotAShelf:v0.3
NotAShelf:v0.2
...
compare: NotAShelf:1a053852d21fbf08257dc62d869c81b235fa9113
Branches Tags
NotAShelf:gh-pages
NotAShelf:notashelf/push-ysqzsqxwlsml
NotAShelf:v0.8
NotAShelf:main
NotAShelf:notashelf/push-lnklzrqrwnym
NotAShelf:notashelf/push-qzzvtnwpuqmr
NotAShelf:notashelf/push-kxltupyypnpo
NotAShelf:machine-tests
NotAShelf:weekly-plugin-bumps
NotAShelf:feline
NotAShelf:get-edgy
NotAShelf:v0.7
NotAShelf:v0.6
NotAShelf:v0.5
NotAShelf:v0.4
NotAShelf:v0.3
NotAShelf:v0.2

4 commits
ba9ce8bb3a ... 1a053852d2

Author SHA1 Message Date
Ching Pei Yang
1a053852d2
 		Merge branch 'main' into v0.8 2025-09-13 17:08:53 +02:00
raf
7e74ee604a
 		Merge pull request #1142 from horriblename/fix-nix-opt
Some checks failed
Set up binary cache / cachix (default) (push) Has been cancelled
Details
Set up binary cache / cachix (maximal) (push) Has been cancelled
Details
Set up binary cache / cachix (nix) (push) Has been cancelled
Details
Treewide Checks / Validate flake (push) Has been cancelled
Details
Treewide Checks / Check formatting (push) Has been cancelled
Details
Treewide Checks / Check source tree for typos (push) Has been cancelled
Details
Treewide Checks / Validate documentation builds (push) Has been cancelled
Details
Treewide Checks / Validate hyperlinks in documentation sources (push) Has been cancelled
Details
Treewide Checks / Validate Editorconfig conformance (push) Has been cancelled
Details
Build and deploy documentation / Check latest commit (push) Has been cancelled
Details
Build and deploy documentation / publish (push) Has been cancelled
Details 
languages/nix: fix missing init_options when format enabled
 2025-09-13 17:31:45 +03:00
Ching Pei Yang
d8a4fa62bd
 		docs: reformat autocmds.md 2025-09-13 16:24:49 +02:00
Ching Pei Yang
a37bce1194
 		languages/nix: fix missing init_options when format enabled 2025-09-13 16:20:20 +02:00
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -38,17 +38,17 @@ Autocommands (`autocmd`) trigger actions based on events happening within Neovim
(e.g., saving a file, entering a buffer). Each entry in the list is a submodule
with the following options:
| Option | Type | Default | Description | Example |
| :--------- | :-------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------- |
| `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" ]` |
| Option | Type | Default | Description | Example |
| :--------- | :-------------------- | :------ | :---------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- |
| `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.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"` |
| `once` | `bool` | `false` | If `true`, the autocommand runs only once and then automatically removes itself. | `false` |
| `nested` | `bool` | `false` | If `true`, allows this autocommand to trigger other autocommands. | `false` |
| `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"` |
| `once` | `bool` | `false` | If `true`, the autocommand runs only once and then automatically removes itself. | `false` |
| `nested` | `bool` | `false` | If `true`, allows this autocommand to trigger other autocommands. | `false` |
:::{.warning}