runtime(hlyank): add the hlyank package

closes: #16919
related: #16866

Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Christian Brabandt
2025-03-19 21:55:59 +01:00
parent 51ff18e319
commit 83d74404bb
7 changed files with 78 additions and 11 deletions

View File

@ -4998,6 +4998,8 @@ getregionpos({pos1}, {pos2} [, {opts}]) *getregionpos()*
Can also be used as a |method|: >
getpos('.')->getregionpos(getpos("'a"))
<
For an example, see the highlight-yank plugin |52.6|
Return type: list<list<list<number>>>

View File

@ -8247,6 +8247,7 @@ hlexists() builtin.txt /*hlexists()*
hlget() builtin.txt /*hlget()*
hlsearch-variable eval.txt /*hlsearch-variable*
hlset() builtin.txt /*hlset()*
hlyank-install usr_05.txt /*hlyank-install*
holy-grail index.txt /*holy-grail*
home intro.txt /*home*
home-replace editing.txt /*home-replace*
@ -9411,6 +9412,7 @@ package-doc repeat.txt /*package-doc*
package-documentation repeat.txt /*package-documentation*
package-editorconfig usr_05.txt /*package-editorconfig*
package-helptoc helphelp.txt /*package-helptoc*
package-hlyank usr_05.txt /*package-hlyank*
package-justify usr_25.txt /*package-justify*
package-matchit usr_05.txt /*package-matchit*
package-nohlsearch usr_05.txt /*package-nohlsearch*

View File

@ -1,4 +1,4 @@
*usr_05.txt* For Vim version 9.1. Last change: 2025 Jan 11
*usr_05.txt* For Vim version 9.1. Last change: 2025 Mar 18
VIM USER MANUAL - by Bram Moolenaar
@ -437,7 +437,7 @@ After restarting your Vim, the plugin is active and you can read about it at: >
:h editorconfig.txt
Adding comment package *comment-install* *package-comment*
Adding the comment package *comment-install* *package-comment*
Load the plugin with this command: >
packadd comment
@ -450,7 +450,7 @@ the package loaded. Once the package is loaded, read about it at: >
:h comment.txt
Adding nohlsearch package *nohlsearch-install* *package-nohlsearch*
Adding the nohlsearch package *nohlsearch-install* *package-nohlsearch*
Load the plugin with this command: >
packadd nohlsearch
@ -464,6 +464,29 @@ To disable the effect of the plugin after it has been loaded: >
au! nohlsearch
<
Adding the highlight-yank package *hlyank-install* *package-hlyank*
Load the plugin with this command: >
packadd hlyank
<
This package briefly highlights the affected region of the last |yank|
command. See |52.6| for a simplified implementation using the |getregionpos()|
function.
The plugin understands the following configuration variables (the settings
show the default values).
To specify a different highlighting group, use: >
:let g:hlyank_hlgroup = 'IncSearch'
<
To use a different highlighting duration, use: >
:let g:hlyank_duration = 300
<
To highlight in visual mode, use: >
:let g:hlyank_invisual = v:true
To disable the effect of the plugin after it has been loaded: >
au! hlyank
More information about packages can be found here: |packages|.

View File

@ -1,4 +1,4 @@
*usr_52.txt* For Vim version 9.1. Last change: 2025 Mar 12
*usr_52.txt* For Vim version 9.1. Last change: 2025 Mar 17
VIM USER MANUAL - by Bram Moolenaar
@ -346,11 +346,8 @@ Have a look at the package located at $VIMRUNTIME/pack/dist/opt/comment/
HIGHLIGHT YANK PLUGIN
Here is an example for highlighting the yanked region. It makes use of the
|getregionpos()| function, available since Vim 9.1.0446.
Copy the following example into a new file and place it into your plugin directory
and it will be active next time you start Vim. |add-plugin|: >
Vim comes with the highlight-yank plugin, written in Vim9 script
|hlyank-install|, here is a simplified implementation: >vim
vim9script
@ -375,6 +372,9 @@ and it will be active next time you start Vim. |add-plugin|: >
autocmd TextYankPost * HighlightedYank()
<
For the complete example, have a look into the package located at
`$VIMRUNTIME/pack/dist/opt/hlyank/`
==============================================================================
Next chapter: |usr_90.txt| Installing Vim

View File

@ -1,4 +1,4 @@
*version9.txt* For Vim version 9.1. Last change: 2025 Mar 18
*version9.txt* For Vim version 9.1. Last change: 2025 Mar 19
VIM REFERENCE MANUAL by Bram Moolenaar
@ -41556,7 +41556,8 @@ Support for protected _new() method
*new-other-9.2*
Other new features ~
------------------
The new plugins |comment-install| and |nohlsearch-install| are included.
The new packages |package-comment|, |package-nohlsearch| and |package-hlyank|
are included.
Support for Wayland UI.