From 3fd2acb72d3ab4db9894ef6372b34f284a9d8d34 Mon Sep 17 00:00:00 2001 From: folke <292349+folke@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:09:27 +0000 Subject: [PATCH] chore(build): auto-generate docs --- docs/input.md | 6 +++++- docs/picker.md | 38 +++++++++++++++++++------------------- 2 files changed, 24 insertions(+), 20 deletions(-) diff --git a/docs/input.md b/docs/input.md index cae6a6ed..572d2e5e 100644 --- a/docs/input.md +++ b/docs/input.md @@ -94,12 +94,16 @@ docs for more information on how to customize these styles ---@alias snacks.input.Pos "left"|"title"|false ``` +```lua +---@alias snacks.input.Highlight {[1]:number, [2]:number, [3]:string} +``` + ```lua ---@class snacks.input.Opts: snacks.input.Config,{} ---@field prompt? string ---@field default? string ---@field completion? string ----@field highlight? fun() +---@field highlight? fun(text: string): snacks.input.Highlight[] ``` ## 📦 Module diff --git a/docs/picker.md b/docs/picker.md index e4609d3e..7c4e338f 100644 --- a/docs/picker.md +++ b/docs/picker.md @@ -620,6 +620,23 @@ Snacks.picker.pick({source = "files", ...}) ---@field expr string ``` +```lua +---@alias snacks.Picker.ref (fun():snacks.Picker?)|{value?: snacks.Picker} +``` + +```lua +---@class snacks.picker.Last +---@field cursor number +---@field topline number +---@field opts? snacks.picker.Config +---@field selected snacks.picker.Item[] +---@field filter snacks.picker.Filter +``` + +```lua +---@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} +``` + ```lua ---@alias snacks.picker.Extmark vim.api.keyset.set_extmark|{col:number, row?:number, field?:string} ---@alias snacks.picker.Text {[1]:string, [2]:string?, virtual?:boolean, field?:string} @@ -699,23 +716,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 ----@class snacks.picker.Last ----@field cursor number ----@field topline number ----@field opts? snacks.picker.Config ----@field selected snacks.picker.Item[] ----@field filter snacks.picker.Filter -``` - -```lua ----@alias snacks.picker.history.Record {pattern: string, search: string, live?: boolean} -``` - ## 📦 Module ```lua @@ -2748,8 +2748,6 @@ Snacks.picker.actions.toggle_preview(picker) Snacks.picker.actions.yank(picker, item, action) ``` - - ## 📦 `snacks.picker.core.picker` ```lua @@ -3004,3 +3002,5 @@ Get the word under the cursor or the current visual selection ```lua picker:word() ``` + +