summaryrefslogtreecommitdiff
path: root/lua/telescope/config.lua
diff options
context:
space:
mode:
authorSimon Hauser <Simon-Hauser@outlook.de>2022-05-22 11:32:55 +0200
committerSimon Hauser <simon.hauser@helsinki-systems.de>2022-06-30 14:01:49 +0200
commitedc6f55ba2565930310542b3023f00e88dd3e6a8 (patch)
treea8f4d792c795468f940a1a1a90a37e35bbbb32bd /lua/telescope/config.lua
parent4482c2b551a36b4a1d27a59e0d4d53a3fdb7ccbd (diff)
docs: document limitations of file_ignore_patterns and transform_path (#1955)
Diffstat (limited to 'lua/telescope/config.lua')
-rw-r--r--lua/telescope/config.lua11
1 files changed, 11 insertions, 0 deletions
diff --git a/lua/telescope/config.lua b/lua/telescope/config.lua
index f5cc3c6..88f8a59 100644
--- a/lua/telescope/config.lua
+++ b/lua/telescope/config.lua
@@ -783,6 +783,17 @@ append(
Example: { "%.npz" } -- ignore all npz files
See: https://www.lua.org/manual/5.1/manual.html#5.4.1 for more
information about lua regex
+ Note: `file_ignore_patterns` will be used in all pickers that have a
+ file associated. This might lead to the problem that lsp_ pickers
+ aren't displaying results because they might be ignored by
+ `file_ignore_patterns`. For example, setting up node_modules as ignored
+ will never show node_modules in any results, even if you are
+ interested in lsp_ results.
+
+ If you only want `file_ignore_patterns` for `find_files` and
+ `grep_string`/`live_grep` it is suggested that you setup `gitignore`
+ and have fd and or ripgrep installed because both tools will not show
+ `gitignore`d files on default.
Default: nil]]
)