Initial commit
This commit is contained in:
528
plugin/30_mini.lua
Normal file
528
plugin/30_mini.lua
Normal file
@@ -0,0 +1,528 @@
|
||||
-- ┌────────────────────┐
|
||||
-- │ MINI configuration │
|
||||
-- └────────────────────┘
|
||||
--
|
||||
-- This file contains configuration of the MINI parts of the config.
|
||||
-- It contains only configs for the 'mini.nvim' plugin (installed in 'init.lua').
|
||||
|
||||
local now, later = MiniDeps.now, MiniDeps.later
|
||||
local now_if_args = _G.Config.now_if_args
|
||||
|
||||
-- Common configuration presets. Example usage:
|
||||
-- - `<C-s>` in Insert mode - save and go to Normal mode
|
||||
-- - `go` / `gO` - insert empty line before/after in Normal mode
|
||||
-- - `gy` / `gp` - copy / paste from system clipboard
|
||||
-- - `\` + key - toggle common options. Like `\h` toggles highlighting search.
|
||||
-- - `<C-hjkl>` (four combos) - navigate between windows.
|
||||
-- - `<M-hjkl>` in Insert/Command mode - navigate in that mode.
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniBasics.config.options` - list of adjusted options
|
||||
-- - `:h MiniBasics.config.mappings` - list of created mappings
|
||||
-- - `:h MiniBasics.config.autocommands` - list of created autocommands
|
||||
now(function()
|
||||
require('mini.basics').setup({
|
||||
options = { basic = false },
|
||||
mappings = {
|
||||
-- Create `<C-hjkl>` mappings for window navigation
|
||||
windows = true,
|
||||
-- Create `<M-hjkl>` mappings for navigation in Insert and Command modes
|
||||
move_with_alt = true,
|
||||
},
|
||||
})
|
||||
end)
|
||||
|
||||
-- Icon provider. Usually no need to use manually. It is used by plugins like
|
||||
-- 'mini.pick', 'mini.files', 'mini.statusline', and others.
|
||||
now(function()
|
||||
-- Set up to not prefer extension-based icon for some extensions
|
||||
local ext3_blocklist = { scm = true, txt = true, yml = true }
|
||||
local ext4_blocklist = { json = true, yaml = true }
|
||||
require('mini.icons').setup({
|
||||
use_file_extension = function(ext, _)
|
||||
return not (ext3_blocklist[ext:sub(-3)] or ext4_blocklist[ext:sub(-4)])
|
||||
end,
|
||||
})
|
||||
|
||||
-- Mock 'nvim-tree/nvim-web-devicons' for plugins without 'mini.icons' support.
|
||||
-- Not needed for 'mini.nvim' or MiniMax, but might be useful for others.
|
||||
later(MiniIcons.mock_nvim_web_devicons)
|
||||
|
||||
-- Add LSP kind icons. Useful for 'mini.completion'.
|
||||
later(MiniIcons.tweak_lsp_kind)
|
||||
end)
|
||||
|
||||
-- Miscellaneous small but useful functions. Example usage:
|
||||
-- - `<Leader>oz` - toggle between "zoomed" and regular view of current buffer
|
||||
-- - `<Leader>or` - resize window to its "editable width"
|
||||
-- - `:lua put_text(vim.lsp.get_clients())` - put output of a function below
|
||||
-- cursor in current buffer. Useful for a detailed exploration.
|
||||
-- - `:lua put(MiniMisc.stat_summary(MiniMisc.bench_time(f, 100)))` - run
|
||||
-- function `f` 100 times and report statistical summary of execution times
|
||||
--
|
||||
-- Uses `now()` for `setup_xxx()` to work when started like `nvim -- path/to/file`
|
||||
now(function()
|
||||
-- Makes `:h MiniMisc.put()` and `:h MiniMisc.put_text()` public
|
||||
require('mini.misc').setup()
|
||||
|
||||
-- Change current working directory based on the current file path. It
|
||||
-- searches up the file tree until the first root marker ('.git' or 'Makefile')
|
||||
-- and sets their parent directory as a current directory.
|
||||
-- This is helpful when simultaneously dealing with files from several projects.
|
||||
MiniMisc.setup_auto_root()
|
||||
|
||||
-- Restore latest cursor position on file open
|
||||
MiniMisc.setup_restore_cursor()
|
||||
|
||||
-- Synchronize terminal emulator background with Neovim's background to remove
|
||||
-- possibly different color padding around Neovim instance
|
||||
MiniMisc.setup_termbg_sync()
|
||||
end)
|
||||
|
||||
-- Notifications provider. Shows all kinds of notifications in the upper right
|
||||
-- corner (by default). Example usage:
|
||||
-- - `:h vim.notify()` - show notification (hides automatically)
|
||||
-- - `<Leader>en` - show notification history
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniNotify.config` for some of common configuration examples.
|
||||
now(function() require('mini.notify').setup() end)
|
||||
|
||||
-- Session management. A thin wrapper around `:h mksession` that consistently
|
||||
-- manages session files. Example usage:
|
||||
-- - `<Leader>sn` - start new session
|
||||
-- - `<Leader>sr` - read previously started session
|
||||
-- - `<Leader>sd` - delete previously started session
|
||||
now(function() require('mini.sessions').setup() end)
|
||||
|
||||
-- Start screen. This is what is shown when you open Neovim like `nvim`.
|
||||
-- Example usage:
|
||||
-- - Type prefix keys to limit available candidates
|
||||
-- - Navigate down/up with `<C-n>` and `<C-p>`
|
||||
-- - Press `<CR>` to select an entry
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniStarter-example-config` - non-default config examples
|
||||
-- - `:h MiniStarter-lifecycle` - how to work with Starter buffer
|
||||
now(function() require('mini.starter').setup() end)
|
||||
|
||||
-- Statusline. Sets `:h 'statusline'` to show more info in a line below window.
|
||||
-- See also:
|
||||
-- - `:h MiniStatusline-example-content` - example of default content. Use it to
|
||||
-- configure a custom statusline by setting `config.content.active` function.
|
||||
now(function() require('mini.statusline').setup() end)
|
||||
|
||||
-- Tabline. Sets `:h 'tabline'` to show all listed buffers in a line at the top.
|
||||
-- Buffers are ordered as they were created. Navigate with `[b` and `]b`.
|
||||
now(function() require('mini.tabline').setup() end)
|
||||
|
||||
-- Extra 'mini.nvim' functionality.
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniExtra.pickers` - pickers. Most are mapped in `<Leader>f` group.
|
||||
-- Calling `setup()` makes 'mini.pick' respect 'mini.extra' pickers.
|
||||
-- - `:h MiniExtra.gen_ai_spec` - 'mini.ai' textobject specifications
|
||||
-- - `:h MiniExtra.gen_highlighter` - 'mini.hipatterns' highlighters
|
||||
later(function() require('mini.extra').setup() end)
|
||||
|
||||
-- Extend and create a/i textobjects, like `:h a(`, `:h a'`, and more).
|
||||
-- Contains not only `a` and `i` type of textobjects, but also their "next" and
|
||||
-- "last" variants that will explicitly search for textobjects after and before
|
||||
-- cursor. Example usage:
|
||||
-- - `ci)` - *c*hange *i*inside parenthesis (`)`)
|
||||
-- - `di(` - *d*elete *i*inside padded parenthesis (`(`)
|
||||
-- - `yaq` - *y*ank *a*round *q*uote (any of "", '', or ``)
|
||||
-- - `vif` - *v*isually select *i*inside *f*unction call
|
||||
-- - `cina` - *c*hange *i*nside *n*ext *a*rgument
|
||||
-- - `valaala` - *v*isually select *a*round *l*ast (i.e. previous) *a*rgument
|
||||
-- and then again reselect *a*round new *l*ast *a*rgument
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h text-objects` - general info about what textobjects are
|
||||
-- - `:h MiniAi-builtin-textobjects` - list of all supported textobjects
|
||||
-- - `:h MiniAi-textobject-specification` - examples of custom textobjects
|
||||
later(function()
|
||||
local ai = require('mini.ai')
|
||||
ai.setup({
|
||||
-- 'mini.ai' can be extended with custom textobjects
|
||||
custom_textobjects = {
|
||||
-- Make `aB` / `iB` act on around/inside whole *b*uffer
|
||||
B = MiniExtra.gen_ai_spec.buffer(),
|
||||
-- For more complicated textobjects that require structural awareness,
|
||||
-- use tree-sitter. This example makes `aF`/`iF` mean around/inside function
|
||||
-- definition (not call). See `:h MiniAi.gen_spec.treesitter()` for details.
|
||||
F = ai.gen_spec.treesitter({ a = '@function.outer', i = '@function.inner' }),
|
||||
},
|
||||
|
||||
-- 'mini.ai' by default mostly mimics built-in search behavior: first try
|
||||
-- to find textobject covering cursor, then try to find to the right.
|
||||
-- Although this works in most cases, some are confusing. It is more robust to
|
||||
-- always try to search only covering textobject and explicitly ask to search
|
||||
-- for next (`an`/`in`) or last (`al`/`il`).
|
||||
-- Try this. If you don't like it - delete next line and this comment.
|
||||
search_method = 'cover',
|
||||
})
|
||||
end)
|
||||
|
||||
-- Align text interactively. Example usage:
|
||||
-- - `gaip,` - `ga` (align operator) *i*nside *p*aragraph by comma
|
||||
-- - `gAip` - start interactive alignment on the paragraph. Choose how to
|
||||
-- split, justify, and merge string parts. Press `<CR>` to make it permanent,
|
||||
-- press `<Esc>` to go back to initial state.
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniAlign-example` - hands-on list of examples to practice aligning
|
||||
-- - `:h MiniAlign.gen_step` - list of support step customizations
|
||||
-- - `:h MiniAlign-algorithm` - how alignment is done on algorithmic level
|
||||
later(function() require('mini.align').setup() end)
|
||||
|
||||
-- Remove buffers. Opened files occupy space in tabline and buffer picker.
|
||||
-- When not needed, they can be removed. Example usage:
|
||||
-- - `<Leader>bw` - completely wipeout current buffer (see `:h :bwipeout`)
|
||||
-- - `<Leader>bW` - completely wipeout current buffer even if it has changes
|
||||
-- - `<Leader>bd` - delete current buffer (see `:h :bdelete`)
|
||||
later(function() require('mini.bufremove').setup() end)
|
||||
|
||||
-- Show next key clues in a bottom right window. Requires explicit opt-in for
|
||||
-- keys that act as clue trigger.
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniClue-examples` - examples of common setups
|
||||
-- - `:h MiniClue.ensure_buf_triggers()` - use it to enable triggers in buffer
|
||||
-- - `:h MiniClue.set_mapping_desc()` - change mapping description not from config
|
||||
later(function()
|
||||
local miniclue = require('mini.clue')
|
||||
-- stylua: ignore
|
||||
miniclue.setup({
|
||||
-- Define which clues to show. By default shows only clues for custom mappings
|
||||
-- (uses `desc` field from the mapping; takes precedence over custom clue).
|
||||
clues = {
|
||||
-- This is defined in 'plugin/20_keymaps.lua' with Leader group descriptions
|
||||
Config.leader_group_clues,
|
||||
miniclue.gen_clues.builtin_completion(),
|
||||
miniclue.gen_clues.g(),
|
||||
miniclue.gen_clues.marks(),
|
||||
miniclue.gen_clues.registers(),
|
||||
-- This creates a submode for window resize mappings. Try the following:
|
||||
-- - Press `<C-w>s` to make a window split.
|
||||
-- - Press `<C-w>+` to increase height. Clue window still shows clues as if
|
||||
-- `<C-w>` is pressed again. Keep pressing just `+` to increase height.
|
||||
-- Try pressing `-` to decrease height.
|
||||
-- - Stop submode either by `<Esc>` or by any key that is not in submode.
|
||||
miniclue.gen_clues.windows({ submode_resize = true }),
|
||||
miniclue.gen_clues.z(),
|
||||
},
|
||||
-- Explicitly opt-in for set of common keys to trigger clue window
|
||||
triggers = {
|
||||
{ mode = 'n', keys = '<Leader>' }, -- Leader triggers
|
||||
{ mode = 'x', keys = '<Leader>' },
|
||||
{ mode = 'n', keys = '\\' }, -- mini.basics
|
||||
{ mode = 'n', keys = '[' }, -- mini.bracketed
|
||||
{ mode = 'n', keys = ']' },
|
||||
{ mode = 'x', keys = '[' },
|
||||
{ mode = 'x', keys = ']' },
|
||||
{ mode = 'i', keys = '<C-x>' }, -- Built-in completion
|
||||
{ mode = 'n', keys = 'g' }, -- `g` key
|
||||
{ mode = 'x', keys = 'g' },
|
||||
{ mode = 'n', keys = "'" }, -- Marks
|
||||
{ mode = 'n', keys = '`' },
|
||||
{ mode = 'x', keys = "'" },
|
||||
{ mode = 'x', keys = '`' },
|
||||
{ mode = 'n', keys = '"' }, -- Registers
|
||||
{ mode = 'x', keys = '"' },
|
||||
{ mode = 'i', keys = '<C-r>' },
|
||||
{ mode = 'c', keys = '<C-r>' },
|
||||
{ mode = 'n', keys = '<C-w>' }, -- Window commands
|
||||
{ mode = 'n', keys = 'z' }, -- `z` key
|
||||
{ mode = 'x', keys = 'z' },
|
||||
},
|
||||
window = {
|
||||
config = {
|
||||
width = 50,
|
||||
},
|
||||
},
|
||||
})
|
||||
end)
|
||||
|
||||
-- Command line tweaks. Improves command line editing with:
|
||||
-- - Autocompletion. Basically an automated `:h cmdline-completion`.
|
||||
-- - Autocorrection of words as-you-type. Like `:W`->`:w`, `:lau`->`:lua`, etc.
|
||||
-- - Autopeek command range (like line number at the start) as-you-type.
|
||||
later(function() require('mini.cmdline').setup() end)
|
||||
|
||||
-- Comment lines. Provides functionality to work with commented lines.
|
||||
-- Uses `:h 'commentstring'` option to infer comment structure.
|
||||
-- The built-in `:h commenting` is based on 'mini.comment'. Yet this module is
|
||||
-- still enabled as it provides more customization opportunities.
|
||||
later(function() require('mini.comment').setup() end)
|
||||
|
||||
-- Completion and signature help. Implements async "two stage" autocompletion:
|
||||
-- - Based on attached LSP servers that support completion.
|
||||
-- - Fallback (based on built-in keyword completion) if there is no LSP candidates.
|
||||
--
|
||||
-- It also works with snippet candidates provided by LSP server. Best experience
|
||||
-- when paired with 'mini.snippets' (which is set up in this file).
|
||||
later(function()
|
||||
-- Customize post-processing of LSP responses for a better user experience.
|
||||
-- Don't show 'Text' suggestions (usually noisy) and show snippets last.
|
||||
local process_items_opts = { kind_priority = { Text = -1, Snippet = 99 } }
|
||||
local process_items = function(items, base)
|
||||
return MiniCompletion.default_process_items(items, base, process_items_opts)
|
||||
end
|
||||
require('mini.completion').setup({
|
||||
lsp_completion = {
|
||||
-- Without this config autocompletion is set up through `:h 'completefunc'`.
|
||||
-- Although not needed, setting up through `:h 'omnifunc'` is cleaner
|
||||
-- (sets up only when needed) and makes it possible to use `<C-u>`.
|
||||
source_func = 'omnifunc',
|
||||
auto_setup = false,
|
||||
process_items = process_items,
|
||||
},
|
||||
})
|
||||
|
||||
-- Set 'omnifunc' for LSP completion only when needed.
|
||||
local on_attach = function(ev)
|
||||
vim.bo[ev.buf].omnifunc = 'v:lua.MiniCompletion.completefunc_lsp'
|
||||
end
|
||||
_G.Config.new_autocmd('LspAttach', nil, on_attach, "Set 'omnifunc'")
|
||||
|
||||
-- Advertise to servers that Neovim now supports certain set of completion and
|
||||
-- signature features through 'mini.completion'.
|
||||
vim.lsp.config('*', { capabilities = MiniCompletion.get_lsp_capabilities() })
|
||||
end)
|
||||
|
||||
-- Work with diff hunks that represent the difference between the buffer text and
|
||||
-- some reference text set by a source. Default source uses text from Git index.
|
||||
-- Also provides summary info used in developer section of 'mini.statusline'.
|
||||
-- Example usage:
|
||||
-- - `ghip` - apply hunks (`gh`) within *i*nside *p*aragraph
|
||||
-- - `gHG` - reset hunks (`gH`) from cursor until end of buffer (`G`)
|
||||
-- - `ghgh` - apply (`gh`) hunk at cursor (`gh`)
|
||||
-- - `gHgh` - reset (`gH`) hunk at cursor (`gh`)
|
||||
-- - `<Leader>go` - toggle overlay
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniDiff-overview` - overview of how module works
|
||||
-- - `:h MiniDiff-diff-summary` - available summary information
|
||||
-- - `:h MiniDiff.gen_source` - available built-in sources
|
||||
later(function() require('mini.diff').setup() end)
|
||||
|
||||
-- Navigate and manipulate file system
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniFiles-navigation` - more details about how to navigate
|
||||
-- - `:h MiniFiles-manipulation` - more details about how to manipulate
|
||||
-- - `:h MiniFiles-examples` - examples of common setups
|
||||
later(function()
|
||||
-- Enable directory/file preview
|
||||
require('mini.files').setup({ windows = { preview = false } })
|
||||
|
||||
-- Add common bookmarks for every explorer. Example usage inside explorer:
|
||||
-- - `'c` to navigate into your config directory
|
||||
-- - `g?` to see available bookmarks
|
||||
local add_marks = function()
|
||||
MiniFiles.set_bookmark('c', vim.fn.stdpath('config'), { desc = 'Config' })
|
||||
local minideps_plugins = vim.fn.stdpath('data') .. '/site/pack/deps/opt'
|
||||
MiniFiles.set_bookmark('p', minideps_plugins, { desc = 'Plugins' })
|
||||
MiniFiles.set_bookmark('w', vim.fn.getcwd, { desc = 'Working directory' })
|
||||
end
|
||||
_G.Config.new_autocmd('User', 'MiniFilesExplorerOpen', add_marks, 'Add bookmarks')
|
||||
end)
|
||||
|
||||
-- Highlight patterns in text. Like `TODO`/`NOTE` or color hex codes.
|
||||
-- See also:
|
||||
-- - `:h MiniHipatterns-examples` - examples of common setups
|
||||
later(function()
|
||||
local hipatterns = require('mini.hipatterns')
|
||||
local hi_words = MiniExtra.gen_highlighter.words
|
||||
hipatterns.setup({
|
||||
highlighters = {
|
||||
-- Highlight a fixed set of common words. Will be highlighted in any place,
|
||||
-- not like "only in comments".
|
||||
fixme = hi_words({ 'FIXME', 'Fixme', 'fixme' }, 'MiniHipatternsFixme'),
|
||||
hack = hi_words({ 'HACK', 'Hack', 'hack' }, 'MiniHipatternsHack'),
|
||||
todo = hi_words({ 'TODO', 'Todo', 'todo' }, 'MiniHipatternsTodo'),
|
||||
note = hi_words({ 'NOTE', 'Note', 'note' }, 'MiniHipatternsNote'),
|
||||
|
||||
-- Highlight hex color string (#aabbcc) with that color as a background
|
||||
hex_color = hipatterns.gen_highlighter.hex_color(),
|
||||
},
|
||||
})
|
||||
end)
|
||||
|
||||
-- Visualize and work with indent scope. It visualizes indent scope "at cursor"
|
||||
-- with animated vertical line. Provides relevant motions and textobjects.
|
||||
-- Example usage:
|
||||
-- - `cii` - *c*hange *i*nside *i*ndent scope
|
||||
-- - `Vaiai` - *V*isually select *a*round *i*ndent scope and then again
|
||||
-- reselect *a*round new *i*indent scope
|
||||
-- - `[i` / `]i` - navigate to scope's top / bottom
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniIndentscope.gen_animation` - available animation rules
|
||||
later(function() require('mini.indentscope').setup(
|
||||
{
|
||||
draw = {
|
||||
animation = require('mini.indentscope').gen_animation.none()
|
||||
}
|
||||
}
|
||||
) end)
|
||||
|
||||
-- Jump within visible lines to pre-defined spots via iterative label filtering.
|
||||
-- See also:
|
||||
-- - `:h MiniJump2d.gen_spotter` - list of available spotters
|
||||
later(function() require('mini.jump2d').setup() end)
|
||||
|
||||
-- Special key mappings.
|
||||
-- See also:
|
||||
-- - `:h MiniKeymap-examples` - examples of common setups
|
||||
-- - `:h MiniKeymap.map_multistep()` - map multi-step action
|
||||
-- - `:h MiniKeymap.map_combo()` - map combo
|
||||
later(function()
|
||||
require('mini.keymap').setup()
|
||||
-- Navigate 'mini.completion' menu with `<Tab>` / `<S-Tab>`
|
||||
MiniKeymap.map_multistep('i', '<Tab>', { 'pmenu_next' })
|
||||
MiniKeymap.map_multistep('i', '<S-Tab>', { 'pmenu_prev' })
|
||||
-- On `<CR>` try to accept current completion item, fall back to accounting
|
||||
-- for pairs from 'mini.pairs'
|
||||
MiniKeymap.map_multistep('i', '<CR>', { 'pmenu_accept', 'minipairs_cr' })
|
||||
-- On `<BS>` just try to account for pairs from 'mini.pairs'
|
||||
MiniKeymap.map_multistep('i', '<BS>', { 'minipairs_bs' })
|
||||
end)
|
||||
|
||||
-- Autopairs functionality. Insert pair when typing opening character and go over
|
||||
-- right character if it is already to cursor's right. Also provides mappings for
|
||||
-- `<CR>` and `<BS>` to perform extra actions when inside pair.
|
||||
-- Example usage in Insert mode:
|
||||
-- - `(` - insert "()" and put cursor between them
|
||||
-- - `)` when there is ")" to the right - jump over ")" without inserting new one
|
||||
-- - `<C-v>(` - always insert a single "(" literally. This is useful since
|
||||
-- 'mini.pairs' doesn't provide particularly smart behavior, like auto balancing
|
||||
later(function()
|
||||
-- Create pairs not only in Insert, but also in Command line mode
|
||||
require('mini.pairs').setup({ modes = { command = true } })
|
||||
end)
|
||||
|
||||
-- Autopairs functionality. Insert pair when typing opening character and go over
|
||||
-- right character if it is already to cursor's right. Also provides mappings for
|
||||
-- `<CR>` and `<BS>` to perform extra actions when inside pair.
|
||||
-- Example usage in Insert mode:
|
||||
-- - `(` - insert "()" and put cursor between them
|
||||
-- - `)` when there is ")" to the right - jump over ")" without inserting new one
|
||||
-- - `<C-v>(` - always insert a single "(" literally. This is useful since
|
||||
-- 'mini.pairs' doesn't provide particularly smart behavior, like auto balancing
|
||||
later(function()
|
||||
-- Create pairs not only in Insert, but also in Command line mode
|
||||
require('mini.pairs').setup({ modes = { command = true } })
|
||||
end)
|
||||
|
||||
-- Pick anything with single window layout and fast matching. This is one of
|
||||
-- the main usability improvements as it powers a lot of "find things quickly"
|
||||
-- workflows.
|
||||
-- See also:
|
||||
-- - `:h MiniPick-overview` - overview of picker functionality
|
||||
-- - `:h MiniPick-examples` - examples of common setups
|
||||
-- - `:h MiniPick.builtin` and `:h MiniExtra.pickers` - available pickers;
|
||||
-- Execute one either with Lua function, `:Pick <picker-name>` command, or
|
||||
-- one of `<Leader>f` mappings defined in 'plugin/20_keymaps.lua'
|
||||
later(function() require('mini.pick').setup() end)
|
||||
|
||||
-- Manage and expand snippets (templates for a frequently used text).
|
||||
-- Typical workflow is to type snippet's (configurable) prefix and expand it
|
||||
-- into a snippet session.
|
||||
--
|
||||
-- How to manage snippets:
|
||||
-- - 'mini.snippets' itself doesn't come with preconfigured snippets. Instead there
|
||||
-- is a flexible system of how snippets are prepared before expanding.
|
||||
-- They can come from pre-defined path on disk, 'snippets/' directories inside
|
||||
-- config or plugins, defined inside `setup()` call directly.
|
||||
-- - This config, however, does come with snippet configuration:
|
||||
-- - 'snippets/global.json' is a file with global snippets that will be
|
||||
-- available in any buffer
|
||||
-- - 'after/snippets/lua.json' defines personal snippets for Lua language
|
||||
-- - 'friendly-snippets' plugin configured in 'plugin/40_plugins.lua' provides
|
||||
-- a collection of language snippets
|
||||
--
|
||||
-- How to expand a snippet in Insert mode:
|
||||
-- - If you know snippet's prefix, type it as a word and press `<C-j>`. Snippet's
|
||||
-- body should be inserted instead of the prefix.
|
||||
-- - If you don't remember snippet's prefix, type only part of it (or none at all)
|
||||
-- and press `<C-j>`. It should show picker with all snippets that have prefixes
|
||||
-- matching typed characters (or all snippets if none was typed).
|
||||
-- Choose one and its body should be inserted instead of previously typed text.
|
||||
--
|
||||
-- How to navigate during snippet session:
|
||||
-- - Snippets can contain tabstops - places for user to interactively adjust text.
|
||||
-- Each tabstop is highlighted depending on session progression - whether tabstop
|
||||
-- is current, was or was not visited. If tabstop doesn't yet have text, it is
|
||||
-- visualized with special "ghost" inline text: • and ∎ by default.
|
||||
-- - Type necessary text at current tabstop and navigate to next/previous one
|
||||
-- by pressing `<C-l>` / `<C-h>`.
|
||||
-- - Repeat previous step until you reach special final tabstop, usually denoted
|
||||
-- by ∎ symbol. If you spotted a mistake in an earlier tabstop, navigate to it
|
||||
-- and return back to the final tabstop.
|
||||
-- - To end a snippet session when at final tabstop, keep typing or go into
|
||||
-- Normal mode. To force end snippet session, press `<C-c>`.
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniSnippets-overview` - overview of how module works
|
||||
-- - `:h MiniSnippets-examples` - examples of common setups
|
||||
-- - `:h MiniSnippets-session` - details about snippet session
|
||||
-- - `:h MiniSnippets.gen_loader` - list of available loaders
|
||||
-- later(function()
|
||||
-- -- Define language patterns to work better with 'friendly-snippets'
|
||||
-- local latex_patterns = { 'latex/**/*.json', '**/latex.json' }
|
||||
-- local lang_patterns = {
|
||||
-- tex = latex_patterns,
|
||||
-- plaintex = latex_patterns,
|
||||
-- -- Recognize special injected language of markdown tree-sitter parser
|
||||
-- markdown_inline = { 'markdown.json' },
|
||||
-- }
|
||||
--
|
||||
-- local snippets = require('mini.snippets')
|
||||
-- local config_path = vim.fn.stdpath('config')
|
||||
-- snippets.setup({
|
||||
-- snippets = {
|
||||
-- -- Always load 'snippets/global.json' from config directory
|
||||
-- snippets.gen_loader.from_file(config_path .. '/snippets/global.json'),
|
||||
-- -- Load from 'snippets/' directory of plugins, like 'friendly-snippets'
|
||||
-- snippets.gen_loader.from_lang({ lang_patterns = lang_patterns }),
|
||||
-- },
|
||||
-- })
|
||||
--
|
||||
-- -- By default snippets available at cursor are not shown as candidates in
|
||||
-- -- 'mini.completion' menu. This requires a dedicated in-process LSP server
|
||||
-- -- that will provide them. To have that, uncomment next line (use `gcc`).
|
||||
-- -- MiniSnippets.start_lsp_server()
|
||||
-- end)
|
||||
|
||||
-- Surround actions: add/delete/replace/find/highlight. Working with surroundings
|
||||
-- is surprisingly common: surround word with quotes, replace `)` with `]`, etc.
|
||||
-- This module comes with many built-in surroundings, each identified by a single
|
||||
-- character. It searches only for surrounding that covers cursor and comes with
|
||||
-- a special "next" / "last" versions of actions to search forward or backward
|
||||
-- (just like 'mini.ai'). All text editing actions are dot-repeatable (see `:h .`).
|
||||
--
|
||||
-- Example usage (this may feel intimidating at first, but after practice it
|
||||
-- becomes second nature during text editing):
|
||||
-- - `saiw)` - *s*urround *a*dd for *i*nside *w*ord parenthesis (`)`)
|
||||
-- - `sdf` - *s*urround *d*elete *f*unction call (like `f(var)` -> `var`)
|
||||
-- - `srb[` - *s*urround *r*eplace *b*racket (any of [], (), {}) with padded `[`
|
||||
-- - `sf*` - *s*urround *f*ind right part of `*` pair (like bold in markdown)
|
||||
-- - `shf` - *s*urround *h*ighlight current *f*unction call
|
||||
-- - `srn{{` - *s*urround *r*eplace *n*ext curly bracket `{` with padded `{`
|
||||
-- - `sdl'` - *s*urround *d*elete *l*ast quote pair (`'`)
|
||||
-- - `vaWsa<Space>` - *v*isually select *a*round *W*ORD and *s*urround *a*dd
|
||||
-- spaces (`<Space>`)
|
||||
--
|
||||
-- See also:
|
||||
-- - `:h MiniSurround-builtin-surroundings` - list of all supported surroundings
|
||||
-- - `:h MiniSurround-surrounding-specification` - examples of custom surroundings
|
||||
-- - `:h MiniSurround-vim-surround-config` - alternative set of action mappings
|
||||
later(function() require('mini.surround').setup() end)
|
||||
|
||||
-- Highlight and remove trailspace. Temporarily stops highlighting in Insert mode
|
||||
-- to reduce noise when typing. Example usage:
|
||||
-- - `<Leader>ot` - trim all trailing whitespace in a buffer
|
||||
later(function() require('mini.trailspace').setup() end)
|
||||
|
||||
Reference in New Issue
Block a user