Can someone help me implement Telescope search layout in Snacks Picker

[mxhuntr]

Telescope Layout

Snacks layout

Configuration

return {
	-- HACK: docs @ https://github.com/folke/snacks.nvim/blob/main/docs
	{
		"folke/snacks.nvim",
		priority = 1000,
		lazy = false,
		-- NOTE: Options
		opts = {
			styles = {
				input = {
					keys = {
						n_esc = { "<Esc>", { "cmp_close", "cancel" }, mode = "n", expr = true },
						i_esc = { "<C-c>", { "cmp_close", "stopinsert" }, mode = "i", expr = true },
					},
				},
			},
			-- Snacks Modules
			input = {
				enabled = true,
			},
			quickfile = {
				enabled = true,
				exclude = { "latex" },
			},
			-- HACK: read picker docs @ https://github.com/folke/snacks.nvim/blob/main/docs/picker.md
			picker = {
				enabled = true,
				matchers = {
					frecency = true,
					cwd_bonus = false,
				},
				exclude = {
					".git",
					"node_modules",
					"dist",
					"build",
				},
				formatters = {
					file = {
						filename_first = true,
						filename_only = false,
						icon_width = 2,
					},
				},
				layout = {
					-- presets options : "default" , "ivy" , "ivy-split" , "telescope" , "vscode", "select" , "sidebar"
					-- override picker layout in keymaps function as a param below
					preset = "telescope", -- defaults to this layout unless overridden
					cycle = false,
				},
				layouts = {
					searchy = {
						preview = true,
						layout = {
							preview = "main",
							box = "vertical",
							backdrop = false,
							width = 0.6,
							height = 0.6,
							border = "none",
							{
								win = "preview",
								title = "{preview:Preview}",
								width = 0.6,
								border = "rounded",
								title_pos = "center",
							},
							{
								box = "vertical",
								{
									win = "input",
									height = 1,
									border = "rounded",
									title = "{title} {live} {flags}",
									title_pos = "center",
								},
								{ win = "list", title = " Results ", title_pos = "center", border = "rounded" },
							},
						},
					},
				}, 
			},
		},
		-- NOTE: Keymaps
		keys = {
			{
				"<leader>o",
				function()
					require("snacks").picker.lines({
						layout = { preset = "searchy" },
						title = "Current Buffer Fuzzy",
					})
				end,
				desc = "Current Buffer Fuzzy",
			},
		},
	},
}

[drowning-cat]

Related:

• Share your layouts! #1306
• I can't seem to use explorer layout when I set a general layout config in the pickers config #1448

• snacks.nvim/lua/snacks/picker/config/layouts.lua

  Lines 106 to 125 in fe7cfe9

  	M.dropdown = {
  	layout = {
  	backdrop = false,
  	row = 1,
  	width = 0.4,
  	min_width = 80,
  	height = 0.8,
  	border = "none",
  	box = "vertical",
  	{ win = "preview", title = "{preview}", height = 0.4, border = true },
  	{
  	box = "vertical",
  	border = true,
  	title = "{title} {live} {flags}",
  	title_pos = "center",
  	{ win = "input", height = 1, border = "bottom" },
  	{ win = "list", border = "none" },
  	},
  	},
  	}

[drowning-cat]

---@module 'snacks'

return {
  "folke/snacks.nvim",
  priority = 1000,
  lazy = false,
  -- NOTE: Keymaps
  keys = {
    {
      "<leader>o",
      function()
        Snacks.picker.lines({ layout = { preset = "searchy", preview = true }, title = "Current Buffer Fuzzy" })
      end,
      desc = "Current Buffer Fuzzy",
    },
  },
  ---@type snacks.Config
  opts = {
    picker = {
      -- BUG: Not `matchers`
      matcher = {
        frecency = true,
        cwd_bonus = false,
      },
      layout = {
        preset = "telescope",
        cycle = false,
      },
      layouts = {
        searchy = {
          -- NOTE: Copy from https://github.com/folke/snacks.nvim/blob/fe7cfe9800a182274d0f868a74b7263b8c0c020b/lua/snacks/picker/config/layouts.lua#L106-L125
          layout = {
            backdrop = false,
            row = 1,
            width = 0.4,
            min_width = 80,
            height = 0.8,
            border = "none",
            box = "vertical",
            { win = "preview", title = "{preview}", height = 0.4, border = true },
            {
              box = "vertical",
              border = true,
              title = "{title} {live} {flags}",
              title_pos = "center",
              { win = "input", height = 1, border = "bottom" },
              { win = "list", border = "none" },
            },
          },
        },
      },
    },
  },
}

[mxhuntr]

Tried this.

[drowning-cat]

Didn't try hard enough.

nvim -u repro.lua repro.lua

-- repro.lua

vim.g.mapleader = " "

vim.env.LAZY_STDPATH = ".repro"
load(vim.fn.system("curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua"))()

require("lazy.minit").repro({
  spec = {
    {
      "folke/snacks.nvim",
      lazy = false,
      keys = {
        {
          "<leader>o",
          function()
            Snacks.picker.lines({ layout = { preset = "searchy", preview = true }, title = "Current Buffer Fuzzy" })
          end,
          desc = "Current Buffer Fuzzy",
        },
      },
      opts = {
        picker = {
          -- BUG: Not `matchers`
          matcher = {
            frecency = true,
            cwd_bonus = false,
          },
          layout = {
            preset = "telescope",
            cycle = false,
          },
          layouts = {
            searchy = {
              -- NOTE: Copy from https://github.com/folke/snacks.nvim/blob/fe7cfe9800a182274d0f868a74b7263b8c0c020b/lua/snacks/picker/config/layouts.lua#L106-L125
              layout = {
                backdrop = false,
                row = 1,
                width = 0.4,
                min_width = 80,
                height = 0.8,
                border = "none",
                box = "vertical",
                { win = "preview", title = "{preview}", height = 0.4, border = true },
                {
                  box = "vertical",
                  border = true,
                  title = "{title} {live} {flags}",
                  title_pos = "center",
                  { win = "input", height = 1, border = "bottom" },
                  { win = "list", border = "none" },
                },
              },
            },
          },
        },
      },
    },
  },
})

-- vim: ts=2 sw=2

[mxhuntr]

Missed this

{ preset = "searchy", preview = true }

[mxhuntr]

Few more things:

1. Turn of Line number in Preview
2. Turn of todo-comment.nvim in Preview window
3. Indentation in List Window to disable Indent-blankline and use 1 space to indent

[drowning-cat]

1/3. You can change options for a layout window:

{ win = "preview", wo = { number = false }, bo = { --[[ ... ]] } }

2. Forget it. You can't disable todo-comment.nvim for the lines picker preview because it uses the source buffer.

[mxhuntr]

Indentation Issue?

[drowning-cat]

What's the problem? The number of indentation guides is the same as in the original buffer.

[mxhuntr]

replace the indentation of 4 in editor to 1 in Preview and list Widow also disable Indent-blankline in Snacks. Check the telescope layout above. Looks Clean.

[drowning-cat]

You've wasted so much of my time that I've decided to provide a complete solution for one of the most impractical lines picker. In my case, the indentation guides aren't showing up in the list, so I can't test it properly.

The preview for the lines picker uses the same buffer as the one from which the picker was opened. To work around this, we replace item.buf with item._buf and add item.file, so the file preview creates a new buffer instead of reusing the main window's buffer. As a result, todo-comments.nvim comments won't be displayed. However, this allows us to control indent guides only in the preview buffer without affecting the main window's buffer.

Additionally, the format function adds a virtual_text extmark with a separator line, as you requested. You may only need to adjust the spacing and highlight to match your preference.

---@module 'snacks'

return {
  "folke/snacks.nvim",
  lazy = false,
  keys = {
    -- stylua: ignore
    { "<leader>o", function() Snacks.picker.lines() end, desc = "Current Buffer Fuzzy" },
  },
  ---@type snacks.Config
  opts = {
    picker = {
      sources = {
        lines = {
          title = "Current Buffer Fuzzy",
          layout = {
            preset = "searchy",
            preview = true,
          },
          finder = function(opts, ctx)
            local items = require("snacks.picker.source.lines").lines(opts, ctx)
            for _, it in ipairs(items) do
              local buf = it.buf
              it.buf, it._buf = nil, buf
              it.file = vim.api.nvim_buf_get_name(buf)
            end
            return items
          end,
          -- NOTE: Copy from https://github.com/folke/snacks.nvim/blob/fe7cfe9800a182274d0f868a74b7263b8c0c020b/lua/snacks/picker/format.lua#L370-L392
          format = function(item, picker)
            local ret = {} ---@type snacks.picker.Highlight[]
            local line_count = vim.api.nvim_buf_line_count(item._buf)
            local idx = Snacks.picker.util.align(tostring(item.idx), #tostring(line_count), { align = "right" })
            -- NOTE: Changed
            ret[#ret + 1] = { idx, "LineNr", virtual = true }
            ret[#ret + 1] = { "  ", virtual = true }
            ret[#ret + 1] = { "│", "Special", virtual = true }
            ret[#ret + 1] = { "  ", virtual = true }
            ret[#ret + 1] = { item.text }

            -- NOTE: Changed
            local offset = #idx + 5

            for _, extmark in ipairs(item.highlights or {}) do
              -- NOTE: Changed
              if not (extmark.hl_group or ""):match("SnacksIndent") then
                extmark = vim.deepcopy(extmark)
                if type(extmark[1]) ~= "string" then
                  ---@cast extmark snacks.picker.Extmark
                  extmark.col = extmark.col + offset
                  if extmark.end_col then
                    extmark.end_col = extmark.end_col + offset
                  end
                end
                ret[#ret + 1] = extmark
              end
            end
            return ret
          end,
        },
      },
      layouts = {
        searchy = {
          -- NOTE: Copy from https://github.com/folke/snacks.nvim/blob/fe7cfe9800a182274d0f868a74b7263b8c0c020b/lua/snacks/picker/config/layouts.lua#L106-L125
          layout = {
            backdrop = false,
            row = 1,
            width = 0.4,
            min_width = 80,
            height = 0.8,
            border = "none",
            box = "vertical",
            {
              win = "preview",
              title = "{preview}",
              height = 0.4,
              border = true,
              -- NOTE: Changed
              wo = { number = false, relativenumber = false },
              b = { snacks_indent = false },
            },
            {
              box = "vertical",
              border = true,
              title = "{title} {live} {flags}",
              title_pos = "center",
              { win = "input", height = 1, border = "bottom" },
              { win = "list", border = "none" },
            },
          },
        },
      },
    },
  },
}

[drowning-cat]

Don't get me wrong, I don't think you're bad or anything. I just think this has been a waste of time because the layout you asked for with the lines picker simply doesn't make sense to me.

A lines picker with a preview window that essentially duplicates the list main window at a smaller height, without showing the actual extmarks used in the buffer, and using a layout that takes up nearly a third of the screen width just to display buffer lines is a very strange design choice.

Moreover, since it displays the same buffer as the main window, it makes the lines picker an exception compared to general file-like pickers. Thus, if the goal is to use this layout with any picker other than lines, such workarounds aren't needed, which makes lines picker the worst example in this case.

[mxhuntr]

It makes sense for me because i work with a lot of code that I'm unfamiliar with, so it is comes in handy to have a fuzzy finder with a Preview to check the code block. I used telescope for a while and it works like a charm, recently i shifted all of my telescope settings to Snacks. Only one i couldn't figure out was fuzzy finder one.

[drowning-cat]

It makes sense for me because i work with a lot of code that I'm unfamiliar with, so it is comes in handy to have a fuzzy finder with a Preview to check the code block.

I had a brain lag, more in the sense of a typo. The preview shows context when searching since the list displays only a single line per item, but the ivy layout is still more convenient for this use case because it shows the item's buffer as it is in a larger window.

Only one i couldn't figure out was fuzzy finder one.

Affirmative. Then it wasn't a complete waste of time, but my misjudgment.

But anyway, I hope I didn't sound too harsh. Feel free to ask more questions, but preferably in a different discussion.

[mxhuntr]

We're good. You helped.