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.

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

The docs for provideFileSearchResults should provide guidance how to interpret pattern #226730

Open
jrieken opened this issue Aug 27, 2024 · 0 comments
Assignees
Labels
polish Cleanup and polish issue search Search widget and operation issues
Milestone

Comments

@jrieken
Copy link
Member

jrieken commented Aug 27, 2024

Testing #226668

Today, the docs just say "The search pattern to match against file paths." This leaves a lot of room for speculation and it's not clear if matching is substring, startWith, case-sensitive, fuzzy etc.

For the WorkspaceSymbolProvider api we have very similar challenge and with it we are very explicit how the search string should be interpreted:

* The `query`-parameter should be interpreted in a *relaxed way* as the editor will apply its own highlighting
* and scoring on the results. A good rule of thumb is to match case-insensitive and to simply check that the
* characters of *query* appear in their order in a candidate symbol. Don't use prefix, substring, or similar
* strict matching.

@andreamah andreamah added search Search widget and operation issues polish Cleanup and polish issue labels Sep 3, 2024
@andreamah andreamah added this to the September 2024 milestone Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
polish Cleanup and polish issue search Search widget and operation issues
Projects
None yet
Development

No branches or pull requests

2 participants