✨ Features

⚡️ Requirements

📦 Installation

lazy.nvim

Important

A couple of pluginsrequiresnacks.nvim to be set-up early.Setup creates some autocmds and does not load any plugins.Check thecode to see what it does.

Caution

You need to explicitly pass options for a plugin or setenabled = true to enable it.

Tip

It's a good idea to run:checkhealth snacks to see if everything is set up correctly.

{"folke/snacks.nvim",priority=1000,lazy=false,---@typesnacks.Configopts= {-- your configuration comes here-- or leave it empty to use the default settings-- refer to the configuration section belowbigfile= {enabled=true },dashboard= {enabled=true },indent= {enabled=true },input= {enabled=true },notifier= {enabled=true },quickfile= {enabled=true },scroll= {enabled=true },statuscolumn= {enabled=true },words= {enabled=true },  },}

⚙️ Configuration

{dashboard= {example="github"}}

{gitbrowse= {config=function(opts,defaults)table.insert(opts.remote_patterns, {"my","custom pattern"})end  },}

🚀 Usage

{"folke/snacks.nvim",priority=1000,lazy=false,---@typesnacks.Configopts= {bigfile= {enabled=true },dashboard= {enabled=true },indent= {enabled=true },input= {enabled=true },notifier= {enabled=true,timeout=3000,    },quickfile= {enabled=true },scroll= {enabled=true },statuscolumn= {enabled=true },words= {enabled=true },styles= {notification= {-- wo = { wrap = true } -- Wrap notifications      }    }  },keys= {    {"<leader>z",function()Snacks.zen()end,desc="Toggle Zen Mode"},    {"<leader>Z",function()Snacks.zen.zoom()end,desc="Toggle Zoom"},    {"<leader>.",function()Snacks.scratch()end,desc="Toggle Scratch Buffer"},    {"<leader>S",function()Snacks.scratch.select()end,desc="Select Scratch Buffer"},    {"<leader>n",function()Snacks.notifier.show_history()end,desc="Notification History"},    {"<leader>bd",function()Snacks.bufdelete()end,desc="Delete Buffer"},    {"<leader>cR",function()Snacks.rename.rename_file()end,desc="Rename File"},    {"<leader>gB",function()Snacks.gitbrowse()end,desc="Git Browse",mode= {"n","v"} },    {"<leader>gb",function()Snacks.git.blame_line()end,desc="Git Blame Line"},    {"<leader>gf",function()Snacks.lazygit.log_file()end,desc="Lazygit Current File History"},    {"<leader>gg",function()Snacks.lazygit()end,desc="Lazygit"},    {"<leader>gl",function()Snacks.lazygit.log()end,desc="Lazygit Log (cwd)"},    {"<leader>un",function()Snacks.notifier.hide()end,desc="Dismiss All Notifications"},    {"<c-/>",function()Snacks.terminal()end,desc="Toggle Terminal"},    {"<c-_>",function()Snacks.terminal()end,desc="which_key_ignore"},    {"]]",function()Snacks.words.jump(vim.v.count1)end,desc="Next Reference",mode= {"n","t"} },    {"[[",function()Snacks.words.jump(-vim.v.count1)end,desc="Prev Reference",mode= {"n","t"} },    {"<leader>N",desc="Neovim News",function()Snacks.win({file=vim.api.nvim_get_runtime_file("doc/news.txt",false)[1],width=0.6,height=0.6,wo= {spell=false,wrap=false,signcolumn="yes",statuscolumn="",conceallevel=3,          },        })end,    }  },init=function()vim.api.nvim_create_autocmd("User", {pattern="VeryLazy",callback=function()-- Setup some globals for debugging (lazy-loaded)_G.dd=function(...)Snacks.debug.inspect(...)end_G.bt=function()Snacks.debug.backtrace()endvim.print=_G.dd-- Override print to use snacks for `:=` command-- Create some toggle mappingsSnacks.toggle.option("spell", {name="Spelling"}):map("<leader>us")Snacks.toggle.option("wrap", {name="Wrap"}):map("<leader>uw")Snacks.toggle.option("relativenumber", {name="Relative Number"}):map("<leader>uL")Snacks.toggle.diagnostics():map("<leader>ud")Snacks.toggle.line_number():map("<leader>ul")Snacks.toggle.option("conceallevel", {off=0,on=vim.o.conceallevel>0andvim.o.conceallevelor2 }):map("<leader>uc")Snacks.toggle.treesitter():map("<leader>uT")Snacks.toggle.option("background", {off="light",on="dark",name="Dark Background"}):map("<leader>ub")Snacks.toggle.inlay_hints():map("<leader>uh")Snacks.toggle.indent():map("<leader>ug")Snacks.toggle.dim():map("<leader>uD")end,    })end,}

🌈 Highlight Groups