adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): include some vim9 script examples in the help

Browse Source 
closes: #14848

Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Christian Brabandt
2024-05-31 14:58:26 +02:00
parent f3dd6f617c
commit bad9577b9a
3 changed files with 45 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
runtime/doc/usr_52.txt
View File

@ -1,4 +1,4 @@
*usr_52.txt* For Vim version 9.1. Last change: 2024 May 16
*usr_52.txt* For Vim version 9.1. Last change: 2024 May 31
VIM USER MANUAL - by Bram Moolenaar
@ -13,6 +13,7 @@ smaller parts.
|52.3| Autoloading without import/export
|52.4| Other mechanisms to use
|52.5| Using a Vim9 script from legacy script
|52.6| Vim9 script examples: comment package, highlight-yank plugin
Next chapter: |usr_90.txt| Installing Vim
Previous chapter: |usr_51.txt| Create a plugin
@ -336,6 +337,46 @@ will have to make sure to use a unique name for these global items. Example: >
call g:NicePluginTest()
==============================================================================
*52.6* Vim9 script examples: comment package, highlight-yank plugin
COMMENT PACKAGE
Vim comes with a comment plugin, written in Vim9 script |comment-install|.
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|: >
vim9script
def HighlightedYank(hlgroup = 'IncSearch', duration = 300, in_visual = true)
if v:event.operator ==? 'y'
if !in_visual && visualmode() != null_string
visualmode(1)
return
endif
var [beg, end] = [getpos("'["), getpos("']")]
var type = v:event.regtype ?? 'v'
var pos = getregionpos(beg, end, {type: type})
var end_offset = (type == 'V' || v:event.inclusive) ? 1 : 0
var m = matchaddpos(hlgroup, pos->mapnew((_, v) => {
var col_beg = v[0][2] + v[0][3]
var col_end = v[1][2] + v[1][3] + end_offset
return [v[0][1], col_beg, col_end - col_beg]
}))
var winid = win_getid()
timer_start(duration, (_) => m->matchdelete(winid))
endif
enddef
autocmd TextYankPost * HighlightedYank()
<
==============================================================================
Next chapter: |usr_90.txt| Installing Vim