little Mini bundle module

[wroyca]

I made a little Mini bundle module from it initial init.lua:

--- *mini.nvim* Collection of minimal, independent and fast Lua modules
---
--- MIT License Copyright (c) 2021 Evgeni Chasnovski
---
--- ==============================================================================
---
--- |mini.nvim| is a collection of minimal, independent, and fast Lua modules
--- dedicated to improve Neovim (version 0.7 and higher) experience. Each
--- module can be considered as a separate sub-plugin.
---
--- Table of contents:
---   General overview ............................................... |mini.nvim|
---   Disabling recepies ........................... |mini.nvim-disabling-recipes|
---   Buffer-local config ........................ |mini.nvim-buffer-local-config|
---   Plugin colorschemes ................................... |mini-color-schemes|
---   Extend and create a/i textobjects ................................ |mini.ai|
---   Align text interactively ...................................... |mini.align|
---   Animate common Neovim actions ............................... |mini.animate|
---   Base16 colorscheme creation .................................. |mini.base16|
---   Common configuration presets ................................. |mini.basics|
---   Go forward/backward with square brackets .................. |mini.bracketed|
---   Remove buffers ............................................ |mini.bufremove|
---   Show next key clues ............................................ |mini.clue|
---   Tweak and save any color scheme .............................. |mini.colors|
---   Comment lines ............................................... |mini.comment|
---   Completion and signature help ............................ |mini.completion|
---   Autohighlight word under cursor .......................... |mini.cursorword|
---   Plugin manager ................................................. |mini.deps|
---   Work with diff hunks ........................................... |mini.diff|
---   Generate Neovim help files ...................................... |mini.doc|
---   Extra 'mini.nvim' functionality ............................... |mini.extra|
---   Navigate and manipulate file system............................ |mini.files|
---   Fuzzy matching ................................................ |mini.fuzzy|
---   Highlight patterns in text ............................... |mini.hipatterns|
---   Generate configurable color scheme ............................. |mini.hues|
---   Visualize and work with indent scope .................... |mini.indentscope|
---   Jump to next/previous single character ......................... |mini.jump|
---   Jump within visible lines .................................... |mini.jump2d|
---   Window with buffer text overview ................................ |mini.map|
---   Miscellaneous functions ........................................ |mini.misc|
---   Move any selection in any direction ............................ |mini.move|
---   Show notifications ........................................... |mini.notify|
---   Text edit operators ....................................... |mini.operators|
---   Autopairs ..................................................... |mini.pairs|
---   Pick anything .................................................. |mini.pick|
---   Session management ......................................... |mini.sessions|
---   Split and join arguments .................................. |mini.splitjoin|
---   Start screen ................................................ |mini.starter|
---   Statusline ............................................... |mini.statusline|
---   Surround actions ........................................... |mini.surround|
---   Tabline ..................................................... |mini.tabline|
---   Test Neovim plugins ............................................ |mini.test|
---   Trailspace (highlight and remove)......................... |mini.trailspace|
---   Track and reuse file system visits ........................... |mini.visits|
---
--- # General principles ~
---
--- - <Design>. Each module is designed to solve a particular problem targeting
---   balance between feature-richness (handling as many edge-cases as
---   possible) and simplicity of implementation/support. Granted, not all of
---   them ended up with the same balance, but it is the goal nevertheless.
---
--- - <Independence>. Modules are independent of each other and can be run
---   without external dependencies. Although some of them may need
---   dependencies for full experience.
---
--- - <Structure>. Each module is a submodule for a placeholder "mini" module. So,
---   for example, "surround" module should be referred to as "mini.surround".
---   As later will be explained, this plugin can also be referred to
---   as "MiniSurround".
---
--- - <Setup>:
---     - Each module (if needed) should be setup separately with
---       `require(<name of module>).setup({})`
---       (possibly replace {} with your config table or omit to use defaults).
---       You can supply only values which differ from defaults, which will be
---       used for the rest ones.
---
---     - Call to module's `setup()` always creates a global Lua object with
---       coherent camel-case name: `require('mini.surround').setup()` creates
---       `_G.MiniSurround`. This allows for a simpler usage of plugin
---       functionality: instead of `require('mini.surround')` use
---       `MiniSurround` (or manually `:lua MiniSurround.*` in command line);
---       available from `v:lua` like `v:lua.MiniSurround`. Considering this,
---       "module" and "Lua object" names can be used interchangeably:
---       'mini.surround' and 'MiniSurround' will mean the same thing.
---
---     - Each supplied `config` table (after extending with default values) is
---       stored in `config` field of global object. Like `MiniSurround.config`.
---
---     - Values of `config`, which affect runtime activity, can be changed on
---       the fly to have effect. For example, `MiniSurround.config.n_lines`
---       can be changed during runtime; but changing
---       `MiniSurround.config.mappings` won't have any effect (as mappings are
---       created once during `setup()`).
---
--- - <Buffer local configuration>. Each module can be additionally configured
---   to use certain runtime config settings locally to buffer. See
---   |mini.nvim-buffer-local-config| for more information.
---
--- - <Disabling>. Each module's core functionality can be disabled globally or
---   locally to buffer. See "Disabling" section in module's help page for more
---   details. See |mini.nvim-disabling-recipes| for common recipes.
---
--- - <Silencing>. Each module can be configured to not show non-error feedback
---   globally or locally to buffer. See "Silencing" section in module's help page
---   for more details.
---
--- - <Highlight groups>. Appearance of module's output is controlled by
---   certain highlight group (see |highlight-groups|). To customize them, use
---   |highlight| command. Note: currently not many Neovim themes support this
---   plugin's highlight groups; fixing this situation is highly appreciated.
---   To see a more calibrated look, use |MiniBase16| or plugin's colorschemes.
---
--- - <Stability>. Each module upon release is considered to be relatively
---   stable: both in terms of setup and functionality. Any
---   non-bugfix backward-incompatible change will be released gradually as
---   much as possible.
---
--- # List of modules ~
---
--- - |MiniAi| - extend and create `a`/`i` textobjects (like in `di(` or
---   `va"`). It enhances some builtin |text-objects| (like |a(|, |a)|, |a'|,
---   and more), creates new ones (like `a*`, `a<Space>`, `af`, `a?`, and
---   more), and allows user to create their own (like based on treesitter, and
---   more). Supports dot-repeat, `v:count`, different search methods,
---   consecutive application, and customization via Lua patterns or functions.
---   Has builtins for brackets, quotes, function call, argument, tag, user
---   prompt, and any punctuation/digit/whitespace character.
---
--- - |MiniAlign| - align text interactively (with or without instant preview).
---   Allows rich and flexible customization of both alignment rules and user
---   interaction. Works with charwise, linewise, and blockwise selections in
---   both Normal mode (on textobject/motion; with dot-repeat) and Visual mode.
---
--- - |MiniAnimate| - animate common Neovim actions. Has "works out of the box"
---   builtin animations for cursor movement, scroll, resize, window open and
---   close. All of them can be customized and enabled/disabled independently.
---
--- - |MiniBase16| - fast implementation of base16 theme for manually supplied
---   palette. Supports 30+ plugin integrations. Has unique palette generator
---   which needs only background and foreground colors.
---
--- - |MiniBasics| - common configuration presets. Has configurable presets for
---   options, mappings, and autocommands. It doesn't change option or mapping
---   if it was manually created.
---
--- - |MiniBracketed| - go forward/backward with square brackets. Among others,
---   supports variety of non-trivial targets: comments, files on disk, indent
---   changes, tree-sitter nodes, linear undo states, yank history entries.
---
--- - |MiniBufremove| - buffer removing (unshow, delete, wipeout) while saving
---   window layout.
---
--- - |MiniClue| - show next key clues. Implements custom key query process with
---   customizable opt-in triggers, next key descriptions (clues), hydra-like
---   submodes, window delay/config. Provides clue sets for some built-in
---   concepts: `g`/`z` keys, window commands, etc.
---
--- - |MiniColors| - tweak and save any color scheme. Can create colorscheme
---   object with methods to invert/set/modify/etc.
---   lightness/saturation/hue/temperature/etc. of foreground/background/all
---   colors, infer cterm attributes, add transparency, save to a file and more.
---   Has functionality for interactive experiments and animation of
---   transition between color schemes.
---
--- - |MiniComment| - fast and familiar per-line code commenting.
---
--- - |MiniCompletion| - async (with customizable 'debounce' delay) 'two-stage
---   chain completion': first builtin LSP, then configurable fallback. Also
---   has functionality for completion item info and function signature (both
---   in floating window appearing after customizable delay).
---
--- - |MiniCursorword| - automatic highlighting of word under cursor (displayed
---   after customizable delay). Current word under cursor can be highlighted
---   differently.
---
--- - |MiniDeps| - plugin manager for plugins outside of 'mini.nvim'. Uses Git and
---   built-in packages to install, update, clean, and snapshot plugins.
---
--- - |MiniDiff| - visualize difference between buffer text and its reference
---   interactively (with colored signs or line numbers). Uses Git index as
---   default reference. Provides toggleable overview in text area, built-in
---   apply/reset/textobject/goto mappings.
---
--- - |MiniDoc| - generation of help files from EmmyLua-like annotations.
---   Allows flexible customization of output via hook functions. Used for
---   documenting this plugin.
---
--- - |MiniExtra| - extra 'mini.nvim' functionality. Contains 'mini.pick' pickers,
---   'mini.ai' textobjects, and more.
---
--- - |MiniFiles| - navigate and manipulate file system. A file explorer with
---   column view capable of manipulating file system by editing text. Can
---   create/delete/rename/copy/move files/directories inside and across
---   directories.
---
--- - |MiniFuzzy| - functions for fast and simple fuzzy matching. It has
---   not only functions to perform fuzzy matching of one string to others, but
---   also a sorter for |telescope.nvim|.
---
--- - |MiniHipatterns| - highlight patterns in text with configurable highlighters
---   (pattern and/or highlight group can be string or callable).
---   Works asynchronously with configurable debounce delay.
---
--- - |MiniHues| - generate configurable color scheme. Takes only background
---   and foreground colors as required arguments. Can adjust number of hues
---   for non-base colors, saturation, accent color, plugin integration.
---
--- - |MiniIndentscope| - Visualize and operate on indent scope. Supports
---   customization of debounce delay, animation style, and different
---   granularity of options for scope computing algorithm.
---
--- - |MiniJump| - minimal and fast module for smarter jumping to a single
---   character.
---
--- - |MiniJump2d| - minimal and fast Lua plugin for jumping (moving cursor)
---   within visible lines via iterative label filtering. Supports custom jump
---   targets (spots), labels, hooks, allowed windows and lines, and more.
---
--- - |MiniMap| - window with buffer text overview, scrollbar, and highlights.
---   Allows configurable symbols for line encode and scrollbar, extensible
---   highlight integration (with pre-built ones for builtin search, diagnostic,
---   git line status), window properties, and more.
---
--- - |MiniMisc| - collection of miscellaneous useful functions. Like `put()`
---   and `put_text()` which print Lua objects to command line and current
---   buffer respectively.
---
--- - |MiniMove| - move any selection in any direction. Supports any Visual
---   mode (charwise, linewise, blockwise) and Normal mode (current line) for
---   all four directions (left, right, down, up). Respects `count` and undo.
---
--- - |MiniNotify| - show one or more highlighted notifications in a single window.
---   Provides both low-level functions (add, update, remove, clear) and maker
---   of |vim.notify()| implementation. Sets up automated LSP progress updates.
---
--- - |MiniOperators| - various text edit operators: replace, exchange,
---   multiply, sort, evaluate. Creates mappings to operate on textobject,
---   line, and visual selection. Supports |[count]| and dot-repeat.
---
--- - |MiniPairs| - autopairs plugin which has minimal defaults and
---   functionality to do per-key expression mappings.
---
--- - |MiniPick| - general purpose interactive non-blocking picker with
---   toggleable preview. Has fast default matching with fuzzy/exact/grouped
---   modes. Provides most used built-in pickers for files, pattern matches,
---   buffers, etc.
---
--- - |MiniSessions| - session management (read, write, delete) which works
---   using |mksession|. Implements both global (from configured directory) and
---   local (from current directory) sessions.
---
--- - |MiniSplitjoin| - split and join arguments (regions inside brackets
---   between allowed separators). Has customizable pre and post hooks.
---   Works inside comments.
---
--- - |MiniStarter| - minimal, fast, and flexible start screen. Displayed items
---   are fully customizable both in terms of what they do and how they look
---   (with reasonable defaults). Item selection can be done using prefix query
---   with instant visual feedback.
---
--- - |MiniStatusline| - minimal and fast statusline. Has ability to use custom
---   content supplied with concise function (using module's provided section
---   functions) along with builtin default. For full experience needs [Nerd
---   font](https://www.nerdfonts.com/),
---   [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) plugin, and
---   [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
---   plugin (but works without any them).
---
--- - |MiniSurround| - fast and feature-rich surround plugin. Add, delete,
---   replace, find, highlight surrounding (like pair of parenthesis, quotes,
---   etc.). Supports dot-repeat, `v:count`, different search methods,
---   "last"/"next" extended mappings, customization via Lua patterns or
---   functions, and more. Has builtins for brackets, function call, tag, user
---   prompt, and any alphanumeric/punctuation/whitespace character.
---
--- - |MiniTest| - framework for writing extensive Neovim plugin tests.
---   Supports hierarchical tests, hooks, parametrization, filtering (like from
---   current file or cursor position), screen tests, "busted-style" emulation,
---   customizable reporters, and more. Designed to be used with provided
---   wrapper for managing child Neovim processes.
---
--- - |MiniTabline| - minimal tabline which always shows listed (see 'buflisted')
---   buffers. Allows showing extra information section in case of multiple vim
---   tabpages. For full experience needs
---   [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons).
---
--- - |MiniTrailspace| - automatic highlighting of trailing whitespace with
---   functionality to remove it.
---
--- - |MiniVisits| - track and reuse file system visits. Tracks data about each
---   file/directory visit (after delay) and stores it (only) locally. This can be
---   used to get a list of "recent"/"frequent"/"frecent" visits.
---   Allows persistently adding labels to visits enabling flexible workflow.

--- Common recipes for disabling functionality
---
--- Each module's core functionality can be disabled globally or buffer-locally
--- by creating appropriate global or buffer-scoped variables equal to
--- |v:true|. Functionality is disabled if at least one of `g:` or `b:`
--- variables is equal to `v:true`.
---
--- Variable names have the same structure: `{g,b}:mini*_disable` where `*` is
--- module's lowercase name. For example, `g:minicursorword_disable` disables
--- |mini.cursorword| globally and `b:minicursorword_disable` - for
--- corresponding buffer. Note: in this section disabling 'mini.cursorword' is
--- used as example; everything holds for other module variables.
---
--- Considering high number of different scenarios and customization intentions,
--- writing exact rules for disabling module's functionality is left to user.
---
--- # Manual disabling ~
---
--- - Disable globally:
---   Lua       - `:lua vim.g.minicursorword_disable=true`
---   Vimscript - `:let g:minicursorword_disable=v:true`
--- - Disable for current buffer:
---   Lua       - `:lua vim.b.minicursorword_disable=true`
---   Vimscript - `:let b:minicursorword_disable=v:true`
--- - Toggle (disable if enabled, enable if disabled):
---   Globally   - `:lua vim.g.minicursorword_disable = not vim.g.minicursorword_disable`
---   For buffer - `:lua vim.b.minicursorword_disable = not vim.b.minicursorword_disable`
---
--- # Automated disabling ~
---
--- - Disable for a certain |filetype| (for example, "markdown"):
---   `autocmd Filetype markdown lua vim.b.minicursorword_disable = true`
--- - Enable only for certain filetypes (for example, "lua" and "python"):
---   `au FileType * if index(['lua', 'python'], &ft) < 0 | let b:minicursorword_disable=v:true | endif`
--- - Disable in Insert mode (use similar pattern for Terminal mode or indeed
---   any other mode change with |ModeChanged| starting from Neovim 0.7.0):
---   `au InsertEnter * lua vim.b.minicursorword_disable = true`
---   `au InsertLeave * lua vim.b.minicursorword_disable = false`
--- - Disable in Terminal buffer:
---   `au TermOpen * lua vim.b.minicursorword_disable = true`
---@tag mini.nvim-disabling-recipes

--- Buffer local config
---
--- Each module can be additionally configured locally to buffer by creating
--- appropriate buffer-scoped variable with values you want to override. It
--- will affect only runtime options and not those used once during setup (like
--- `mappings` or `set_vim_settings`).
---
--- Variable names have the same structure: `b:mini*_config` where `*` is
--- module's lowercase name. For example, `b:minicursorword_config` can store
--- information about how |mini.cursorword| will act inside current buffer. Its
--- value should be a table with same structure as module's `config`.
--- Continuing example, `vim.b.minicursorword_config = { delay = 500 }` will
--- use delay 500 inside current buffer.
---
--- Considering high number of different scenarios and customization intentions,
--- writing exact rules for module's buffer local configuration is left to
--- user. It is done in similar fashion to |mini.nvim-disabling-recipes|.
---
--- Note: using function values inside buffer variables requires Neovim>=0.7.
---@tag mini.nvim-buffer-local-config

-- Module definition ==========================================================
local Mini = {}
local H = {}

--- Module setup
---
---@param config table|nil Module config table. See |Mini.config|.
---
---@usage `require('mini').setup({})` (replace `{}` with your `config` table)
Mini.setup = function(config)
  -- Export module
  _G.Mini = Mini

  -- Setup config
  config = H.setup_config(config)

  -- Apply config
  H.apply_config(config)

  -- Load (sub)modules
  H.load_modules(config)
end

--- Module config
---
--- Default values:
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
Mini.config = {
  ai          = true,
  align       = true,
  animate     = true,
  base16      = true,
  basics      = true,
  bracketed   = true,
  bufremove   = true,
  clue        = true,
  colors      = true,
  comment     = true,
  completion  = true,
  cursorword  = true,
  deps        = true,
  diff        = true,
  doc         = true,
  extra       = true,
  files       = true,
  fuzzy       = true,
  hipatterns  = true,
  hues        = true,
  indentscope = true,
  jump2d      = true,
  jump        = true,
  map         = true,
  misc        = true,
  move        = true,
  notify      = true,
  operators   = true,
  pairs       = true,
  pick        = true,
  sessions    = true,
  splitjoin   = true,
  starter     = true,
  statusline  = true,
  surround    = true,
  tabline     = true,
  test        = true,
  trailspace  = true,
  visits      = true,
}
--minidoc_afterlines_end

-- Helper data ================================================================
-- Module default config
H.default_config = vim.deepcopy(Mini.config)

-- Helper functionality =======================================================
-- Settings -------------------------------------------------------------------
H.setup_config = function(config)
  -- General idea: if some table elements are not present in user-supplied
  -- `config`, take them from default config
  vim.validate({ config = { config, 'table', true } })
  config = vim.tbl_deep_extend('force', vim.deepcopy(H.default_config), config or {})

  for key, value in pairs(H.default_config) do
    vim.validate({ [key] = { config[key], 'boolean', true } })
  end

  return config
end

H.apply_config = function(config)
  Mini.config = config
end

H.load_modules = function(config)
  if H.is_disabled() then return end

 for module, enabled in pairs(config) do
    if enabled then
      pcall(function()
        require('mini.' .. module).setup()
      end)
    end
  end  

  -- https://github.com/neovim/neovim/issues/26379
  --
  if config.deps then
    local add, now, later = MiniDeps.add, MiniDeps.now, MiniDeps.later
    later(function()
      add({
        source = 'nvim-treesitter/nvim-treesitter',

        -- Use 'master' while monitoring updates in 'main'
        checkout = 'master', monitor = 'main',

        -- Perform action after every checkout
        hooks = { post_checkout = function() vim.cmd('TSUpdate') end },
      })

      require('nvim-treesitter.configs').setup({
        ensure_installed = { 'c', 'lua', 'vim', 'vimdoc', 'query', 'markdown', 'markdown_inline' }
      })
    end)
  end
end

H.is_disabled = function() return vim.g.mini_disable == true or vim.b.mini_disable == true end

H.get_config = function(config)
  return vim.tbl_deep_extend('force', Mini.config, vim.b.mini_config or {}, config or {})
end

return Mini

[echasnovski]

Thanks for sharing!

To be honest, this feels a little bit like an overcomplication, but people have different tastes :)