feat(mini.nvim): sync to 9101b9e

Author: echasnovski

mini.nvim/CHANGELOG.md

@@ -171,6 +171,8 @@ There are following change types:
 
 - Update `zoom()` to return whether current buffer is zoomed in. By @loichyan, PR #1954.
 
+- Add `log_add()` and related functions (`log_get()`, `log_show()`, `log_clear()`) to work with a special in-memory log array. Useful when debugging Lua code (instead of `print()`).
+
 ## mini.pick {#v0.17.0-mini.pick}
 
 ### Evolve {#v0.17.0-mini.pick-evolve}

mini.nvim/doc/mini-misc.qmd

@@ -18,6 +18,10 @@ Features the following functions:
   Useful in combination with `stat_summary()`.
 
 
+- [MiniMisc.log\_add()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_add\(\)), [MiniMisc.log\_show()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_show\(\)) and other helper functions to work
+  with a special in-memory log array. Useful when debugging Lua code.
+
+
 - [MiniMisc.put()](mini-misc.qmd#minimisc.put) and [MiniMisc.put\_text()](mini-misc.qmd#minimisc.put_text) to pretty print its arguments
   into command line and current buffer respectively.
 
@@ -141,6 +145,110 @@ Compute width of gutter (info column on the left of the window)
 
 ---
 
+### log_add() {#minimisc.log_add .help-syntax-right-anchor}
+
+<p align="center">`MiniMisc.log_add`(<span class="help-syntax-special">{desc}</span>, <span class="help-syntax-special">{state}</span>, <span class="help-syntax-special">{opts}</span>)</p>
+Add an entry to the in-memory log array
+
+Useful when trying to debug a Lua code (like Neovim config or plugin).
+Use this instead of ad-hoc `print()` statements.
+
+Each entry is a table with the following fields:
+
+- <span class="help-syntax-keys">\<desc\></span> `(any)` - entry description. Usually a string describing a place
+  in the code.
+
+- <span class="help-syntax-keys">\<state\></span> `(any)` - data about current state. Usually a table.
+
+- <span class="help-syntax-keys">\<timestamp\></span> `(number)` - a timestamp of when the entry was added. A number of
+  milliseconds since the in-memory log was initiated (after [MiniMisc.setup()](mini-misc.qmd#minimisc.setup)
+  or [MiniMisc.log\_clear()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_clear\(\))). Useful during profiling.
+
+#### Parameters {#minimisc.log_add-parameters}
+
+
+
+<span class="help-syntax-special">{desc}</span> `(any)` Entry description.
+
+<span class="help-syntax-special">{state}</span> `(any)` Data about current state.
+
+<span class="help-syntax-special">{opts}</span> `(table|nil)` Options. Possible fields:
+
+  - <span class="help-syntax-keys">\<deepcopy\></span> - (boolean) Whether to apply [vim.deepcopy](https://neovim.io/doc/user/helptag.html?tag=vim.deepcopy) to the <span class="help-syntax-special">{state}</span>.
+    Usually helpful to record the exact state during code execution and avoid
+    side effects of tables being changed in-place. Default `true`.
+
+#### Usage {#minimisc.log_add-usage}
+
+
+
+  ```lua
+  local t = { a = 1 }
+  MiniMisc.log_add('before', { t = t }) -- Will show `t = { a = 1 }` state
+  t.a = t.a + 1
+  MiniMisc.log_add('after', { t = t })  -- Will show `t = { a = 2 }` state
+
+  -- Use `:lua MiniMisc.log_show()` or `:=MiniMisc.log_get()` to see the log
+  ```
+
+#### See also {#minimisc.log_add-seealso}
+
+
+
+- [MiniMisc.log\_get()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_get\(\)) to get log array
+
+- [MiniMisc.log\_show()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_show\(\)) to show log array in the dedicated buffer
+
+- [MiniMisc.log\_clear()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_clear\(\)) to clear the log array
+
+---
+
+### log_get() {#minimisc.log_get .help-syntax-right-anchor}
+
+<p align="center">`MiniMisc.log_get`()</p>
+Get log array
+
+#### Return {#minimisc.log_get-return}
+
+
+`(table[])` Log array. Returned as is, without [vim.deepcopy()](https://neovim.io/doc/user/helptag.html?tag=vim.deepcopy\(\)).
+
+#### See also {#minimisc.log_get-seealso}
+
+
+
+- [MiniMisc.log\_add()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_add\(\)) to add to the log array
+
+---
+
+### log_show() {#minimisc.log_show .help-syntax-right-anchor}
+
+<p align="center">`MiniMisc.log_show`()</p>
+Show log array in a scratch buffer
+
+#### See also {#minimisc.log_show-seealso}
+
+
+
+- [MiniMisc.log\_add()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_add\(\)) to add to the log array
+
+---
+
+### log_clear() {#minimisc.log_clear .help-syntax-right-anchor}
+
+<p align="center">`MiniMisc.log_clear`()</p>
+Clear log array
+
+This also sets a new starting point for entry timestamps.
+
+#### See also {#minimisc.log_clear-seealso}
+
+
+
+- [MiniMisc.log\_add()](https://neovim.io/doc/user/helptag.html?tag=MiniMisc.log_add\(\)) to add to the log array
+
+---
+
 ### put() {#minimisc.put .help-syntax-right-anchor}
 
 <p align="center">`MiniMisc.put`(<span class="help-syntax-special">{...}</span>)</p>

mini.nvim/readmes/mini-misc.md

@@ -35,6 +35,7 @@ If you want to help this project grow but don't know where to start, check out [
 ## Features
 
 - `bench_time()` executes function several times and timing how long it took.
+- `log_add()` / `log_show()` and other helper functions to work with a special in-memory log array. Useful when debugging Lua code (instead of `print()`).
 - `put()` and `put_text()` print Lua objects in command line and current buffer respectively.
 - `resize_window()` resizes current window to its editable width.
 - `setup_auto_root()` sets up automated change of current directory.