Essential code editor features

[wojciech-kulik]

mini.nvim provides a lot of useful features that you probably know from other code editors like Xcode or VSC.

Below you can find a sample config enabling the most essential to me:

return {
  "echasnovski/mini.nvim",
  event = "VeryLazy",
  version = false,
  config = function()
    -- to toggle comments just hit `gc`
    require("mini.comment").setup({
      options = {
        custom_commentstring = function()
          return vim.api.nvim_buf_get_option(0, "ft") == "swift" and "// %s"
        end,
      },
      mappings = {
        comment_line = "gc",
      },
    })

    -- to quickly add/remove surrounding characters
    -- `sd<symbol>` to delete
    -- `sa<motion><symbol>` to add
    require("mini.surround").setup({
      mappings = {
        add = "sa",
        delete = "sd",
        find = "", -- Find surrounding (to the right)
        find_left = "", -- Find surrounding (to the left)
        highlight = "", -- Highlight surrounding
        replace = "", -- Replace surrounding
        update_n_lines = "", -- Update `n_lines`
        suffix_last = "", -- Suffix to search with "prev" method
        suffix_next = "", -- Suffix to search with "next" method
      },
    })

    -- this is very useful, by hitting `sj` you can split arguments into new lines (ctrl+m in Xcode)
    require("mini.splitjoin").setup({
      mappings = {
        toggle = "sj",
        split = "",
        join = "",
      },
    })
 
    -- recently, I stopped using it but it adds automatically closing brackets, quotes, etc.
    require("mini.pairs").setup({
      modes = { insert = true, command = false, terminal = false },
      mappings = { ["`"] = false },
    })

    -- to easily move code around
    require("mini.move").setup({
      mappings = {
        left = "<A-h>",
        right = "<A-l>",
        down = "<A-j>",
        up = "<A-k>",
        line_left = "<A-h>",
        line_right = "<A-l>",
        line_down = "<A-j>",
        line_up = "<A-k>",
      },
    })
    
    -- recently, I stopped using it, but it highlights all occurrences of the word under the cursor
    vim.api.nvim_create_autocmd("CursorMoved", {
      group = "bufcheck",
      pattern = "*",
      callback = function(ev)
        local filetype = vim.api.nvim_buf_get_option(ev.buf, "filetype")
        vim.b.minicursorword_disable =
          vim.tbl_contains({ "oil", "md", "text", "json", "yml", "NvimTree" }, filetype)
      end,
    })
    require("mini.cursorword").setup()
  end,
}