kristoferssolo/telescope-frecency.nvim
1
0
Fork 0
mirror of https://github.com/kristoferssolo/telescope-frecency.nvim.git synced 2025-10-21 20:10:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add doc for config.setup() and ignore_* (#227)

Browse Source
This commit is contained in:
JINNOUCHI Yasushi 2024-07-15 10:47:51 +09:00 committed by GitHub
parent be5add7248
commit 8241382c53
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/telescope-frecency.txt
View File

@ -350,6 +350,17 @@ lua-ls. https://github.com/LuaLS/lua-language-server
},
}
<
*telescope-frecency-configuration-config.setup()*
You can change this configuration after loading plugins by `config.setup()`.
>lua
require("frecency.config").setup {
auto_validate = true,
ignore_patterns = { "*/.git", "*/.git/*", "*/.DS_Store" },
}
<
This function always resets the config to default values, and applies supplied
ones. So you should set the whole configs for calling this function.
*telescope-frecency-configuration-auto_validate*
auto_validate ~
@ -441,11 +452,14 @@ ignore_patterns ~
Default:
for non-Windows: `{ "*.git/*", "*/tmp/*", "term://*" }`
for Windows: `{ [[*.git\*]], [[*\tmp\*]], "term://*" }`
Type: `string`
Type: `string[]`
Glob patterns in this table control which files are indexed (and subsequently
which you'll see in the finder results).
NOTE: In registering, |telescope-frecency-configuration-ignore_register| is
applied before this patterns
*telescope-frecency-configuration-ignore_register*
ignore_register ~
@ -468,6 +482,9 @@ For example, you can ignore |'nobuflisted'| buffers to register with this below.
},
}
<
NOTE: In registering, |telescope-frecency-configuration-ignore_patterns| is also
applied in addition to this function.
*telescope-frecency-configuration-matcher*
matcher ~