kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-19 02:34:59 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs(editor): add docs for vim.gl, vim.bl, vim.wl, vim.tl

Browse Source
This commit is contained in:
Yi Ming 2024-11-01 15:28:07 +08:00
parent 331a2949c8
commit 74919174cf
3 changed files with 75 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
runtime/doc/lua.txt
View File

@ -1259,6 +1259,43 @@ vim.t *vim.t*
vim.v *vim.v*
|v:| variables.
Invalid or unset key returns `nil`.
*lua-scoped-variables*
Lua variables can be created with the same lifecycle as Vim variables like
|g:|, |b:|, |w:|, and |t:|.
Example: >lua
vim.bl[2].foo = { key = 'value' } -- Set local variable fo buffer 2
vim.print(vim.bl[2].foo) -- "{ key = 'value' }"
vim.print(vim.bl[3].foo) -- "nil"
vim.api.nvim_buf_delete(2, {}) -- Delete buffer 2
vim.print(vim.bl[2].foo) -- "nil"
Note that these variables are stored as Lua data rather than VimScript data,
so they must be evaluated via function calls in VimScript.
Example: >
let b:foo = b:lua_var_foo() " Retrieve the value of `vim.bl.foo`
echo b:foo " {'key': 'value'}
vim.gl *vim.gl*
Global editor Lua variables.
Key with no value returns `nil`.
vim.bl *vim.bl*
Buffer-scoped Lua variables for the current buffer.
Invalid or unset key returns `nil`. Can be indexed with
an integer to access variables for a specific buffer.
vim.w *vim.wl*
Window-scoped Lua variables for the current window.
Invalid or unset key returns `nil`. Can be indexed with
an integer to access variables for a specific window.
vim.tl *vim.tl*
Tabpage-scoped Lua variables for the current tabpage.
Invalid or unset key returns `nil`. Can be indexed with
an integer to access variables for a specific tabpage.
*lua-options*

1
runtime/doc/news.txt
View File

@ -69,6 +69,7 @@ EDITOR
it moves to another help buffer.
• Bells from a |terminal| buffer are now silent by default, unless 'belloff'
option doesn't contain "term" or "all".
• Add |vim.gl|,|vim.bl|,|vim.wl|, |vim.tl| for scoped variables.
EVENTS

37
runtime/lua/vim/_options.lua
View File

@ -90,6 +90,43 @@
--- vim.v *vim.v*
--- |v:| variables.
--- Invalid or unset key returns `nil`.
--- *lua-scoped-variables*
--- Lua variables can be created with the same lifecycle as Vim variables like
--- |g:|, |b:|, |w:|, and |t:|.
---
--- Example: >lua
---
--- vim.bl[2].foo = { key = 'value' } -- Set local variable fo buffer 2
--- vim.print(vim.bl[2].foo) -- "{ key = 'value' }"
--- vim.print(vim.bl[3].foo) -- "nil"
--- vim.api.nvim_buf_delete(2, {}) -- Delete buffer 2
--- vim.print(vim.bl[2].foo) -- "nil"
---
--- Note that these variables are stored as Lua data rather than VimScript data,
--- so they must be evaluated via function calls in VimScript.
---
--- Example: >
--- let b:foo = b:lua_var_foo() " Retrieve the value of `vim.bl.foo`
--- echo b:foo " {'key': 'value'}
---
---vim.gl *vim.gl*
--- Global editor Lua variables.
--- Key with no value returns `nil`.
---
--- vim.bl *vim.bl*
--- Buffer-scoped Lua variables for the current buffer.
--- Invalid or unset key returns `nil`. Can be indexed with
--- an integer to access variables for a specific buffer.
---
--- vim.w *vim.wl*
--- Window-scoped Lua variables for the current window.
--- Invalid or unset key returns `nil`. Can be indexed with
--- an integer to access variables for a specific window.
---
--- vim.tl *vim.tl*
--- Tabpage-scoped Lua variables for the current tabpage.
--- Invalid or unset key returns `nil`. Can be indexed with
--- an integer to access variables for a specific tabpage.
--- </pre>
local api = vim.api