From cd7c18cb6bdc46f311ab6c83a685ba16b9a80fe9 Mon Sep 17 00:00:00 2001 From: Folke Lemaitre Date: Tue, 5 Nov 2024 22:08:57 +0100 Subject: [PATCH] ci: F this. Manually convert the files for now --- doc/snacks.nvim-bigfile.txt | 47 ++++++++ doc/snacks.nvim-bufdelete.txt | 38 ++++++ doc/snacks.nvim-debug.txt | 53 +++++++++ doc/snacks.nvim-git.txt | 42 +++++++ doc/snacks.nvim-gitbrowse.txt | 79 +++++++++++++ doc/snacks.nvim-init.txt | 68 +++++++++++ doc/snacks.nvim-lazygit.txt | 106 +++++++++++++++++ doc/snacks.nvim-notifier.txt | 191 +++++++++++++++++++++++++++++++ doc/snacks.nvim-notify.txt | 74 ++++++++++++ doc/snacks.nvim-quickfile.txt | 41 +++++++ doc/snacks.nvim-rename.txt | 55 +++++++++ doc/snacks.nvim-statuscolumn.txt | 114 ++++++++++++++++++ doc/snacks.nvim-terminal.txt | 96 ++++++++++++++++ doc/snacks.nvim-toggle.txt | 153 +++++++++++++++++++++++++ doc/snacks.nvim-win.txt | 171 +++++++++++++++++++++++++++ doc/snacks.nvim-words.txt | 81 +++++++++++++ scripts/docs | 17 +-- 17 files changed, 1412 insertions(+), 14 deletions(-) create mode 100644 doc/snacks.nvim-bigfile.txt create mode 100644 doc/snacks.nvim-bufdelete.txt create mode 100644 doc/snacks.nvim-debug.txt create mode 100644 doc/snacks.nvim-git.txt create mode 100644 doc/snacks.nvim-gitbrowse.txt create mode 100644 doc/snacks.nvim-init.txt create mode 100644 doc/snacks.nvim-lazygit.txt create mode 100644 doc/snacks.nvim-notifier.txt create mode 100644 doc/snacks.nvim-notify.txt create mode 100644 doc/snacks.nvim-quickfile.txt create mode 100644 doc/snacks.nvim-rename.txt create mode 100644 doc/snacks.nvim-statuscolumn.txt create mode 100644 doc/snacks.nvim-terminal.txt create mode 100644 doc/snacks.nvim-toggle.txt create mode 100644 doc/snacks.nvim-win.txt create mode 100644 doc/snacks.nvim-words.txt diff --git a/doc/snacks.nvim-bigfile.txt b/doc/snacks.nvim-bigfile.txt new file mode 100644 index 00000000..dabed3dd --- /dev/null +++ b/doc/snacks.nvim-bigfile.txt @@ -0,0 +1,47 @@ +*snacks.nvim-bigfile.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-bigfile-table-of-contents* + +1. bigfile |snacks.nvim-bigfile-bigfile| + - Config |snacks.nvim-bigfile-bigfile-config| + - Module |snacks.nvim-bigfile-bigfile-module| + +============================================================================== +1. bigfile *snacks.nvim-bigfile-bigfile* + + +CONFIG *snacks.nvim-bigfile-bigfile-config* + +>lua + ---@class snacks.bigfile.Config + { + size = 1.5 * 1024 * 1024, -- 1.5MB + ---@param ev {buf: number, ft:string} + behave = function(ev) + vim.b.minianimate_disable = true + vim.schedule(function() + vim.bo[ev.buf].syntax = ev.ft + end) + end, + } +< + + +MODULE *snacks.nvim-bigfile-bigfile-module* + +>lua + ---@class snacks.bigfile + Snacks.bigfile = {} +< + + +SNACKS.BIGFILE.SETUP() ~ + +>lua + Snacks.bigfile.setup() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-bufdelete.txt b/doc/snacks.nvim-bufdelete.txt new file mode 100644 index 00000000..b342dd09 --- /dev/null +++ b/doc/snacks.nvim-bufdelete.txt @@ -0,0 +1,38 @@ +*snacks.nvim-bufdelete.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-bufdelete-table-of-contents* + +1. bufdelete |snacks.nvim-bufdelete-bufdelete| + - Module |snacks.nvim-bufdelete-bufdelete-module| + +============================================================================== +1. bufdelete *snacks.nvim-bufdelete-bufdelete* + + +MODULE *snacks.nvim-bufdelete-bufdelete-module* + +>lua + ---@class snacks.bufdelete + Snacks.bufdelete = {} +< + + +SNACKS.BUFDELETE() ~ + +>lua + ---@type fun(buf?: number) + Snacks.bufdelete() +< + + +SNACKS.BUFDELETE.DELETE() ~ + +>lua + ---@param buf number? + Snacks.bufdelete.delete(buf) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-debug.txt b/doc/snacks.nvim-debug.txt new file mode 100644 index 00000000..eb91ccc1 --- /dev/null +++ b/doc/snacks.nvim-debug.txt @@ -0,0 +1,53 @@ +*snacks.nvim-debug.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-debug-table-of-contents* + +1. debug |snacks.nvim-debug-debug| + - Module |snacks.nvim-debug-debug-module| + +============================================================================== +1. debug *snacks.nvim-debug-debug* + + +MODULE *snacks.nvim-debug-debug-module* + +>lua + ---@class snacks.debug + Snacks.debug = {} +< + + +SNACKS.DEBUG() ~ + +>lua + ---@type fun(...) + Snacks.debug() +< + + +SNACKS.DEBUG.BACKTRACE() ~ + +>lua + Snacks.debug.backtrace() +< + + +SNACKS.DEBUG.INSPECT() ~ + +>lua + Snacks.debug.inspect(...) +< + + +SNACKS.DEBUG.PROFILE() ~ + +>lua + ---@param fn fun() + ---@param opts? {count?: number, flush?: boolean} + Snacks.debug.profile(fn, opts) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-git.txt b/doc/snacks.nvim-git.txt new file mode 100644 index 00000000..a347d0a5 --- /dev/null +++ b/doc/snacks.nvim-git.txt @@ -0,0 +1,42 @@ +*snacks.nvim-git.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-git-table-of-contents* + +1. git |snacks.nvim-git-git| + - Module |snacks.nvim-git-git-module| + +============================================================================== +1. git *snacks.nvim-git-git* + + +MODULE *snacks.nvim-git-git-module* + +>lua + ---@class snacks.git + Snacks.git = {} +< + + +SNACKS.GIT.BLAME_LINE() ~ + +Show git log for the current line. + +>lua + ---@param opts? snacks.terminal.Config | {count?: number} + Snacks.git.blame_line(opts) +< + + +SNACKS.GIT.GET_ROOT() ~ + +Gets the git root for a buffer or path. Defaults to the current buffer. + +>lua + ---@param path? number|string buffer or path + Snacks.git.get_root(path) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-gitbrowse.txt b/doc/snacks.nvim-gitbrowse.txt new file mode 100644 index 00000000..1df3b048 --- /dev/null +++ b/doc/snacks.nvim-gitbrowse.txt @@ -0,0 +1,79 @@ +*snacks.nvim-gitbrowse.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-gitbrowse-table-of-contents* + +1. gitbrowse |snacks.nvim-gitbrowse-gitbrowse| + - Config |snacks.nvim-gitbrowse-gitbrowse-config| + - Module |snacks.nvim-gitbrowse-gitbrowse-module| + +============================================================================== +1. gitbrowse *snacks.nvim-gitbrowse-gitbrowse* + + +CONFIG *snacks.nvim-gitbrowse-gitbrowse-config* + +>lua + ---@class snacks.gitbrowse.Config + { + open = function(url) + if vim.fn.has("nvim-0.10") == 0 then + require("lazy.util").open(url, { system = true }) + return + end + vim.ui.open(url) + end, + -- stylua: ignore + patterns = { + { "^(https?://.*)%.git$" , "%1" }, + { "^git@(.+):(.+)%.git$" , "https://%1/%2" }, + { "^git@(.+):(.+)$" , "https://%1/%2" }, + { "^git@(.+)/(.+)$" , "https://%1/%2" }, + { "^ssh://git@(.*)$" , "https://%1" }, + { "^ssh://([^:/]+)(:%d+)/(.*)$" , "https://%1/%3" }, + { "^ssh://([^/]+)/(.*)$" , "https://%1/%2" }, + { "ssh%.dev%.azure%.com/v3/(.*)/(.*)$", "dev.azure.com/%1/_git/%2" }, + { "^https://%w*@(.*)" , "https://%1" }, + { "^git@(.*)" , "https://%1" }, + { ":%d+" , "" }, + { "%.git$" , "" }, + }, + } +< + + +MODULE *snacks.nvim-gitbrowse-gitbrowse-module* + +>lua + ---@class snacks.gitbrowse + Snacks.gitbrowse = {} +< + + +SNACKS.GITBROWSE() ~ + +>lua + ---@type fun(opts?: snacks.gitbrowse.Config) + Snacks.gitbrowse() +< + + +SNACKS.GITBROWSE.GET_URL() ~ + +>lua + ---@param remote string + ---@param opts? snacks.gitbrowse.Config + Snacks.gitbrowse.get_url(remote, opts) +< + + +SNACKS.GITBROWSE.OPEN() ~ + +>lua + ---@param opts? snacks.gitbrowse.Config + Snacks.gitbrowse.open(opts) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-init.txt b/doc/snacks.nvim-init.txt new file mode 100644 index 00000000..a07cedb1 --- /dev/null +++ b/doc/snacks.nvim-init.txt @@ -0,0 +1,68 @@ +*snacks.nvim-init.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-init-table-of-contents* + +1. init |snacks.nvim-init-init| + - Module |snacks.nvim-init-init-module| + +============================================================================== +1. init *snacks.nvim-init-init* + + +MODULE *snacks.nvim-init-init-module* + +>lua + ---@class Snacks + ---@field bigfile snacks.bigfile + ---@field bufdelete snacks.bufdelete + ---@field quickfile snacks.quickfile + ---@field statuscolumn snacks.statuscolumn + ---@field words snacks.words + ---@field rename snacks.rename + ---@field win snacks.win + ---@field terminal snacks.terminal + ---@field lazygit snacks.lazygit + ---@field git snacks.git + ---@field gitbrowse snacks.gitbrowse + ---@field notify snacks.notify + ---@field debug snacks.debug + ---@field toggle snacks.toggle + ---@field notifier snacks.notifier + Snacks = {} +< + + +SNACKS.CONFIG.GET() ~ + +>lua + ---@generic T: table + ---@param snack string + ---@param defaults T + ---@param ... T[] + ---@return T + Snacks.config.get(snack, defaults, ...) +< + + +SNACKS.CONFIG.VIEW() ~ + +Register a new window view config. + +>lua + ---@param name string + ---@param defaults snacks.win.Config + Snacks.config.view(name, defaults) +< + + +SNACKS.SETUP() ~ + +>lua + ---@param opts snacks.Opts? + Snacks.setup(opts) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-lazygit.txt b/doc/snacks.nvim-lazygit.txt new file mode 100644 index 00000000..f6be3492 --- /dev/null +++ b/doc/snacks.nvim-lazygit.txt @@ -0,0 +1,106 @@ +*snacks.nvim-lazygit.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-lazygit-table-of-contents* + +1. lazygit |snacks.nvim-lazygit-lazygit| + - Config |snacks.nvim-lazygit-lazygit-config| + - Types |snacks.nvim-lazygit-lazygit-types| + - Module |snacks.nvim-lazygit-lazygit-module| + +============================================================================== +1. lazygit *snacks.nvim-lazygit-lazygit* + + +CONFIG *snacks.nvim-lazygit-lazygit-config* + +>lua + ---@class snacks.lazygit.Config: snacks.terminal.Config + ---@field args? string[] + ---@field theme? snacks.lazygit.Theme + { + configure = true, + theme_path = vim.fs.normalize(vim.fn.stdpath("cache") .. "/lazygit-theme.yml"), + theme = { + [241] = { fg = "Special" }, + activeBorderColor = { fg = "MatchParen", bold = true }, + cherryPickedCommitBgColor = { fg = "Identifier" }, + cherryPickedCommitFgColor = { fg = "Function" }, + defaultFgColor = { fg = "Normal" }, + inactiveBorderColor = { fg = "FloatBorder" }, + optionsTextColor = { fg = "Function" }, + searchingActiveBorderColor = { fg = "MatchParen", bold = true }, + selectedLineBgColor = { bg = "Visual" }, -- set to `default` to have no background colour + unstagedChangesColor = { fg = "DiagnosticError" }, + }, + win = { + view = "lazygit", + }, + } +< + + +TYPES *snacks.nvim-lazygit-lazygit-types* + +>lua + ---@alias snacks.lazygit.Color {fg?:string, bg?:string, bold?:boolean} +< + +>lua + ---@class snacks.lazygit.Theme: table + ---@field activeBorderColor snacks.lazygit.Color + ---@field cherryPickedCommitBgColor snacks.lazygit.Color + ---@field cherryPickedCommitFgColor snacks.lazygit.Color + ---@field defaultFgColor snacks.lazygit.Color + ---@field inactiveBorderColor snacks.lazygit.Color + ---@field optionsTextColor snacks.lazygit.Color + ---@field searchingActiveBorderColor snacks.lazygit.Color + ---@field selectedLineBgColor snacks.lazygit.Color + ---@field unstagedChangesColor snacks.lazygit.Color +< + + +MODULE *snacks.nvim-lazygit-lazygit-module* + +>lua + ---@class snacks.lazygit + Snacks.lazygit = {} +< + + +SNACKS.LAZYGIT() ~ + +>lua + ---@type fun(opts?: snacks.lazygit.Config): snacks.win + Snacks.lazygit() +< + + +SNACKS.LAZYGIT.LOG() ~ + +>lua + ---@param opts? snacks.lazygit.Config + Snacks.lazygit.log(opts) +< + + +SNACKS.LAZYGIT.LOG_FILE() ~ + +>lua + ---@param opts? snacks.lazygit.Config + Snacks.lazygit.log_file(opts) +< + + +SNACKS.LAZYGIT.OPEN() ~ + +Opens lazygit + +>lua + ---@param opts? snacks.lazygit.Config + Snacks.lazygit.open(opts) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-notifier.txt b/doc/snacks.nvim-notifier.txt new file mode 100644 index 00000000..e2e5524f --- /dev/null +++ b/doc/snacks.nvim-notifier.txt @@ -0,0 +1,191 @@ +*snacks.nvim-notifier.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-notifier-table-of-contents* + +1. notifier |snacks.nvim-notifier-notifier| + - Config |snacks.nvim-notifier-notifier-config| + - Types |snacks.nvim-notifier-notifier-types| + - Module |snacks.nvim-notifier-notifier-module| + +============================================================================== +1. notifier *snacks.nvim-notifier-notifier* + + +CONFIG *snacks.nvim-notifier-notifier-config* + +>lua + ---@class snacks.notifier.Config + ---@field keep? fun(notif: snacks.notifier.Notif): boolean + { + timeout = 3000, + width = { min = 40, max = 0.4 }, + height = { min = 1, max = 0.6 }, + sort = { "level", "added" }, -- sort by level and time + icons = { + error = " ", + warn = " ", + info = " ", + debug = " ", + trace = " ", + }, + ---@type snacks.notifier.style + style = "compact", + } +< + + +TYPES *snacks.nvim-notifier-notifier-types* + +>lua + ---@alias snacks.notifier.hl "title"|"icon"|"border"|"footer"|"msg" +< + +>lua + ---@class snacks.notifier.ctx + ---@field opts snacks.win.Config + ---@field notifier snacks.notifier + ---@field hl table + ---@field ns number +< + +>lua + ---@alias snacks.notifier.render fun(buf: number, notif: snacks.notifier.Notif, ctx: snacks.notifier.ctx) +< + +Render styles: compact: simple border title with message fancy: similar to the +default nvim-notify style + +>lua + ---@alias snacks.notifier.style snacks.notifier.render|"compact"|"fancy" +< + +>lua + ---@class snacks.notifier.Notif.opts + ---@field id? number|string + ---@field msg? string + ---@field level? number|snacks.notifier.level + ---@field title? string + ---@field icon? string + ---@field timeout? number + ---@field once? boolean + ---@field ft? string + ---@field keep? fun(notif: snacks.notifier.Notif): boolean + ---@field style? snacks.notifier.style +< + +>lua + ---@class snacks.notifier.Notif: snacks.notifier.Notif.opts + ---@field msg string + ---@field id number|string + ---@field win? snacks.win + ---@field icon string + ---@field level snacks.notifier.level + ---@field timeout number + ---@field dirty? boolean + ---@field shown? number timestamp in ms + ---@field added number timestamp in ms + ---@field layout? { width: number, height: number, top?: number } +< + + +MODULE *snacks.nvim-notifier-notifier-module* + +>lua + ---@class snacks.notifier + ---@field queue snacks.notifier.Notif[] + ---@field opts snacks.notifier.Config + ---@field dirty boolean + Snacks.notifier = {} +< + + +SNACKS.NOTIFIER.NEW() ~ + +>lua + ---@param opts? snacks.notifier.Config + ---@return snacks.notifier + Snacks.notifier.new(opts) +< + + +NOTIFIER:ADD() ~ + +>lua + ---@param opts snacks.notifier.Notif.opts + notifier:add(opts) +< + + +NOTIFIER:GET_RENDER() ~ + +>lua + ---@param style? snacks.notifier.style + ---@return snacks.notifier.render + notifier:get_render(style) +< + + +NOTIFIER:HIDE() ~ + +>lua + ---@param id? number|string + notifier:hide(id) +< + + +NOTIFIER:INIT() ~ + +>lua + notifier:init() +< + + +NOTIFIER:LAYOUT() ~ + +>lua + notifier:layout() +< + + +NOTIFIER:NOTIFY() ~ + +>lua + ---@param msg string + ---@param level? snacks.notifier.level|number + ---@param opts? snacks.notifier.Notif.opts + notifier:notify(msg, level, opts) +< + + +NOTIFIER:RENDER() ~ + +>lua + ---@param notif snacks.notifier.Notif + notifier:render(notif) +< + + +NOTIFIER:SORT() ~ + +>lua + notifier:sort() +< + + +NOTIFIER:START() ~ + +>lua + notifier:start() +< + + +NOTIFIER:UPDATE() ~ + +>lua + notifier:update() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-notify.txt b/doc/snacks.nvim-notify.txt new file mode 100644 index 00000000..b4d0ec9b --- /dev/null +++ b/doc/snacks.nvim-notify.txt @@ -0,0 +1,74 @@ +*snacks.nvim-notify.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-notify-table-of-contents* + +1. notify |snacks.nvim-notify-notify| + - Types |snacks.nvim-notify-notify-types| + - Module |snacks.nvim-notify-notify-module| + +============================================================================== +1. notify *snacks.nvim-notify-notify* + + +TYPES *snacks.nvim-notify-notify-types* + +>lua + ---@alias snacks.notify.Opts {level?: number, title?: string, once?: boolean, ft?: string} +< + + +MODULE *snacks.nvim-notify-notify-module* + +>lua + ---@class snacks.notify + Snacks.notify = {} +< + + +SNACKS.NOTIFY() ~ + +>lua + ---@type fun(msg: string|string[], opts?: snacks.notify.Opts) + Snacks.notify() +< + + +SNACKS.NOTIFY.ERROR() ~ + +>lua + ---@param msg string|string[] + ---@param opts? snacks.notify.Opts + Snacks.notify.error(msg, opts) +< + + +SNACKS.NOTIFY.INFO() ~ + +>lua + ---@param msg string|string[] + ---@param opts? snacks.notify.Opts + Snacks.notify.info(msg, opts) +< + + +SNACKS.NOTIFY.NOTIFY() ~ + +>lua + ---@param msg string|string[] + ---@param opts? snacks.notify.Opts + Snacks.notify.notify(msg, opts) +< + + +SNACKS.NOTIFY.WARN() ~ + +>lua + ---@param msg string|string[] + ---@param opts? snacks.notify.Opts + Snacks.notify.warn(msg, opts) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-quickfile.txt b/doc/snacks.nvim-quickfile.txt new file mode 100644 index 00000000..27c3047b --- /dev/null +++ b/doc/snacks.nvim-quickfile.txt @@ -0,0 +1,41 @@ +*snacks.nvim-quickfile.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-quickfile-table-of-contents* + +1. quickfile |snacks.nvim-quickfile-quickfile| + - Config |snacks.nvim-quickfile-quickfile-config| + - Module |snacks.nvim-quickfile-quickfile-module| + +============================================================================== +1. quickfile *snacks.nvim-quickfile-quickfile* + + +CONFIG *snacks.nvim-quickfile-quickfile-config* + +>lua + ---@class snacks.quickfile.Config + { + -- any treesitter langs to exclude + exclude = { "latex" }, + } +< + + +MODULE *snacks.nvim-quickfile-quickfile-module* + +>lua + ---@class snacks.quickfile + Snacks.quickfile = {} +< + + +SNACKS.QUICKFILE.SETUP() ~ + +>lua + Snacks.quickfile.setup() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-rename.txt b/doc/snacks.nvim-rename.txt new file mode 100644 index 00000000..722dbcfc --- /dev/null +++ b/doc/snacks.nvim-rename.txt @@ -0,0 +1,55 @@ +*snacks.nvim-rename.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-rename-table-of-contents* + +1. rename |snacks.nvim-rename-rename| + - Module |snacks.nvim-rename-rename-module| + +============================================================================== +1. rename *snacks.nvim-rename-rename* + + +MODULE *snacks.nvim-rename-rename-module* + +>lua + ---@class snacks.rename + Snacks.rename = {} +< + + +SNACKS.RENAME() ~ + +>lua + ---@type fun() + Snacks.rename() +< + + +SNACKS.RENAME.ON_RENAME() ~ + +>lua + ---@param from string + ---@param to string + ---@param rename? fun() + Snacks.rename.on_rename(from, to, rename) +< + + +SNACKS.RENAME.REALPATH() ~ + +>lua + ---@param path string + Snacks.rename.realpath(path) +< + + +SNACKS.RENAME.RENAME() ~ + +>lua + Snacks.rename.rename() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-statuscolumn.txt b/doc/snacks.nvim-statuscolumn.txt new file mode 100644 index 00000000..818114a7 --- /dev/null +++ b/doc/snacks.nvim-statuscolumn.txt @@ -0,0 +1,114 @@ +*snacks.nvim-statuscolumn.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-statuscolumn-table-of-contents* + +1. statuscolumn |snacks.nvim-statuscolumn-statuscolumn| + - Config |snacks.nvim-statuscolumn-statuscolumn-config| + - Types |snacks.nvim-statuscolumn-statuscolumn-types| + - Module |snacks.nvim-statuscolumn-statuscolumn-module| + +============================================================================== +1. statuscolumn *snacks.nvim-statuscolumn-statuscolumn* + + +CONFIG *snacks.nvim-statuscolumn-statuscolumn-config* + +>lua + ---@class snacks.statuscolumn.Config + { + left = { "mark", "sign" }, + right = { "fold", "git" }, + folds = { + open = false, -- show open fold icons + git_hl = false, -- use Git Signs hl for fold icons + }, + git = { + patterns = { "GitSign", "MiniDiffSign" }, + }, + refresh = 50, -- refresh at most every 50ms + } +< + + +TYPES *snacks.nvim-statuscolumn-statuscolumn-types* + +>lua + ---@alias snacks.statuscolumn.Sign.type "mark"|"sign"|"fold"|"git" + ---@alias snacks.statuscolumn.Sign {name:string, text:string, texthl:string, priority:number, type:snacks.statuscolumn.Sign.type} +< + + +MODULE *snacks.nvim-statuscolumn-statuscolumn-module* + +>lua + ---@class snacks.statuscolumn + Snacks.statuscolumn = {} +< + + +SNACKS.STATUSCOLUMN() ~ + +>lua + ---@type fun(): string + Snacks.statuscolumn() +< + + +SNACKS.STATUSCOLUMN.BUF_SIGNS() ~ + +Returns a list of regular and extmark signs sorted by priority (low to high) + +>lua + ---@return table + ---@param buf number + Snacks.statuscolumn.buf_signs(buf) +< + + +SNACKS.STATUSCOLUMN.GET() ~ + +>lua + Snacks.statuscolumn.get() +< + + +SNACKS.STATUSCOLUMN.ICON() ~ + +>lua + ---@param sign? snacks.statuscolumn.Sign + ---@param len? number + Snacks.statuscolumn.icon(sign, len) +< + + +SNACKS.STATUSCOLUMN.IS_GIT_SIGN() ~ + +>lua + ---@param name string + Snacks.statuscolumn.is_git_sign(name) +< + + +SNACKS.STATUSCOLUMN.LINE_SIGNS() ~ + +Returns a list of regular and extmark signs sorted by priority (high to low) + +>lua + ---@return snacks.statuscolumn.Sign[] + ---@param win number + ---@param buf number + ---@param lnum number + Snacks.statuscolumn.line_signs(win, buf, lnum) +< + + +SNACKS.STATUSCOLUMN.SETUP() ~ + +>lua + Snacks.statuscolumn.setup() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-terminal.txt b/doc/snacks.nvim-terminal.txt new file mode 100644 index 00000000..18f1cbad --- /dev/null +++ b/doc/snacks.nvim-terminal.txt @@ -0,0 +1,96 @@ +*snacks.nvim-terminal.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-terminal-table-of-contents* + +1. terminal |snacks.nvim-terminal-terminal| + - Config |snacks.nvim-terminal-terminal-config| + - Module |snacks.nvim-terminal-terminal-module| + +============================================================================== +1. terminal *snacks.nvim-terminal-terminal* + + +CONFIG *snacks.nvim-terminal-terminal-config* + +>lua + ---@class snacks.terminal.Config + ---@field cwd? string + ---@field env? table + ---@field win? snacks.win.Config + ---@field interactive? boolean + ---@field override? fun(cmd?: string|string[], opts?: snacks.terminal.Config) Use this to use a different terminal implementation + { + win = { + bo = { + filetype = "snacks_terminal", + }, + wo = {}, + keys = { + gf = function(self) + local f = vim.fn.findfile(vim.fn.expand("")) + if f ~= "" then + vim.cmd("close") + vim.cmd("e " .. f) + end + end, + term_normal = { + "", + function(self) + self.esc_timer = self.esc_timer or (vim.uv or vim.loop).new_timer() + if self.esc_timer:is_active() then + self.esc_timer:stop() + vim.cmd("stopinsert") + else + self.esc_timer:start(200, 0, function() end) + return "" + end + end, + mode = "t", + expr = true, + desc = "Double escape to normal mode", + }, + }, + }, + } +< + + +MODULE *snacks.nvim-terminal-terminal-module* + +>lua + ---@class snacks.terminal: snacks.win + ---@field cmd? string | string[] + ---@field opts snacks.terminal.Config + Snacks.terminal = {} +< + + +SNACKS.TERMINAL() ~ + +>lua + ---@type fun(cmd?: string|string[], opts?: snacks.terminal.Config): snacks.terminal + Snacks.terminal() +< + + +SNACKS.TERMINAL.OPEN() ~ + +>lua + ---@param cmd? string | string[] + ---@param opts? snacks.terminal.Config + Snacks.terminal.open(cmd, opts) +< + + +SNACKS.TERMINAL.TOGGLE() ~ + +>lua + ---@param cmd? string | string[] + ---@param opts? snacks.terminal.Config + Snacks.terminal.toggle(cmd, opts) +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-toggle.txt b/doc/snacks.nvim-toggle.txt new file mode 100644 index 00000000..e0c5492e --- /dev/null +++ b/doc/snacks.nvim-toggle.txt @@ -0,0 +1,153 @@ +*snacks.nvim-toggle.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-toggle-table-of-contents* + +1. toggle |snacks.nvim-toggle-toggle| + - Config |snacks.nvim-toggle-toggle-config| + - Types |snacks.nvim-toggle-toggle-types| + - Module |snacks.nvim-toggle-toggle-module| + +============================================================================== +1. toggle *snacks.nvim-toggle-toggle* + + +CONFIG *snacks.nvim-toggle-toggle-config* + +>lua + ---@class snacks.toggle.Config + ---@field icon? string|{ enabled: string, disabled: string } + ---@field color? string|{ enabled: string, disabled: string } + { + map = vim.keymap.set, + which_key = true, + notify = true, + icon = { + enabled = " ", + disabled = " ", + }, + color = { + enabled = "green", + disabled = "yellow", + }, + } +< + + +TYPES *snacks.nvim-toggle-toggle-types* + +>lua + ---@class snacks.toggle.Opts: snacks.toggle.Config + ---@field name string + ---@field get fun():boolean + ---@field set fun(state:boolean) +< + + +MODULE *snacks.nvim-toggle-toggle-module* + +>lua + ---@class snacks.toggle + ---@field opts snacks.toggle.Opts + Snacks.toggle = {} +< + + +SNACKS.TOGGLE() ~ + +>lua + ---@type fun(... :snacks.toggle.Opts): snacks.toggle + Snacks.toggle() +< + + +SNACKS.TOGGLE.DIAGNOSTICS() ~ + +>lua + ---@param opts? snacks.toggle.Config + Snacks.toggle.diagnostics(opts) +< + + +SNACKS.TOGGLE.INLAY_HINTS() ~ + +>lua + ---@param opts? snacks.toggle.Config + Snacks.toggle.inlay_hints(opts) +< + + +SNACKS.TOGGLE.LINE_NUMBER() ~ + +>lua + ---@param opts? snacks.toggle.Config + Snacks.toggle.line_number(opts) +< + + +SNACKS.TOGGLE.NEW() ~ + +>lua + ---@param ... snacks.toggle.Opts + ---@return snacks.toggle + Snacks.toggle.new(...) +< + + +SNACKS.TOGGLE.OPTION() ~ + +>lua + ---@param option string + ---@param opts? snacks.toggle.Config | {on?: unknown, off?: unknown} + Snacks.toggle.option(option, opts) +< + + +SNACKS.TOGGLE.TREESITTER() ~ + +>lua + ---@param opts? snacks.toggle.Config + Snacks.toggle.treesitter(opts) +< + + +TOGGLE:_WK() ~ + +>lua + toggle:_wk(keys, mode) +< + + +TOGGLE:GET() ~ + +>lua + toggle:get() +< + + +TOGGLE:MAP() ~ + +>lua + ---@param keys string + ---@param opts? vim.keymap.set.Opts | { mode: string|string[]} + toggle:map(keys, opts) +< + + +TOGGLE:SET() ~ + +>lua + ---@param state boolean + toggle:set(state) +< + + +TOGGLE:TOGGLE() ~ + +>lua + toggle:toggle() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-win.txt b/doc/snacks.nvim-win.txt new file mode 100644 index 00000000..8d572873 --- /dev/null +++ b/doc/snacks.nvim-win.txt @@ -0,0 +1,171 @@ +*snacks.nvim-win.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-win-table-of-contents* + +1. win |snacks.nvim-win-win| + - Config |snacks.nvim-win-win-config| + - Types |snacks.nvim-win-win-types| + - Module |snacks.nvim-win-win-module| + +============================================================================== +1. win *snacks.nvim-win-win* + + +CONFIG *snacks.nvim-win-win-config* + +>lua + ---@class snacks.win.Config + ---@field view? string merges with config from `Snacks.config.views[view]` + ---@field position? "float"|"bottom"|"top"|"left"|"right" + ---@field buf? number + ---@field file? string + ---@field enter? boolean + ---@field backdrop? number|false + ---@field win? vim.api.keyset.win_config + ---@field wo? vim.wo + ---@field bo? vim.bo + ---@field keys? table + ---@field on_buf? fun(self: snacks.win) + ---@field on_win? fun(self: snacks.win) + { + position = "float", + win = { + relative = "editor", + style = "minimal", + }, + wo = { + winhighlight = "Normal:NormalFloat,NormalNC:NormalFloat", + }, + bo = {}, + keys = { + q = "close", + }, + } +< + + +TYPES *snacks.nvim-win-win-types* + +>lua + ---@class snacks.win.Keys: vim.api.keyset.keymap + ---@field [1]? string + ---@field [2]? string|fun(self: snacks.win): any + ---@field mode? string|string[] +< + + +MODULE *snacks.nvim-win-win-module* + +>lua + ---@class snacks.win + ---@field id number + ---@field buf? number + ---@field win? number + ---@field opts snacks.win.Config + ---@field augroup? number + ---@field backdrop? snacks.win + Snacks.win = {} +< + + +SNACKS.WIN() ~ + +>lua + ---@type fun(opts? :snacks.win.Config): snacks.win + Snacks.win() +< + + +SNACKS.WIN.NEW() ~ + +>lua + ---@param opts? snacks.win.Config | { show?: boolean } + ---@return snacks.win + Snacks.win.new(opts) +< + + +SNACKS.WIN.RESOLVE() ~ + +>lua + ---@param opts? snacks.win.Config + ---@return snacks.win.Config + Snacks.win.resolve(opts) +< + + +WIN:BUF_VALID() ~ + +>lua + win:buf_valid() +< + + +WIN:CLOSE() ~ + +>lua + ---@param opts? { buf: boolean } + win:close(opts) +< + + +WIN:HIDE() ~ + +>lua + win:hide() +< + + +WIN:IS_FLOATING() ~ + +>lua + win:is_floating() +< + + +WIN:SHOW() ~ + +>lua + win:show() +< + + +WIN:SIZE() ~ + +>lua + ---@return { height: number, width: number } + win:size() +< + + +WIN:TOGGLE() ~ + +>lua + win:toggle() +< + + +WIN:UPDATE() ~ + +>lua + win:update() +< + + +WIN:VALID() ~ + +>lua + win:valid() +< + + +WIN:WIN_VALID() ~ + +>lua + win:win_valid() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/doc/snacks.nvim-words.txt b/doc/snacks.nvim-words.txt new file mode 100644 index 00000000..ef74065a --- /dev/null +++ b/doc/snacks.nvim-words.txt @@ -0,0 +1,81 @@ +*snacks.nvim-words.txt* For Neovim Last change: 2024 November 05 + +============================================================================== +Table of Contents *snacks.nvim-words-table-of-contents* + +1. words |snacks.nvim-words-words| + - Config |snacks.nvim-words-words-config| + - Types |snacks.nvim-words-words-types| + - Module |snacks.nvim-words-words-module| + +============================================================================== +1. words *snacks.nvim-words-words* + + +CONFIG *snacks.nvim-words-words-config* + +>lua + ---@class snacks.words.Config + { + enabled = true, + debounce = 200, + } +< + + +TYPES *snacks.nvim-words-words-types* + +>lua + ---@alias LspWord {from:{[1]:number, [2]:number}, to:{[1]:number, [2]:number}} 1-0 indexed +< + + +MODULE *snacks.nvim-words-words-module* + +>lua + ---@class snacks.words + Snacks.words = {} +< + + +SNACKS.WORDS.GET() ~ + +>lua + ---@return LspWord[] words, number? current + Snacks.words.get() +< + + +SNACKS.WORDS.IS_ENABLED() ~ + +>lua + ---@param buf number? + Snacks.words.is_enabled(buf) +< + + +SNACKS.WORDS.JUMP() ~ + +>lua + ---@param count number + ---@param cycle? boolean + Snacks.words.jump(count, cycle) +< + + +SNACKS.WORDS.SETUP() ~ + +>lua + Snacks.words.setup() +< + + +SNACKS.WORDS.UPDATE() ~ + +>lua + Snacks.words.update() +< + +Generated by panvimdoc + +vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/scripts/docs b/scripts/docs index 462a352e..cacb2de8 100755 --- a/scripts/docs +++ b/scripts/docs @@ -4,23 +4,12 @@ nvim -u tests/minit.lua --headless +'lua require("snacks.docs").build()' +qa echo -e "\n\nGenerating Vim Help" -if [ "$GITHUB_ACTIONS" != "true" ]; then +if [ "$GITHUB_ACTIONS" = "true" ]; then exit 0 fi -sudo apt update -sudo apt install -y pandoc - -echo "apt installed" - -PANVIMDOC="$RUNNER_TEMP/panvimdoc" -ME=$GITHUB_WORKSPACE - -echo "me: $ME" -echo "dir: $PANVIMDOC" - -git clone https://github.com/kdheepak/panvimdoc.git "$PANVIMDOC" +PANVIMDOC=~/projects/panvimdoc for f in docs/*.md; do - GITHUB_ACTIONS=false $PANVIMDOC/panvimdoc.sh --project-name "snacks.nvim" --input-file "$f" --vim-version "Neovim" --demojify "true" >"doc/snacks.nvim-$(basename "$f" .md).txt" + $PANVIMDOC/panvimdoc.sh --project-name "snacks.nvim-$(basename "$f" .md)" --input-file "$f" --vim-version "Neovim" --demojify "true" done