Improve FileSearchProvider pattern documentation with explicit matching guidance #275956
+31
−10
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #226668
The
FileSearchQuery.patternandFileSearchProvider2.provideFileSearchResultsdocumentation lacked clear guidance on pattern interpretation, unlikeWorkspaceSymbolProviderwhich explicitly specifies matching behavior.Changes
Updated documentation across public APIs and internal types to provide explicit matching guidance:
Pattern interpretation guidance added:
Files updated:
vscode.proposed.fileSearchProvider.d.ts-FileSearchQuery.patternvscode.proposed.fileSearchProvider2.d.ts-FileSearchProvider2.provideFileSearchResultssearchExtConversionTypes.ts- InternalFileSearchQueryinterfacesearchExtTypes.ts- InternalFileSearchProvider2interfaces (also fixed incorrect@paramreferences to non-existent parameters)Documentation now matches
WorkspaceSymbolProviderstyle and clarity, eliminating ambiguity about matching semantics.Original prompt
provideFileSearchResultsshould provide guidance how to interpretpattern#226730✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.