Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of filter columns in pickers #11218

Merged
merged 9 commits into from
Jul 24, 2024
Merged

Document use of filter columns in pickers #11218

Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ea2cb65
Document use of filter columns in pickers.
rcorre Jul 18, 2024
86e6e6d
Note that column filters are space-separated.
rcorre Jul 18, 2024
2aa831e
Note that picker filters can be abbreviated.
rcorre Jul 18, 2024
033d5fa
Specify correct picker in docs.
rcorre Jul 18, 2024
fe337b4
Clarify picker filter prefix shortenting.
rcorre Jul 18, 2024
85066a7
Move picker docs to their own section.
rcorre Jul 19, 2024
8aa5f3f
Update book/src/pickers.md
rcorre Jul 20, 2024
9c020e9
Improve docs on picker registers, keybinds, and syntax.
rcorre Jul 20, 2024
64d4c8b
Clarify wording around picker queries.
rcorre Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions book/src/keymap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,13 @@ Keys to use within picker. Remapping currently not supported.
| `Ctrl-t` | Toggle preview |
| `Escape`, `Ctrl-c` | Close picker |

In pickers, you can filter specific columns by prefixing the column name with `%`.
All words after a `%<column>` term are treated as filters for that column.
The base filter is a regex, while column filters are a space-separated of literals.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually columns use fuzzy filtering. There are two exceptions: the default columns for global_search and the LSP workspace_symbol_picker. global_search's default column is a regex and workspace_symbol_picker's is sent to the language server so it can do its own filtering.

For example, in the global search picker, `init %path api .proto` searches for files containing
the text "init", whose filenames contain "api" and ".proto".
Column names can be abbreviated, so `%p` means the same as `%path`.
rcorre marked this conversation as resolved.
Show resolved Hide resolved

## Prompt

Keys to use within prompt, Remapping currently not supported.
Expand Down
Loading