leigh/telescope.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: allow table as additional args in live grep and grep string (#2139)

Browse Source
This commit is contained in:
Gutyina Gergő
2022-10-24 08:44:13 +02:00
committed by GitHub
parent 286628d9f2
commit 5c7db4055d
3 changed files with 60 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
doc/telescope.txt
View File

@@ -776,21 +776,21 @@ builtin.live_grep({opts}) *telescope.builtin.live_grep()*
(default: cwd, use (default: cwd, use
utils.buffer_dir() to search utils.buffer_dir() to search
relative to open buffer) relative to open buffer)
{grep_open_files} (boolean) if true, restrict search to open {grep_open_files} (boolean) if true, restrict search to
files only, mutually exclusive open files only, mutually
with `search_dirs` exclusive with `search_dirs`
{search_dirs} (table) directory/directories/files to {search_dirs} (table) directory/directories/files to
search, mutually exclusive with search, mutually exclusive
`grep_open_files` with `grep_open_files`
{glob_pattern} (string|table) argument to be used with {glob_pattern} (string|table) argument to be used with
`--glob`, e.g. "*.toml", can use `--glob`, e.g. "*.toml", can
the opposite "!*.toml" use the opposite "!*.toml"
{type_filter} (string) argument to be used with {type_filter} (string) argument to be used with
`--type`, e.g. "rust", see `rg `--type`, e.g. "rust", see `rg
--type-list` --type-list`
{additional_args} (function) function(opts) which returns a {additional_args} (function|table) additional arguments to be
table of additional arguments to passed on. Can be fn(opts) ->
be passed on tbl
{max_results} (number) define a upper result value {max_results} (number) define a upper result value
{disable_coordinates} (boolean) don't show the line & row {disable_coordinates} (boolean) don't show the line & row
numbers (default: false) numbers (default: false)
@@ -804,28 +804,30 @@ builtin.grep_string({opts}) *telescope.builtin.grep_string()*
{opts} (table) options to pass to the picker {opts} (table) options to pass to the picker
Options: ~ Options: ~
{cwd} (string) root dir to search from (default: {cwd} (string) root dir to search from
cwd, use utils.buffer_dir() to (default: cwd, use
search relative to open buffer) utils.buffer_dir() to search
relative to open buffer)
{search} (string) the query to search {search} (string) the query to search
{grep_open_files} (boolean) if true, restrict search to open {grep_open_files} (boolean) if true, restrict search to
files only, mutually exclusive with open files only, mutually
`search_dirs` exclusive with `search_dirs`
{search_dirs} (table) directory/directories/files to {search_dirs} (table) directory/directories/files to
search, mutually exclusive with search, mutually exclusive
`grep_open_files` with `grep_open_files`
{use_regex} (boolean) if true, special characters won't be {use_regex} (boolean) if true, special characters
escaped, allows for using regex won't be escaped, allows for
(default: false) using regex (default: false)
{word_match} (string) can be set to `-w` to enable exact {word_match} (string) can be set to `-w` to enable
word matches exact word matches
{additional_args} (function) function(opts) which returns a table {additional_args} (function|table) additional arguments to be
of additional arguments to be passed passed on. Can be fn(opts) ->
on tbl
{disable_coordinates} (boolean) don't show the line and row numbers {disable_coordinates} (boolean) don't show the line and row
(default: false) numbers (default: false)
{only_sort_text} (boolean) only sort the text, not the file, {only_sort_text} (boolean) only sort the text, not the
line or row (default: false) file, line or row (default:
false)
builtin.find_files({opts}) *telescope.builtin.find_files()* builtin.find_files({opts}) *telescope.builtin.find_files()*

12
lua/telescope/builtin/__files.lua
View File

@@ -76,8 +76,12 @@ files.live_grep = function(opts)
end end
local additional_args = {} local additional_args = {}
if opts.additional_args ~= nil and type(opts.additional_args) == "function" then if opts.additional_args ~= nil then
if type(opts.additional_args) == "function" then
additional_args = opts.additional_args(opts) additional_args = opts.additional_args(opts)
elseif type(opts.additional_args) == "table" then
additional_args = opts.additional_args
end
end end
if opts.type_filter then if opts.type_filter then
@@ -134,8 +138,12 @@ files.grep_string = function(opts)
local search = opts.use_regex and word or escape_chars(word) local search = opts.use_regex and word or escape_chars(word)
local additional_args = {} local additional_args = {}
if opts.additional_args ~= nil and type(opts.additional_args) == "function" then if opts.additional_args ~= nil then
if type(opts.additional_args) == "function" then
additional_args = opts.additional_args(opts) additional_args = opts.additional_args(opts)
elseif type(opts.additional_args) == "table" then
additional_args = opts.additional_args
end
end end
if search == "" then if search == "" then

4
lua/telescope/builtin/init.lua
View File

@@ -52,7 +52,7 @@ end
---@field search_dirs table: directory/directories/files to search, mutually exclusive with `grep_open_files` ---@field search_dirs table: directory/directories/files to search, mutually exclusive with `grep_open_files`
---@field glob_pattern string|table: argument to be used with `--glob`, e.g. "*.toml", can use the opposite "!*.toml" ---@field glob_pattern string|table: argument to be used with `--glob`, e.g. "*.toml", can use the opposite "!*.toml"
---@field type_filter string: argument to be used with `--type`, e.g. "rust", see `rg --type-list` ---@field type_filter string: argument to be used with `--type`, e.g. "rust", see `rg --type-list`
---@field additional_args function: function(opts) which returns a table of additional arguments to be passed on ---@field additional_args function|table: additional arguments to be passed on. Can be fn(opts) -> tbl
---@field max_results number: define a upper result value ---@field max_results number: define a upper result value
---@field disable_coordinates boolean: don't show the line & row numbers (default: false) ---@field disable_coordinates boolean: don't show the line & row numbers (default: false)
builtin.live_grep = require_on_exported_call("telescope.builtin.__files").live_grep builtin.live_grep = require_on_exported_call("telescope.builtin.__files").live_grep
@@ -65,7 +65,7 @@ builtin.live_grep = require_on_exported_call("telescope.builtin.__files").live_g
---@field search_dirs table: directory/directories/files to search, mutually exclusive with `grep_open_files` ---@field search_dirs table: directory/directories/files to search, mutually exclusive with `grep_open_files`
---@field use_regex boolean: if true, special characters won't be escaped, allows for using regex (default: false) ---@field use_regex boolean: if true, special characters won't be escaped, allows for using regex (default: false)
---@field word_match string: can be set to `-w` to enable exact word matches ---@field word_match string: can be set to `-w` to enable exact word matches
---@field additional_args function: function(opts) which returns a table of additional arguments to be passed on ---@field additional_args function|table: additional arguments to be passed on. Can be fn(opts) -> tbl
---@field disable_coordinates boolean: don't show the line and row numbers (default: false) ---@field disable_coordinates boolean: don't show the line and row numbers (default: false)
---@field only_sort_text boolean: only sort the text, not the file, line or row (default: false) ---@field only_sort_text boolean: only sort the text, not the file, line or row (default: false)
builtin.grep_string = require_on_exported_call("telescope.builtin.__files").grep_string builtin.grep_string = require_on_exported_call("telescope.builtin.__files").grep_string