From f27b8b313eecfcd8d64afe1e764f7f637e0cd192 Mon Sep 17 00:00:00 2001 From: folke <292349+folke@users.noreply.github.com> Date: Wed, 22 Oct 2025 12:46:51 +0000 Subject: [PATCH] chore(build): auto-generate docs --- doc/snacks.nvim-picker.txt | 35 +++++++++++++++++++++++++++-------- docs/picker.md | 37 +++++++++++++++++++++++++++---------- 2 files changed, 54 insertions(+), 18 deletions(-) diff --git a/doc/snacks.nvim-picker.txt b/doc/snacks.nvim-picker.txt index fe4a94e0..64aec306 100644 --- a/doc/snacks.nvim-picker.txt +++ b/doc/snacks.nvim-picker.txt @@ -77,6 +77,7 @@ Table of Contents *snacks.nvim-picker-table-of-contents* - select |snacks.nvim-picker-sources-select| - smart |snacks.nvim-picker-sources-smart| - spelling |snacks.nvim-picker-sources-spelling| + - tags |snacks.nvim-picker-sources-tags| - treesitter |snacks.nvim-picker-sources-treesitter| - undo |snacks.nvim-picker-sources-undo| - zoxide |snacks.nvim-picker-sources-zoxide| @@ -836,6 +837,14 @@ TROUBLE *snacks.nvim-picker-examples-trouble* ---@field expr string < +>lua + ---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} +< + +>lua + ---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} +< + >lua ---@alias snacks.picker.format.resolve fun(max_width:number):snacks.picker.Highlight[] ---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string} @@ -917,14 +926,6 @@ that shows a preview based on the item data. ---@field preview? snacks.win.Config|{} preview window config < ->lua - ---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} -< - ->lua - ---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} -< - ============================================================================== 7. Module *snacks.nvim-picker-module* @@ -2377,6 +2378,24 @@ SPELLING *snacks.nvim-picker-sources-spelling* < +TAGS *snacks.nvim-picker-sources-tags* + +>vim + :lua Snacks.picker.tags(opts?) +< + +Search tags file + +>lua + ---@class snacks.picker.tags.Config: snacks.picker.Config + { + workspace = true, -- search tags in the workspace + finder = "vim_tags", + format = "lsp_symbol", + } +< + + TREESITTER *snacks.nvim-picker-sources-treesitter* >vim diff --git a/docs/picker.md b/docs/picker.md index 7ff37e33..fdef0fbf 100644 --- a/docs/picker.md +++ b/docs/picker.md @@ -639,6 +639,14 @@ Snacks.picker.pick({source = "files", ...}) ---@field expr string ``` +```lua +---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} +``` + +```lua +---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} +``` + ```lua ---@alias snacks.picker.format.resolve fun(max_width:number):snacks.picker.Highlight[] ---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string} @@ -720,14 +728,6 @@ It's a previewer that shows a preview based on the item data. ---@field preview? snacks.win.Config|{} preview window config ``` -```lua ----@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} -``` - -```lua ----@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} -``` - ## 📦 Module ```lua @@ -2114,6 +2114,23 @@ Not meant to be used directly. } ``` +### `tags` + +```vim +:lua Snacks.picker.tags(opts?) +``` + +Search tags file + +```lua +---@class snacks.picker.tags.Config: snacks.picker.Config +{ + workspace = true, -- search tags in the workspace + finder = "vim_tags", + format = "lsp_symbol", +} +``` + ### `treesitter` ```vim @@ -2838,8 +2855,6 @@ Snacks.picker.actions.toggle_preview(picker) Snacks.picker.actions.yank(picker, item, action) ``` - - ## 📦 `snacks.picker.core.picker` ```lua @@ -3094,3 +3109,5 @@ Get the word under the cursor or the current visual selection ```lua picker:word() ``` + +