[mini.pick] treesitter symbols picker using nvim-treesitter

[231tr0n]

I wrote a mini.pick picker for tree sitter symbols using locals queries from nvim-treesitter. I might or might not have taken a reference from fzf-lua for this 😏. Hope someone finds it useful. Also I apologize for pinging @echasnovski, but is there any chance this can be added as an official picker in mini.extra?

	MiniPick.registry.treesitter_symbols = function(opts)
		local __has_ts, _ = pcall(require, "nvim-treesitter")
		if not __has_ts then
			vim.notify("Treesitter_symbols picker requires nvim-treesitter.", vim.log.levels.ERROR)
			return
		end

		local buf = vim.api.nvim_get_current_buf()
		if not vim.bo.filetype then
			vim.notify("Cannot determine filetype for current buffer.", vim.log.levels.ERROR)
			return
		end

		local lang = vim.treesitter.language.get_lang(vim.bo.filetype)
		if not lang then
			vim.notify("Cannot determine treesitter langugage for current buffer.", vim.log.levels.ERROR)
			return
		end

		local parser = vim.treesitter.get_parser(buf)
		if not parser then
			vim.notify("Cannot get parser for current buffer.", vim.log.levels.ERROR)
			return
		end
		parser:parse()

		local root = parser:trees()[1]:root()
		if not root then
			vim.notify("Cannot get tree root for current buffer.", vim.log.levels.ERROR)
			return
		end

		local query = (vim.treesitter.query.get(lang, "locals"))
		if not query then
			vim.notify("Cannot get locals queries for current buffer.", vim.log.levels.ERROR)
			return
		end

		local get = function(bufnr)
			local definitions = {}
			local scopes = {}
			local references = {}

			for id, node, metadata in query:iter_captures(root, bufnr) do
				local kind = query.captures[id]

				local scope = "local"
				for k, v in pairs(metadata) do
					if type(k) == "string" and vim.endswith(k, "local.scope") then
						scope = v
					end
				end
				if node and vim.startswith(kind, "local.definition") then
					table.insert(definitions, { kind = kind, node = node, scope = scope })
				end
				if node and kind == "local.scope" then
					table.insert(scopes, node)
				end
				if node and kind == "local.reference" then
					table.insert(references, { kind = kind, node = node, scope = scope })
				end
			end

			return definitions, references, scopes
		end

		local function recurse_local_nodes(local_def, accumulator, full_match, last_match)
			if type(local_def) ~= "table" then
				return
			end
			if local_def.node then
				accumulator(local_def, local_def.node, full_match, last_match)
			else
				for match_key, def in pairs(local_def) do
					recurse_local_nodes(
						def,
						accumulator,
						full_match and (full_match .. "." .. match_key) or match_key,
						match_key
					)
				end
			end
		end

		local get_local_nodes = function(local_def)
			local result = {}
			recurse_local_nodes(local_def, function(def, _, kind)
				table.insert(result, vim.tbl_extend("keep", { kind = kind }, def))
			end)
			return result
		end

		local kind_map = {
			var = "variable",
			parameter = "typeparameter",
			associated = "property",
		}

		local entries = {}
		for _, definition in ipairs(get(buf)) do
			local nodes = get_local_nodes(definition)
			for _, node in ipairs(nodes) do
				if node.node then
					node.kind = node.kind and node.kind:gsub(".*%.", "")
					local lnum, col, end_lnum, end_col = vim.treesitter.get_node_range(node.node)
					local node_text = vim.treesitter.get_node_text(node.node, buf)
					local node_kind = node.kind or ""
					node_kind = kind_map[node_kind] or node_kind
					local icon, _, _ = MiniIcons.get("lsp", node_kind)
					entries[#entries + 1] = {
						text = string.format("%s [%s %s]", node_text, icon, node_kind),
						bufnr = buf,
						lnum = lnum + 1,
						col = col + 1,
						end_lnum = end_lnum + 1,
						end_col = end_col + 1,
					}
				end
			end
		end

		MiniPick.start(
			vim.tbl_deep_extend("force", opts or {}, { source = { items = entries, name = "Tree-sitter symbols" } })
		)
	end

[echasnovski]

Thanks for sharing!

Also I apologize for pinging @echasnovski, but is there any chance this can be added as an official picker in mini.extra?

There is already a picker for tree-sitter nodes. Would you mind elaborating (maybe with demo) about how this is different.

But I'd still say that this is unlikely to get into 'mini.extra'. Mostly because it seems to look similar to what a future 'mini.hierarchy' will do.

[echasnovski]

Yeah, that sounds nice. But the fact that this depends on tree-sitter queries is a pretty big downside, at least for now. Maybe in the future something will change.

[231tr0n]

The queries are from nvim-treesitter which is a must install plugin and it handles all the queries. Basically, the locals.scm file in each queries language folder is what is used in this snippet. Anyway, I had one more question about highlighting each entry using the hl group returned by MiniIcons.get. I could not find anything in the default_show documentation on how can I get each entry highlighted. Can you help me figure out how can I get the entries highlighted like in lsp symbols picker.

[echasnovski]

I could not find anything in the default_show documentation on how can I get each entry highlighted. Can you help me figure out how can I get the entries highlighted like in lsp symbols picker.

Basically:

• Apply MiniPick.default_show().
• Clear all custom highlighting (from separate custom namespace) in the target buffer from previous show calls in the current picker session.
• Add highlighting manually with vim.api.nvim_buf_set_extmark().

If you want it to work like :Pick lsp scope='document_symbol', then its source code should be the best guide:

• This part computes decoration data. It is added once during item computation.
• Define custom show.
• Use custom show.

[231tr0n]

Echansnovski I just wanted to know if it is in scope of the default show to parse and render colors with out us setting watermarks.
So basically if the text field in source entries is provided like this "%#MiniCyan# bla bla %#MiniPickNormal#". It should highlight the entries with respective colors similar to statusline.

[echasnovski]

So basically if the text field in source entries is provided like this "%#MiniCyan# bla bla %#MiniPickNormal#". It should highlight the entries with respective colors similar to statusline.

This is out of scope.

The suggested way to add custom highlighting is add it manually with extmarks. Probably after calling default_show().