retronvim 0.4.8__py3-none-any.whl

data/nvim/plugins/snacks.nvim/docs/gitbrowse.md

@@ -0,0 +1,126 @@
+# 🍿 gitbrowse
+
+Open the repo of the active file in the browser (e.g., GitHub)
+
+<!-- docgen -->
+
+## 📦 Setup
+
+```lua
+-- lazy.nvim
+{
+  "folke/snacks.nvim",
+  ---@type snacks.Config
+  opts = {
+    gitbrowse = {
+      -- your gitbrowse configuration comes here
+      -- or leave it empty to use the default settings
+      -- refer to the configuration section below
+    }
+  }
+}
+```
+
+## ⚙️ Config
+
+```lua
+---@class snacks.gitbrowse.Config
+---@field url_patterns? table<string, table<string, string|fun(fields:snacks.gitbrowse.Fields):string>>
+{
+  notify = true, -- show notification on open
+  -- Handler to open the url in a browser
+  ---@param url string
+  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,
+  ---@type "repo" | "branch" | "file" | "commit" | "permalink"
+  what = "commit", -- what to open. not all remotes support all types
+  commit = nil, ---@type string?
+  branch = nil, ---@type string?
+  line_start = nil, ---@type number?
+  line_end = nil, ---@type number?
+  -- patterns to transform remotes to an actual URL
+  remote_patterns = {
+    { "^(https?://.*)%.git$"              , "%1" },
+    { "^git@(.+):(.+)%.git$"              , "https://%1/%2" },
+    { "^git@(.+):(.+)$"                   , "https://%1/%2" },
+    { "^git@(.+)/(.+)$"                   , "https://%1/%2" },
+    { "^org%-%d+@(.+):(.+)%.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$"                            , "" },
+  },
+  url_patterns = {
+    ["github%.com"] = {
+      branch = "/tree/{branch}",
+      file = "/blob/{branch}/{file}#L{line_start}-L{line_end}",
+      permalink = "/blob/{commit}/{file}#L{line_start}-L{line_end}",
+      commit = "/commit/{commit}",
+    },
+    ["gitlab%.com"] = {
+      branch = "/-/tree/{branch}",
+      file = "/-/blob/{branch}/{file}#L{line_start}-{line_end}",
+      permalink = "/-/blob/{commit}/{file}#L{line_start}-{line_end}",
+      commit = "/-/commit/{commit}",
+    },
+    ["bitbucket%.org"] = {
+      branch = "/src/{branch}",
+      file = "/src/{branch}/{file}#lines-{line_start}-L{line_end}",
+      permalink = "/src/{commit}/{file}#lines-{line_start}-L{line_end}",
+      commit = "/commits/{commit}",
+    },
+    ["git.sr.ht"] = {
+      branch = "/tree/{branch}",
+      file = "/tree/{branch}/item/{file}",
+      permalink = "/tree/{commit}/item/{file}#L{line_start}",
+      commit = "/commit/{commit}",
+    },
+  },
+}
+```
+
+## 📚 Types
+
+```lua
+---@class snacks.gitbrowse.Fields
+---@field branch? string
+---@field file? string
+---@field line_start? number
+---@field line_end? number
+---@field commit? string
+---@field line_count? number
+```
+
+## 📦 Module
+
+### `Snacks.gitbrowse()`
+
+```lua
+---@type fun(opts?: snacks.gitbrowse.Config)
+Snacks.gitbrowse()
+```
+
+### `Snacks.gitbrowse.get_url()`
+
+```lua
+---@param repo string
+---@param fields snacks.gitbrowse.Fields
+---@param opts? snacks.gitbrowse.Config
+Snacks.gitbrowse.get_url(repo, fields, opts)
+```
+
+### `Snacks.gitbrowse.open()`
+
+```lua
+---@param opts? snacks.gitbrowse.Config
+Snacks.gitbrowse.open(opts)
+```

data/nvim/plugins/snacks.nvim/docs/health.md

@@ -0,0 +1,52 @@
+# 🍿 health
+
+<!-- docgen -->
+
+## 📚 Types
+
+```lua
+---@class snacks.health.Tool
+---@field cmd string|string[]
+---@field version? string|false
+---@field enabled? boolean
+```
+
+```lua
+---@alias snacks.health.Tool.spec (string|snacks.health.Tool)[]|snacks.health.Tool|string
+```
+
+## 📦 Module
+
+```lua
+---@class snacks.health
+---@field ok fun(msg: string)
+---@field warn fun(msg: string)
+---@field error fun(msg: string)
+---@field info fun(msg: string)
+---@field start fun(msg: string)
+Snacks.health = {}
+```
+
+### `Snacks.health.check()`
+
+```lua
+Snacks.health.check()
+```
+
+### `Snacks.health.has_lang()`
+
+Check if the given languages are available in treesitter
+
+```lua
+---@param langs string[]|string
+Snacks.health.has_lang(langs)
+```
+
+### `Snacks.health.have_tool()`
+
+Check if any of the tools are available, with an optional version check
+
+```lua
+---@param tools snacks.health.Tool.spec
+Snacks.health.have_tool(tools)
+```

data/nvim/plugins/snacks.nvim/docs/image.md

@@ -0,0 +1,308 @@
+# 🍿 image
+
+![Image](https://github.com/user-attachments/assets/4e8a686c-bf41-4989-9d74-1641ecf2835f)
+
+## ✨ Features
+
+- Image viewer using the [Kitty Graphics Protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/).
+- open images in a wide range of formats:
+  `pdf`, `png`, `jpg`, `jpeg`, `gif`, `bmp`, `webp`, `tiff`, `heic`, `avif`, `mp4`, `mov`, `avi`, `mkv`, `webm`
+- Supports inline image rendering in:
+  `markdown`, `html`, `norg`, `tsx`, `javascript`, `css`, `vue`, `svelte`, `scss`, `latex`, `typst`
+- LaTex math expressions in `markdown` and `latex` documents
+
+Terminal support:
+
+- [kitty](https://sw.kovidgoyal.net/kitty/)
+- [ghostty](https://ghostty.org/)
+- [wezterm](https://wezfurlong.org/wezterm/)
+  Wezterm has only limited support for the kitty graphics protocol.
+  Inline image rendering is not supported.
+- [tmux](https://github.com/tmux/tmux)
+  Snacks automatically tries to enable `allow-passthrough=on` for tmux,
+  but you may need to enable it manually in your tmux configuration.
+- [zellij](https://github.com/zellij-org/zellij) is **not** supported,
+  since they don't have any support for passthrough
+
+Image will be transferred to the terminal by filename or by sending the image
+date in case `ssh` is detected.
+
+In some cases you may need to force snacks to detect or not detect a certain
+environment. You can do this by setting `SNACKS_${ENV_NAME}` to `true` or `false`.
+
+For example, to force detection of **ghostty** you can set `SNACKS_GHOSTTY=true`.
+
+In order to automatically display the image when opening an image file,
+or to have imaged displayed in supported document formats like `markdown` or `html`,
+you need to enable the `image` plugin in your `snacks` config.
+
+[ImageMagick](https://imagemagick.org/index.php) is required to convert images
+to the supported formats (all except PNG).
+
+In case of issues, make sure to run `:checkhealth snacks`.
+
+<!-- docgen -->
+
+## 📦 Setup
+
+```lua
+-- lazy.nvim
+{
+  "folke/snacks.nvim",
+  ---@type snacks.Config
+  opts = {
+    image = {
+      -- your image configuration comes here
+      -- or leave it empty to use the default settings
+      -- refer to the configuration section below
+    }
+  }
+}
+```
+
+## ⚙️ Config
+
+```lua
+---@class snacks.image.Config
+---@field enabled? boolean enable image viewer
+---@field wo? vim.wo|{} options for windows showing the image
+---@field bo? vim.bo|{} options for the image buffer
+---@field formats? string[]
+--- Resolves a reference to an image with src in a file (currently markdown only).
+--- Return the absolute path or url to the image.
+--- When `nil`, the path is resolved relative to the file.
+---@field resolve? fun(file: string, src: string): string?
+---@field convert? snacks.image.convert.Config
+{
+  formats = {
+    "png",
+    "jpg",
+    "jpeg",
+    "gif",
+    "bmp",
+    "webp",
+    "tiff",
+    "heic",
+    "avif",
+    "mp4",
+    "mov",
+    "avi",
+    "mkv",
+    "webm",
+    "pdf",
+    "icns",
+  },
+  force = false, -- try displaying the image, even if the terminal does not support it
+  doc = {
+    -- enable image viewer for documents
+    -- a treesitter parser must be available for the enabled languages.
+    enabled = true,
+    -- render the image inline in the buffer
+    -- if your env doesn't support unicode placeholders, this will be disabled
+    -- takes precedence over `opts.float` on supported terminals
+    inline = true,
+    -- render the image in a floating window
+    -- only used if `opts.inline` is disabled
+    float = true,
+    max_width = 80,
+    max_height = 40,
+    -- Set to `true`, to conceal the image text when rendering inline.
+    -- (experimental)
+    ---@param lang string tree-sitter language
+    ---@param type snacks.image.Type image type
+    conceal = function(lang, type)
+      -- only conceal math expressions
+      return type == "math"
+    end,
+  },
+  img_dirs = { "img", "images", "assets", "static", "public", "media", "attachments" },
+  -- window options applied to windows displaying image buffers
+  -- an image buffer is a buffer with `filetype=image`
+  wo = {
+    wrap = false,
+    number = false,
+    relativenumber = false,
+    cursorcolumn = false,
+    signcolumn = "no",
+    foldcolumn = "0",
+    list = false,
+    spell = false,
+    statuscolumn = "",
+  },
+  cache = vim.fn.stdpath("cache") .. "/snacks/image",
+  debug = {
+    request = false,
+    convert = false,
+    placement = false,
+  },
+  env = {},
+  -- icons used to show where an inline image is located that is
+  -- rendered below the text.
+  icons = {
+    math = "󰪚 ",
+    chart = "󰄧 ",
+    image = " ",
+  },
+  ---@class snacks.image.convert.Config
+  convert = {
+    notify = false, -- show a notification on error
+    ---@type snacks.image.args
+    mermaid = function()
+      local theme = vim.o.background == "light" and "neutral" or "dark"
+      return { "-i", "{src}", "-o", "{file}", "-b", "transparent", "-t", theme, "-s", "{scale}" }
+    end,
+    ---@type table<string,snacks.image.args>
+    magick = {
+      default = { "{src}[0]", "-scale", "1920x1080>" }, -- default for raster images
+      vector = { "-density", 192, "{src}[{page}]" }, -- used by vector images like svg
+      math = { "-density", 192, "{src}[{page}]", "-trim" },
+      pdf = { "-density", 192, "{src}[{page}]", "-background", "white", "-alpha", "remove", "-trim" },
+    },
+  },
+  math = {
+    enabled = true, -- enable math expression rendering
+    -- in the templates below, `${header}` comes from any section in your document,
+    -- between a start/end header comment. Comment syntax is language-specific.
+    -- * start comment: `// snacks: header start`
+    -- * end comment:   `// snacks: header end`
+    typst = {
+      tpl = [[
+        #set page(width: auto, height: auto, margin: (x: 2pt, y: 2pt))
+        #show math.equation.where(block: false): set text(top-edge: "bounds", bottom-edge: "bounds")
+        #set text(size: 12pt, fill: rgb("${color}"))
+        ${header}
+        ${content}]],
+    },
+    latex = {
+      font_size = "Large", -- see https://www.sascha-frank.com/latex-font-size.html
+      -- for latex documents, the doc packages are included automatically,
+      -- but you can add more packages here. Useful for markdown documents.
+      packages = { "amsmath", "amssymb", "amsfonts", "amscd", "mathtools" },
+      tpl = [[
+        \documentclass[preview,border=0pt,varwidth,12pt]{standalone}
+        \usepackage{${packages}}
+        \begin{document}
+        ${header}
+        { \${font_size} \selectfont
+          \color[HTML]{${color}}
+        ${content}}
+        \end{document}]],
+    },
+  },
+}
+```
+
+## 🎨 Styles
+
+Check the [styles](https://github.com/folke/snacks.nvim/blob/main/docs/styles.md)
+docs for more information on how to customize these styles
+
+### `snacks_image`
+
+```lua
+{
+  relative = "cursor",
+  border = true,
+  focusable = false,
+  backdrop = false,
+  row = 1,
+  col = 1,
+  -- width/height are automatically set by the image size unless specified below
+}
+```
+
+## 📚 Types
+
+```lua
+---@alias snacks.image.Size {width: number, height: number}
+---@alias snacks.image.Pos {[1]: number, [2]: number}
+---@alias snacks.image.Loc snacks.image.Pos|snacks.image.Size|{zindex?: number}
+---@alias snacks.image.Type "image"|"math"|"chart"
+```
+
+```lua
+---@class snacks.image.Env
+---@field name string
+---@field env? table<string, string|true>
+---@field terminal? string
+---@field supported? boolean default: false
+---@field placeholders? boolean default: false
+---@field setup? fun(): boolean?
+---@field transform? fun(data: string): string
+---@field detected? boolean
+---@field remote? boolean this is a remote client, so full transfer of the image data is required
+```
+
+```lua
+---@class snacks.image.Opts
+---@field pos? snacks.image.Pos (row, col) (1,0)-indexed. defaults to the top-left corner
+---@field range? Range4
+---@field conceal? boolean
+---@field inline? boolean render the image inline in the buffer
+---@field width? number
+---@field min_width? number
+---@field max_width? number
+---@field height? number
+---@field min_height? number
+---@field max_height? number
+---@field on_update? fun(placement: snacks.image.Placement)
+---@field on_update_pre? fun(placement: snacks.image.Placement)
+---@field type? snacks.image.Type
+---@field auto_resize? boolean
+```
+
+## 📦 Module
+
+```lua
+---@class snacks.image
+---@field terminal snacks.image.terminal
+---@field image snacks.Image
+---@field placement snacks.image.Placement
+---@field util snacks.image.util
+---@field buf snacks.image.buf
+---@field doc snacks.image.doc
+---@field convert snacks.image.convert
+---@field inline snacks.image.inline
+Snacks.image = {}
+```
+
+### `Snacks.image.hover()`
+
+Show the image at the cursor in a floating window
+
+```lua
+Snacks.image.hover()
+```
+
+### `Snacks.image.langs()`
+
+```lua
+---@return string[]
+Snacks.image.langs()
+```
+
+### `Snacks.image.supports()`
+
+Check if the file format is supported and the terminal supports the kitty graphics protocol
+
+```lua
+---@param file string
+Snacks.image.supports(file)
+```
+
+### `Snacks.image.supports_file()`
+
+Check if the file format is supported
+
+```lua
+---@param file string
+Snacks.image.supports_file(file)
+```
+
+### `Snacks.image.supports_terminal()`
+
+Check if the terminal supports the kitty graphics protocol
+
+```lua
+Snacks.image.supports_terminal()
+```

data/nvim/plugins/snacks.nvim/docs/indent.md

@@ -0,0 +1,141 @@
+# 🍿 indent
+
+Visualize indent guides and scopes based on treesitter or indent.
+
+Similar plugins:
+
+- [indent-blankline.nvim](https://github.com/lukas-reineke/indent-blankline.nvim)
+- [mini.indentscope](https://github.com/nvim-mini/mini.indentscope)
+
+![image](https://github.com/user-attachments/assets/56a99495-05ab-488e-9619-574cb7ff2b7d)
+
+<!-- docgen -->
+
+## 📦 Setup
+
+```lua
+-- lazy.nvim
+{
+  "folke/snacks.nvim",
+  ---@type snacks.Config
+  opts = {
+    indent = {
+      -- your indent configuration comes here
+      -- or leave it empty to use the default settings
+      -- refer to the configuration section below
+    }
+  }
+}
+```
+
+## ⚙️ Config
+
+```lua
+---@class snacks.indent.Config
+---@field enabled? boolean
+{
+  indent = {
+    priority = 1,
+    enabled = true, -- enable indent guides
+    char = "│",
+    only_scope = false, -- only show indent guides of the scope
+    only_current = false, -- only show indent guides in the current window
+    hl = "SnacksIndent", ---@type string|string[] hl groups for indent guides
+    -- can be a list of hl groups to cycle through
+    -- hl = {
+    --     "SnacksIndent1",
+    --     "SnacksIndent2",
+    --     "SnacksIndent3",
+    --     "SnacksIndent4",
+    --     "SnacksIndent5",
+    --     "SnacksIndent6",
+    --     "SnacksIndent7",
+    --     "SnacksIndent8",
+    -- },
+  },
+  -- animate scopes. Enabled by default for Neovim >= 0.10
+  -- Works on older versions but has to trigger redraws during animation.
+  ---@class snacks.indent.animate: snacks.animate.Config
+  ---@field enabled? boolean
+  --- * out: animate outwards from the cursor
+  --- * up: animate upwards from the cursor
+  --- * down: animate downwards from the cursor
+  --- * up_down: animate up or down based on the cursor position
+  ---@field style? "out"|"up_down"|"down"|"up"
+  animate = {
+    enabled = vim.fn.has("nvim-0.10") == 1,
+    style = "out",
+    easing = "linear",
+    duration = {
+      step = 20, -- ms per step
+      total = 500, -- maximum duration
+    },
+  },
+  ---@class snacks.indent.Scope.Config: snacks.scope.Config
+  scope = {
+    enabled = true, -- enable highlighting the current scope
+    priority = 200,
+    char = "│",
+    underline = false, -- underline the start of the scope
+    only_current = false, -- only show scope in the current window
+    hl = "SnacksIndentScope", ---@type string|string[] hl group for scopes
+  },
+  chunk = {
+    -- when enabled, scopes will be rendered as chunks, except for the
+    -- top-level scope which will be rendered as a scope.
+    enabled = false,
+    -- only show chunk scopes in the current window
+    only_current = false,
+    priority = 200,
+    hl = "SnacksIndentChunk", ---@type string|string[] hl group for chunk scopes
+    char = {
+      corner_top = "┌",
+      corner_bottom = "└",
+      -- corner_top = "╭",
+      -- corner_bottom = "╰",
+      horizontal = "─",
+      vertical = "│",
+      arrow = ">",
+    },
+  },
+  -- filter for buffers to enable indent guides
+  ---@param buf number
+  ---@param win number
+  filter = function(buf, win)
+    return vim.g.snacks_indent ~= false and vim.b[buf].snacks_indent ~= false and vim.bo[buf].buftype == ""
+  end,
+}
+```
+
+## 📚 Types
+
+```lua
+---@class snacks.indent.Scope: snacks.scope.Scope
+---@field win number
+---@field step? number
+---@field animate? {from: number, to: number}
+```
+
+## 📦 Module
+
+### `Snacks.indent.debug_win()`
+
+```lua
+Snacks.indent.debug_win()
+```
+
+### `Snacks.indent.disable()`
+
+Disable indent guides
+
+```lua
+Snacks.indent.disable()
+```
+
+### `Snacks.indent.enable()`
+
+Enable indent guides
+
+```lua
+Snacks.indent.enable()
+```