From d98aca17bbc17a2632cdfaa1978dbaa211350b64 Mon Sep 17 00:00:00 2001 From: Evgeni Chasnovski Date: Tue, 17 Oct 2023 15:14:01 +0300 Subject: [PATCH] (mini.pick) Add notes about configuring CLI tools. Details: - See #516, #522. --- doc/mini-pick.txt | 2 ++ lua/mini/pick.lua | 2 ++ readmes/mini-pick.md | 1 + 3 files changed, 5 insertions(+) diff --git a/doc/mini-pick.txt b/doc/mini-pick.txt index 45e9b7fb..19dfe7a9 100644 --- a/doc/mini-pick.txt +++ b/doc/mini-pick.txt @@ -73,6 +73,8 @@ Suggested dependencies (provide extra functionality, will work without them): - `rg` ('github.com/BurntSushi/ripgrep'; enough for all three; recommended). - `fd` ('github.com/sharkdp/fd'; for `files` only). - `git` ('github.com/git/git'; enough for all three). + Note: CLI tools are called only with basic arguments needed to get items. + To customize the output, use their respective configuration approaches. # Setup ~ diff --git a/lua/mini/pick.lua b/lua/mini/pick.lua index 4433cc04..f3b90cdc 100644 --- a/lua/mini/pick.lua +++ b/lua/mini/pick.lua @@ -73,6 +73,8 @@ --- - `rg` ('github.com/BurntSushi/ripgrep'; enough for all three; recommended). --- - `fd` ('github.com/sharkdp/fd'; for `files` only). --- - `git` ('github.com/git/git'; enough for all three). +--- Note: CLI tools are called only with basic arguments needed to get items. +--- To customize the output, use their respective configuration approaches. --- --- # Setup ~ --- diff --git a/readmes/mini-pick.md b/readmes/mini-pick.md index 0df6e3dc..9b9bb0fe 100644 --- a/readmes/mini-pick.md +++ b/readmes/mini-pick.md @@ -71,6 +71,7 @@ https://github.com/echasnovski/mini.nvim/assets/24854248/65849d1e-3f96-4085-a4cf Notes: - Works on all supported versions but using Neovim>=0.9 is recommended. Neovim>=0.10 will give more visual feedback in floating window footer. +- CLI tools are called only with basic arguments needed to get items. To customize the output, use their respective configuration approaches. For example, here is the [suggested approach for `ripgrep`](https://github.com/BurntSushi/ripgrep/blob/master/GUIDE.md#configuration-file). Read more information, see these tags in help file: - `*MiniPick-overview*` -- knotmirror 0.0.1