From 770e255041aa3cf2425ef5a2f86344ef043d7763 Mon Sep 17 00:00:00 2001 From: Philipp Szechenyi Date: Thu, 10 Jul 2025 16:02:58 +0200 Subject: [PATCH] add snacks(picker) as an optional plugin add some comments to snacks picker to get it inline with telescope config --- init.lua | 1 + lua/kickstart/plugins/snacks.lua | 154 +++++++++++++++++++++++++++++++ 2 files changed, 155 insertions(+) create mode 100644 lua/kickstart/plugins/snacks.lua diff --git a/init.lua b/init.lua index b98ffc61..132805e5 100644 --- a/init.lua +++ b/init.lua @@ -979,6 +979,7 @@ require('lazy').setup({ -- require 'kickstart.plugins.autopairs', -- require 'kickstart.plugins.neo-tree', -- require 'kickstart.plugins.gitsigns', -- adds gitsigns recommend keymaps + -- require 'kickstart.plugins.snacks', -- enable snacks picker -- NOTE: The import below can automatically add your own plugins, configuration, etc from `lua/custom/plugins/*.lua` -- This is the easiest way to modularize your config. diff --git a/lua/kickstart/plugins/snacks.lua b/lua/kickstart/plugins/snacks.lua new file mode 100644 index 00000000..59e6502f --- /dev/null +++ b/lua/kickstart/plugins/snacks.lua @@ -0,0 +1,154 @@ +-- NOTE: Plugins can specify dependencies. +-- +-- The dependencies are proper plugin specifications as well - anything +-- you do for a plugin at the top level, you can do for a dependency. +-- +-- Use the `dependencies` key to specify the dependencies of a particular plugin + +return { -- Fuzzy Finder (files, lsp, etc) + 'folke/snacks.nvim', + priority = 1000, + lazy = false, + dependencies = { + -- Useful for getting pretty icons, but requires a Nerd Font. + { 'nvim-tree/nvim-web-devicons', enabled = vim.g.have_nerd_font }, + }, + + -- snacks.nvim is a plugin that contains a collection of QoL improvements. + -- One of those plugins is called snacks-picker + -- It is a fuzzy finder, inspired by Telescope, that comes with a lot of different + -- things that it can fuzzy find! It's more than just a "file finder", it can search + -- many different aspects of Neovim, your workspace, LSP, and more! + -- + -- Two important keymaps to use while in a picker are: + -- - Insert mode: + -- - Normal mode: ? + -- + -- This opens a window that shows you all of the keymaps for the current + -- Snacks picker. This is really useful to discover what nacks-picker can + -- do as well as how to actually do it! + + -- [[ Configure Snacks Pickers ]] + -- See `:help snacks-picker` and `:help snacks-picker-setup` + ---@type snacks.Config + opts = { + picker = {}, + }, + + -- See `:help snacks-pickers-sources` + keys = { + { + 'sh', + function() + Snacks.picker.help() + end, + desc = '[S]earch [H]elp', + }, + { + 'sk', + function() + Snacks.picker.keymaps() + end, + desc = '[S]earch [K]eymaps', + }, + { + 'sf', + function() + Snacks.picker.smart() + end, + desc = '[S]earch [F]iles', + }, + { + 'ss', + function() + Snacks.picker.pickers() + end, + desc = '[S]earch [S]elect Snacks', + }, + { + 'sw', + function() + Snacks.picker.grep_word() + end, + desc = '[S]earch current [W]ord', + mode = { 'n', 'x' }, + }, + { + 'sg', + function() + Snacks.picker.grep() + end, + desc = '[S]earch by [G]rep', + }, + { + 'sd', + function() + Snacks.picker.diagnostics() + end, + desc = '[S]earch [D]iagnostics', + }, + { + 'sr', + function() + Snacks.picker.resume() + end, + desc = '[S]earch [R]esume', + }, + { + 's.', + function() + Snacks.picker.recent() + end, + desc = '[S]earch Recent Files ("." for repeat)', + }, + { + '', + function() + Snacks.picker.buffers() + end, + desc = '[ ] Find existing buffers', + }, + { + '/', + function() + Snacks.picker.lines {} + end, + desc = '[/] Fuzzily search in current buffer', + }, + { + 's/', + function() + Snacks.picker.grep_buffers() + end, + desc = '[S]earch [/] in Open Files', + }, + -- Shortcut for searching your Neovim configuration files + { + 'sn', + function() + Snacks.picker.files { cwd = vim.fn.stdpath 'config' } + end, + desc = '[S]earch [N]eovim files', + }, + }, + + -- This runs on LSP attach per buffer (see main LSP attach function in 'neovim/nvim-lspconfig' config for more info, + -- it is better explained there). This is a little bit redundant, but we can switch off pickers for an optional + -- picker like this one here more easily when the keymaps are defined in the plugin itself. + -- It sets up buffer-local keymaps, autocommands, and other LSP-related settings + -- whenever an LSP client attaches to a buffer. + config = function() + vim.api.nvim_create_autocmd('LspAttach', { + group = vim.api.nvim_create_augroup('snacks-lsp-attach', { clear = true }), + callback = function(event) + vim.keymap.set('n', 'grr', require('snacks').picker.lsp_references, { buffer = event.buf, desc = '[G]oto [R]eferences' }) + vim.keymap.set('n', 'gri', require('snacks').picker.lsp_implementations, { buffer = event.buf, desc = '[G]oto [I]mplementation' }) + vim.keymap.set('n', 'grd', require('snacks').picker.lsp_definitions, { buffer = event.buf, desc = '[G]oto [D]efinition' }) + vim.keymap.set('n', 'grD', vim.lsp.buf.declaration, { buffer = event.buf, desc = '[G]oto [D]eclaration' }) + vim.keymap.set('n', 'gO', require('snacks').picker.lsp_symbols, { buffer = event.buf, desc = 'Open Document Symbols' }) + vim.keymap.set('n', 'gW', require('snacks').picker.lsp_workspace_symbols, { buffer = event.buf, desc = 'Open Workspace Symbols' }) + vim.keymap.set('n', 'grt', require('snacks').picker.lsp_type_definitions, { buffer = event.buf, desc = '[G]oto [T]ype Definition' }) + end, + }) + end, +}