zoriya/telescope.nvim
1
0
Fork 0
mirror of https://github.com/zoriya/telescope.nvim.git synced 2025-12-06 06:46:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docgen] Update doc/telescope.txt

Browse Source 
skip-checks: true
This commit is contained in:
Github Actions
2023-06-24 17:44:00 +00:00
parent 16aacf6443
commit a8d7185eac
1 changed files with 18 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
doc/telescope.txt
View File

@@ -529,20 +529,11 @@ telescope.setup({opts}) *telescope.setup()*
vimgrep_arguments: ~ vimgrep_arguments: ~
Defines the command that will be used for `live_grep` and `grep_string` Defines the command that will be used for `live_grep` and `grep_string`
pickers. pickers.
Hint: Make sure that color is currently set to `never` because we do
not yet interpret color codes
Hint 2: Make sure that these options are in your changes arguments:
"--no-heading", "--with-filename", "--line-number", "--column"
because we need them so the ripgrep output is in the correct format.
Default: { Default: {
"rg", "rg",
"--color=never", "--smart-case",
"--no-heading", "--json",
"--with-filename",
"--line-number",
"--column",
"--smart-case"
} }
*telescope.defaults.use_less* *telescope.defaults.use_less*
@@ -795,10 +786,14 @@ builtin.live_grep({opts}) *telescope.builtin.live_grep()*
{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`
{use_regex} (boolean) if true, special characters
won't be escaped, allows for
using regex (default: false)
{word_match} (string) can be set to `-w` to enable
exact word matches
{additional_args} (function|table) additional arguments to be {additional_args} (function|table) additional arguments to be
passed on. Can be fn(opts) -> passed on. Can be fn(opts) ->
tbl tbl
{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)
{file_encoding} (string) file encoding for the entry & {file_encoding} (string) file encoding for the entry &
@@ -825,19 +820,25 @@ builtin.grep_string({opts}) *telescope.builtin.grep_string()*
{search_dirs} (table) directory/directories/files to {search_dirs} (table) directory/directories/files to
search, mutually exclusive search, mutually exclusive
with `grep_open_files` with `grep_open_files`
{glob_pattern} (string|table) argument to be used with
`--glob`, e.g. "*.toml", can
use the opposite "!*.toml"
{type_filter} (string) argument to be used with
`--type`, e.g. "rust", see `rg
--type-list`
{additional_args} (function|table) additional arguments to be
passed on. Can be fn(opts) ->
tbl
{use_regex} (boolean) if true, special characters {use_regex} (boolean) if true, special characters
won't be escaped, allows for won't be escaped, allows for
using regex (default: false) using regex (default: false)
{word_match} (string) can be set to `-w` to enable {word_match} (string) can be set to `-w` to enable
exact word matches exact word matches
{additional_args} (function|table) additional arguments to be
passed on. Can be fn(opts) ->
tbl
{disable_coordinates} (boolean) don't show the line and row
numbers (default: false)
{only_sort_text} (boolean) only sort the text, not the {only_sort_text} (boolean) only sort the text, not the
file, line or row (default: file, line or row (default:
false) false)
{disable_coordinates} (boolean) don't show the line and row
numbers (default: false)
{file_encoding} (string) file encoding for the entry & {file_encoding} (string) file encoding for the entry &
previewer previewer