*mini.misc* Miscellaneous functions *MiniMisc* MIT License Copyright (c) 2021 Evgeni Chasnovski ============================================================================== Features the following functions: - |MiniMisc.bench_time()| to benchmark function execution time. Useful in combination with `stat_summary()`. - |MiniMisc.put()| and |MiniMisc.put_text()| to pretty print its arguments into command line and current buffer respectively. - |MiniMisc.setup_auto_root()| to set up automated change of current directory. - |MiniMisc.setup_termbg_sync()| to set up terminal background synchronization (removes possible "frame" around current Neovim instance). - |MiniMisc.setup_restore_cursor()| to set up automated restoration of cursor position on file reopen. - |MiniMisc.stat_summary()| to compute summary statistics of numerical array. Useful in combination with `bench_time()`. - |MiniMisc.tbl_head()| and |MiniMisc.tbl_tail()| to return "first" and "last" elements of table. - |MiniMisc.zoom()| to zoom in and out of a buffer, making it full screen in a floating window. - And more. # Setup ~ This module doesn't need setup, but it can be done to improve usability. Setup with `require('mini.misc').setup({})` (replace `{}` with your `config` table). It will create global Lua table `MiniMisc` which you can use for scripting or manually (with `:lua MiniMisc.*`). See |MiniMisc.config| for `config` structure and default values. This module doesn't have runtime options, so using `vim.b.minimisc_config` will have no effect here. ------------------------------------------------------------------------------ *MiniMisc.setup()* `MiniMisc.setup`({config}) Module setup Parameters ~ {config} `(table|nil)` Module config table. See |MiniMisc.config|. Usage ~ >lua require('mini.misc').setup() -- use default config -- OR require('mini.misc').setup({}) -- replace {} with your config table < ------------------------------------------------------------------------------ *MiniMisc.config* `MiniMisc.config` Module config Default values: >lua MiniMisc.config = { -- Array of fields to make global (to be used as independent variables) make_global = { 'put', 'put_text' }, } < ------------------------------------------------------------------------------ *MiniMisc.bench_time()* `MiniMisc.bench_time`({f}, {n}, {...}) Execute `f` several times and time how long it took Parameters ~ {f} `(function)` Function which execution to benchmark. {n} `(number|nil)` Number of times to execute `f(...)`. Default: 1. {...} `(any)` Arguments when calling `f`. Return ~ `(...)` Table with durations (in seconds; up to nanoseconds) and output of (last) function execution. ------------------------------------------------------------------------------ *MiniMisc.get_gutter_width()* `MiniMisc.get_gutter_width`({win_id}) Compute width of gutter (info column on the left of the window) Parameters ~ {win_id} `(number|nil)` Window identifier (see |win_getid()|) for which gutter width is computed. Default: 0 for current. ------------------------------------------------------------------------------ *MiniMisc.put()* `MiniMisc.put`({...}) Print Lua objects in command line Parameters ~ {...} `(any)` Any number of objects to be printed each on separate line. ------------------------------------------------------------------------------ *MiniMisc.put_text()* `MiniMisc.put_text`({...}) Print Lua objects in current buffer Parameters ~ {...} `(any)` Any number of objects to be printed each on separate line. ------------------------------------------------------------------------------ *MiniMisc.resize_window()* `MiniMisc.resize_window`({win_id}, {text_width}) Resize window to have exact number of editable columns Parameters ~ {win_id} `(number|nil)` Window identifier (see |win_getid()|) to be resized. Default: 0 for current. {text_width} `(number|nil)` Number of editable columns resized window will display. Default: first element of 'colorcolumn' or otherwise 'textwidth' (using screen width as its default but not more than 79). ------------------------------------------------------------------------------ *MiniMisc.setup_auto_root()* `MiniMisc.setup_auto_root`({names}, {fallback}) Set up automated change of current directory What it does: - Creates autocommand which on every |BufEnter| event with |MiniMisc.find_root()| finds root directory for current buffer file and sets |current-directory| to it (using |chdir()|). - Resets |autochdir| to `false`. Parameters ~ {names} `(table|function|nil)` Forwarded to |MiniMisc.find_root()|. {fallback} `(function|nil)` Forwarded to |MiniMisc.find_root()|. Usage ~ >lua require('mini.misc').setup() MiniMisc.setup_auto_root() < ------------------------------------------------------------------------------ *MiniMisc.find_root()* `MiniMisc.find_root`({buf_id}, {names}, {fallback}) Find root directory Based on a buffer name (full path to file opened in a buffer) find a root directory. If buffer is not associated with file, returns `nil`. Root directory is a directory containing at least one of pre-defined files. It is searched using |vim.fn.find()| with `upward = true` starting from directory of current buffer file until first occurrence of root file(s). Notes: - Uses directory path caching to speed up computations. This means that no changes in root directory will be detected after directory path was already used in this function. Reload Neovim to account for that. Parameters ~ {buf_id} `(number|nil)` Buffer identifier (see |bufnr()|) to use. Default: 0 for current. {names} `(table|function|nil)` Array of file names or a callable used to identify a root directory. Forwarded to |vim.fs.find()|. Default: `{ '.git', 'Makefile' }`. {fallback} `(function|nil)` Callable fallback to use if no root is found with |vim.fs.find()|. Will be called with a buffer path and should return a valid directory path. ------------------------------------------------------------------------------ *MiniMisc.setup_termbg_sync()* `MiniMisc.setup_termbg_sync`() Set up terminal background synchronization What it does: - Checks if terminal emulator supports OSC 11 control sequence. Stops if not. - Creates |UIEnter| and |ColorScheme| autocommands which change terminal background to have same color as |guibg| of |hl-Normal|. - Creates |UILeave| autocommand which sets terminal background back to the color at the time this function was called first time in current session. - Synchronizes background immediately to allow not depend on loading order. Primary use case is to remove possible "frame" around current Neovim instance which appears if Neovim's |hl-Normal| background color differs from what is used by terminal emulator itself. Make sure to call it only during interactive session in terminal emulator. ------------------------------------------------------------------------------ *MiniMisc.setup_restore_cursor()* `MiniMisc.setup_restore_cursor`({opts}) Restore cursor position on file open When reopening a file this will make sure the cursor is placed back to the position where you left before. This implements |restore-cursor| in a nicer way. File should have a recognized file type (see 'filetype') and be opened in a normal buffer (see 'buftype'). Note: it relies on file mark data stored in 'shadafile' (see |shada-f|). Be sure to enable it. Parameters ~ {opts} `(table|nil)` Options for |MiniMisc.restore_cursor|. Possible fields: -
- (boolean) Center the window after we restored the cursor. Default: `true`. - - Array with file types to be ignored (see 'filetype'). Default: `{ "gitcommit", "gitrebase" }`. Usage ~ >lua require('mini.misc').setup_restore_cursor() < ------------------------------------------------------------------------------ *MiniMisc.stat_summary()* `MiniMisc.stat_summary`({t}) Compute summary statistics of numerical array This might be useful to compute summary of time benchmarking with |MiniMisc.bench_time|. Parameters ~ {t} `(table)` Array (table suitable for `ipairs`) of numbers. Return ~ `(table)` Table with summary values under following keys (may be extended in the future): , , , , (number of elements), (sample standard deviation). ------------------------------------------------------------------------------ *MiniMisc.tbl_head()* `MiniMisc.tbl_head`({t}, {n}) Return "first" elements of table as decided by `pairs` Note: order of elements might vary. Parameters ~ {t} `(table)` Input table. {n} `(number|nil)` Maximum number of first elements. Default: 5. Return ~ `(table)` Table with at most `n` first elements of `t` (with same keys). ------------------------------------------------------------------------------ *MiniMisc.tbl_tail()* `MiniMisc.tbl_tail`({t}, {n}) Return "last" elements of table as decided by `pairs` This function makes two passes through elements of `t`: - First to count number of elements. - Second to construct result. Note: order of elements might vary. Parameters ~ {t} `(table)` Input table. {n} `(number|nil)` Maximum number of last elements. Default: 5. Return ~ `(table)` Table with at most `n` last elements of `t` (with same keys). ------------------------------------------------------------------------------ *MiniMisc.use_nested_comments()* `MiniMisc.use_nested_comments`({buf_id}) Add possibility of nested comment leader This works by parsing 'commentstring' buffer option, extracting non-whitespace comment leader (symbols on the left of commented line), and locally modifying 'comments' option (by prepending `n:`). Does nothing if 'commentstring' is empty or has comment symbols both in front and back (like "/*%s*/"). Nested comment leader added with this function is useful for formatting nested comments. For example, have in Lua "first-level" comments with '--' and "second-level" comments with '----'. With nested comment leader second type can be formatted with `gq` in the same way as first one. Recommended usage is with |autocmd|: >lua local use_nested_comments = function() MiniMisc.use_nested_comments() end vim.api.nvim_create_autocmd('BufEnter', { callback = use_nested_comments }) < Note: for most filetypes 'commentstring' option is added only when buffer with this filetype is entered, so using non-current `buf_id` can not lead to desired effect. Parameters ~ {buf_id} `(number|nil)` Buffer identifier (see |bufnr()|) in which function will operate. Default: 0 for current. ------------------------------------------------------------------------------ *MiniMisc.zoom()* `MiniMisc.zoom`({buf_id}, {config}) Zoom in and out of a buffer, making it full screen in a floating window This function is useful when working with multiple windows but temporarily needing to zoom into one to see more of the code from that buffer. Call it again (without arguments) to zoom out. Parameters ~ {buf_id} `(number|nil)` Buffer identifier (see |bufnr()|) to be zoomed. Default: 0 for current. {config} `(table|nil)` Optional config for window (as for |nvim_open_win()|). vim:tw=78:ts=8:noet:ft=help:norl: