Something went wrong. Try again.
Neovim config generator based on MINI nvim-mini.org/MiniMax
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124-- ┌────────────────────┐-- │ Welcome to MiniMax │-- └────────────────────┘---- This is a config designed to mostly use MINI. It provides out of the box-- a stable, polished, and feature rich Neovim experience. Its structure:---- ├ init.lua Initial (this) file executed during startup-- ├ plugin/ Files automatically sourced during startup-- ├── 10_options.lua Built-in Neovim behavior-- ├── 20_keymaps.lua Custom mappings-- ├── 30_mini.lua MINI configuration-- ├── 40_plugins.lua Plugins outside of MINI-- ├ snippets/ User defined snippets (has demo file)-- ├ after/ Files to override behavior added by plugins-- ├── ftplugin/ Files for filetype behavior (has demo file)-- ├── lsp/ Language server configurations (has demo file)-- ├── snippets/ Higher priority snippet files (has demo file)---- Config files are meant to be read, preferably inside a Neovim instance running-- this config and opened at its root. This will help you better understand your-- setup. Start with this file. Any order is possible, prefer the one listed above.-- Ways of navigating your config:-- - `<Space>` + `e` + (one of) `iokmp` - edit 'init.lua' or 'plugin/' files.-- - Inside config directory: `<Space>ff` (picker) or `<Space>ed` (explorer)-- - Navigate existing buffers with `[b`, `]b`, or `<Space>fb`.---- Config files are also meant to be customized. Initially it is a baseline of-- a working config based on MINI. Modify it to make it yours. Some approaches:-- - Modify already existing files in a way that keeps them consistent.-- - Add new files in a way that keeps config consistent.-- Usually inside 'plugin/' or 'after/'.---- Documentation comments like this can be found throughout the config.-- Common conventions:---- - See `:h key-notation` for key notation used.-- - `:h xxx` means "documentation of helptag xxx". Either type text directly-- followed by Enter or type `<Space>fh` to open a helptag fuzzy picker.-- - "Type `<Space>fh`" means "press <Space>, followed by f, followed by h".-- Unless said otherwise, it assumes that Normal mode is current.-- - "See 'path/to/file'" means see open file at described path and read it.-- - `:SomeCommand ...` or `:lua ...` means execute mentioned command.
-- ┌────────────────┐-- │ Plugin manager │-- └────────────────┘---- This config uses `vim.pack` - built-in plugin manager. Its main entry-- point is a `vim.pack.add()` function, which acts like a "smarter `:packadd`":-- load plugin after making sure it is installed from source. The state of-- installed plugins is recorded in the lockfile named 'nvim-pack-lock.json'.-- Example usage:-- - `vim.pack.add({ ... })` - use inside config to add one or more plugins.-- - `:lua vim.pack.update()` - update all plugins; execute `:write` to confirm.-- - `:lua vim.pack.del({ ... })` - delete specific plugins.---- See also:-- - `:h vim.pack-examples` - how to use it-- - `:h vim.pack-lockfile` - lockfile info-- - `:h vim.pack-events` - available events and plugin hooks examples-- - `:h vim.pack.update()` - more details about confirmation step
-- Define config table to be able to pass data between scripts-- It is a global variable which can be use both as `_G.Config` and `Config`_G.Config = {}
-- Define custom autocommand group and helper to create an autocommand.-- Autocommands are Neovim's way to define actions that are executed on events-- (like creating a buffer, setting an option, etc.).---- See also:-- - `:h autocommand`-- - `:h nvim_create_augroup()`-- - `:h nvim_create_autocmd()`local gr = vim.api.nvim_create_augroup('custom-config', {})Config.new_autocmd = function(event, pattern, callback, desc) local opts = { group = gr, pattern = pattern, callback = callback, desc = desc } vim.api.nvim_create_autocmd(event, opts)end
-- Define custom `vim.pack.add()` hook helper. Plugin data is passed as-- argument to the callback. See `:h vim.pack-events`.-- Example usage: see 'plugin/40_plugins.lua'.-- If any plugin requires installation hooks, add them after this function-- and before the first `vim.pack.add()` call.Config.on_packchanged = function(plugin_name, kinds, callback, desc) local f = function(ev) local name, kind = ev.data.spec.name, ev.data.kind if not (name == plugin_name and vim.tbl_contains(kinds, kind)) then return end if not ev.data.active then vim.cmd.packadd(plugin_name) end callback(ev.data) end Config.new_autocmd('PackChanged', '*', f, desc)end
-- 'mini.nvim' - all-in-one plugin powering most MiniMax features.-- See 'plugin/30_mini.lua' for how it is used.-- Load now to have 'mini.misc' available for custom loading helpers.vim.pack.add({ 'https://github.com/nvim-mini/mini.nvim' })
-- Loading helpers used to organize config into fail-safe parts. Example usage:-- - `now` - execute immediately. Use for what must be executed during startup.-- Like colorscheme, statusline, tabline, dashboard, etc.-- - `later` - execute a bit later. Use for things not needed during startup.-- - `now_if_args` - use only if needed during startup when Neovim is started-- like `nvim -- path/to/file`, but otherwise delaying is fine.-- - Others are better used only if the above is not enough for good performance.-- Use only if you are comfortable with adding complexity to your config:-- - `on_event` - execute once on a first matched event. Like "delay until-- first Insert mode enter": `on_event('InsertEnter', function() ... end)`.-- - `on_filetype` - execute once on a first matched filetype. Like "delay-- until first Lua file": `on_filetype('lua', function() ... end)`.---- See also:-- - `:h MiniMisc.safely()`-- - 'plugin/30_mini.lua' and 'plugin/40_plugins.lua'local misc = require('mini.misc')Config.now = function(f) misc.safely('now', f) endConfig.later = function(f) misc.safely('later', f) endConfig.now_if_args = vim.fn.argc(-1) > 0 and Config.now or Config.laterConfig.on_event = function(ev, f) misc.safely('event:' .. ev, f) endConfig.on_filetype = function(ft, f) misc.safely('filetype:' .. ft, f) end