mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-07-19 07:31:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: rename vim.highlight => vim.hl

Browse Source 
Problem:
- `vim.highlight` module does not follow `:help dev-name-common`, which
  documents the name for "highlight" as "hl".
- Shorter names are usually preferred.

Solution:
Rename `vim.highlight` to `vim.hl`.

This is not a breaking change until 2.0 (or maybe never).
This commit is contained in:
Justin M. Keyes
2024-10-17 11:16:16 +02:00
parent 960fdc775a
commit 18b43c331d
15 changed files with 53 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
runtime/doc/lua.txt
View File

@@ -636,13 +636,13 @@ A subset of the `vim.*` API is available in threads. This includes:
==============================================================================
VIM.HIGHLIGHT *vim.highlight*
VIM.HL *vim.hl*
vim.highlight.on_yank({opts}) *vim.highlight.on_yank()*
vim.hl.on_yank({opts}) *vim.hl.on_yank()*
Highlight the yanked text during a |TextYankPost| event.
Add the following to your `init.vim`: >vim
autocmd TextYankPost * silent! lua vim.highlight.on_yank {higroup='Visual', timeout=300}
autocmd TextYankPost * silent! lua vim.hl.on_yank {higroup='Visual', timeout=300}
<
Parameters: ~
@@ -655,9 +655,9 @@ vim.highlight.on_yank({opts}) *vim.highlight.on_yank()*
true)
• event event structure (default vim.v.event)
• priority integer priority (default
|vim.highlight.priorities|`.user`)
|vim.hl.priorities|`.user`)
vim.highlight.priorities *vim.highlight.priorities*
vim.hl.priorities *vim.hl.priorities*
Table with default priorities used for highlighting:
• `syntax`: `50`, used for standard syntax highlighting
• `treesitter`: `100`, used for treesitter-based highlighting
@@ -666,8 +666,8 @@ vim.highlight.priorities *vim.highlight.priorities*
• `user`: `200`, used for user-triggered highlights such as LSP document
symbols or `on_yank` autocommands
*vim.highlight.range()*
vim.highlight.range({bufnr}, {ns}, {higroup}, {start}, {finish}, {opts})
*vim.hl.range()*
vim.hl.range({bufnr}, {ns}, {higroup}, {start}, {finish}, {opts})
Apply highlight group to range of text.
Parameters: ~
@@ -684,8 +684,7 @@ vim.highlight.range({bufnr}, {ns}, {higroup}, {start}, {finish}, {opts})
• {inclusive}? (`boolean`, default: `false`) Indicates
whether the range is end-inclusive
• {priority}? (`integer`, default:
`vim.highlight.priorities.user`) Indicates priority of
highlight
`vim.hl.priorities.user`) Highlight priority
==============================================================================