nvim-plugins/nvim-ufo
1
0
Fork 0
mirror of https://github.com/kevinhwang91/nvim-ufo synced 2024-09-16 14:14:02 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix UfoFoldVirtTextHandler type annotations (#95)

Browse source 
* fix(api): UfoExtmarkVirtTextChunk annotation

It is actually a list, not a dictionary.

* fix(api): UfoFoldVirtTextHandler annotation

UfoFoldVirtTextHandler function returns list.

* style(api): end sentence with dot

* fix(api): UfoFoldVirtTextHandlerContext annotaton

Extra line is necessary, to make lsp server not consider separator as
comment to UfoFoldVirtTextHandlerContext class.

* fix(api): UfoExtmarkVirtTextChunk annotaton

`get_fold_virt_text` function returns list of UfoExtmarkVirtTextChunk's.
This commit is contained in:
Yuriy Artemyev 2022-11-13 02:55:45 +03:00 committed by GitHub
parent 5da70eb121
commit dfa4a5b32f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
lua/ufo.lua
View file

@ -141,19 +141,20 @@ function M.setup(opts)
end
---------------------------------------setFoldVirtTextHandler---------------------------------------
---@class UfoFoldVirtTextHandlerContext
---@field bufnr number buffer for closed fold
---@field winid number window for closed fold
---@field text string text for the first line of closed fold
---@field get_fold_virt_text fun(lnum: number) a function to get virtual text by lnum
---@field get_fold_virt_text fun(lnum: number): UfoExtmarkVirtTextChunk[] a function to get virtual text by lnum
---@class UfoExtmarkVirtTextChunk
---@field text string
---@field highlight string|number
---@field [1] string text
---@field [2] string|number highlight
---Set a fold virtual text handler for a buffer, will override global handler if it's existed.
---Ufo actually uses a virtual text with \`nvim_buf_set_extmark\` to overlap the first line of closed fold
---run \`:h nvim_buf_set_extmark | call search('virt_text')\` for detail
---run \`:h nvim_buf_set_extmark | call search('virt_text')\` for detail.
---@diagnostic disable: undefined-doc-param
---Detial for handler function:
---@param virtText UfoExtmarkVirtTextChunk[] contained text and highlight captured by Ufo, export to caller
@ -172,8 +173,8 @@ end
---truncate('1你2好', 7) return '1你2好'
---@param ctx UfoFoldVirtTextHandlerContext the context used by ufo, export to caller
---@alias UfoFoldVirtTextHandler fun(virtText: UfoExtmarkVirtTextChunk[], lnum: number, endLnum: number, width: number, truncate: fun(str: string, width: number), ctx: UfoFoldVirtTextHandlerContext): UfoExtmarkVirtTextChunk
---
---@alias UfoFoldVirtTextHandler fun(virtText: UfoExtmarkVirtTextChunk[], lnum: number, endLnum: number, width: number, truncate: fun(str: string, width: number), ctx: UfoFoldVirtTextHandlerContext): UfoExtmarkVirtTextChunk[]
---@param bufnr number
---@param handler UfoFoldVirtTextHandler
function M.setFoldVirtTextHandler(bufnr, handler)