snacks.nvim

snacks.nvim is a collection of small Quality of Life (QoL) plugins for Neovim. Key features include:

• UI & Aesthetics: animate, dashboard, dim, indent, notifier, scroll, statuscolumn, zen.
• File & Buffer Management: bigfile, bufdelete, explorer, quickfile, rename.
• Navigation & Selection: picker, scope, words.
• Utilities: debug, gh (GitHub CLI), git, gitbrowse, input, keymap, layout, lazygit, terminal, toggle, win.
• Developer Tools: profiler, scratch, image (via Kitty Graphics Protocol).

bigfile is a feature in snacks.nvim that introduces a new filetype bigfile when a file exceeds a configured size threshold. This mechanism is designed to prevent performance degradation by automatically stopping heavy plugins like LSP and Treesitter from attaching to the buffer.

By default, when a big file is detected, snacks.nvim enables syntax for the buffer and disables mini.animate (if present).

The scratch module allows you to quickly open temporary buffers for testing code, taking notes, or experimentation. Scratch buffers are organized using context such as your working directory, Git branch, and vim.v.count1.

Key features:

• Lua Execution: In Lua buffers, pressing <cr> (Enter) executes the buffer or selection using Snacks.debug.run(), displaying print output inline and showing errors as diagnostics.
• Persistence: Supports auto-saves when the buffer is hidden.
• Organization: Uses templates and context-aware file naming to keep scratch sessions separate.

To use the animate module, include snacks.nvim in your plugin manager (e.g., lazy.nvim) and provide an animate table within the opts configuration. You can leave the table empty to use default settings.

-- lazy.nvim
{
  "folke/snacks.nvim",
  ---@type snacks.Config
  opts = {
    animate = {
      -- your animate configuration comes here
      -- or leave it empty to use the default settings
    }
  }
}

To use gitbrowse, add snacks.nvim to your lazy.nvim configuration. You can provide custom configuration for gitbrowse within the opts table. If you leave it empty, it will use the default settings.

-- lazy.nvim
{
  "folke/snacks.nvim",
  ---@type snacks.Config
  opts = {
    gitbrowse = {
      -- your gitbrowse configuration comes here
      -- or leave it empty to use the default settings
      -- refer to the configuration section below
    }
  }
}

Use the following keybindings to navigate the file tree:

• <CR> or l: Open file or toggle directory.
• h: Close directory.
• <BS> (Backspace): Go up one directory.
• .: Focus on current directory (sets it as cwd).
• H: Toggle hidden files.
• I: Toggle ignored files (from .gitignore).
• Z: Close all directories.

Quick Actions

• <leader>/: Grep in the current directory.
• <c-t>: Open terminal in the current directory.
• <c-c>: Change tab directory to the current directory.
• P: Toggle preview.

To use the indent feature in snacks.nvim, add it to your lazy.nvim configuration. You can provide an indent table within opts to customize the behavior, or leave it empty to use the default settings.

-- lazy.nvim
{
  "folke/snacks.nvim",
  ---@type snacks.Config
  opts = {
    indent = {
      -- your indent configuration comes here
      -- or leave it empty to use the default settings
      -- refer to the configuration section below
    }
  }
}

To use the layout module, configure it within your lazy.nvim setup. You can provide a custom configuration or leave it empty to use the default settings.

-- lazy.nvim
{
  "folke/snacks.nvim",
  ---@type snacks.Config
  opts = {
    layout = {
      -- your layout configuration comes here
      -- or leave it empty to use the default settings
      -- refer to the configuration section below
    }
  }
}

To use the bigfile feature, add snacks.nvim to your lazy.nvim configuration and provide a bigfile table within the opts object.

-- lazy.nvim
{
  "folke/snacks.nvim",
  ---@type snacks.Config
  opts = {
    bigfile = {
      -- your bigfile configuration comes here
      -- or leave it empty to use the default settings
    }
  }
}