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

docs: update for git_files and live_grep (#2133)

Browse Source
This commit is contained in:
Sam Rosenthal
2022-09-04 15:55:54 -04:00
committed by GitHub
parent 2b5060362b
commit bd9e8a7eac
3 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -270,9 +270,9 @@ Built-in functions. Ready to be bound to any key you like.
| Functions | Description |
|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| `builtin.find_files` | Lists files in your current working directory, respects .gitignore |
| `builtin.git_files` | Fuzzy search through the output of `git ls-files` command, respects .gitignore, optionally ignores untracked files |
| `builtin.git_files` | Fuzzy search through the output of `git ls-files` command, respects .gitignore |
| `builtin.grep_string` | Searches for the string under your cursor in your current working directory |
| `builtin.live_grep` | Search for a string in your current working directory and get results live as you type (respecting .gitignore) |
| `builtin.live_grep` | Search for a string in your current working directory and get results live as you type, respects .gitignore |
### Vim Pickers

6
doc/telescope.txt
View File

@@ -765,8 +765,7 @@ options you want to use. Here's an example with the live_grep picker:
<
builtin.live_grep({opts}) *telescope.builtin.live_grep()*
Search for a string and get results live as you type (respecting
.gitignore)
Search for a string and get results live as you type, respects .gitignore
Parameters: ~
@@ -938,8 +937,7 @@ builtin.current_buffer_tags({opts}) *telescope.builtin.current_buffer_tags()*
builtin.git_files({opts}) *telescope.builtin.git_files()*
Fuzzy search for files tracked by Git. This command lists the output of the
`git ls-files` command, respects .gitignore, and optionally ignores
untracked files
`git ls-files` command, respects .gitignore
- Default keymaps:
- `<cr>`: opens the currently selected file

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

@@ -45,7 +45,7 @@ end
--
--
--- Search for a string and get results live as you type (respecting .gitignore)
--- Search for a string and get results live as you type, respects .gitignore
---@param opts table: options to pass to the picker
---@field cwd string: root dir to search from (default: cwd, use utils.buffer_dir() to search relative to open buffer)
---@field grep_open_files boolean: if true, restrict search to open files only, mutually exclusive with `search_dirs`
@@ -123,8 +123,8 @@ builtin.current_buffer_tags = require_on_exported_call("telescope.builtin.__file
--
--
--- Fuzzy search for files tracked by Git. This command lists the output of the `git ls-files` command, respects
--- .gitignore, and optionally ignores untracked files
--- Fuzzy search for files tracked by Git. This command lists the output of the `git ls-files` command,
--- respects .gitignore
--- - Default keymaps:
--- - `<cr>`: opens the currently selected file
---@param opts table: options to pass to the picker