Add glob pattern filter settings to snippets #284165
Open
+192
−11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds glob pattern filtering capabilities to VS Code snippets through new include and exclude settings in the snippet schema. Users can now restrict snippets to specific files using glob patterns similar to those used in files.exclude and search settings.
Key changes:
- Added
includeandexcludefields to snippet schema that accept glob patterns - Modified snippet selection logic to filter snippets based on file URI matching glob patterns
- Updated completion provider to pass file URI for pattern matching
- Added comprehensive test coverage for include/exclude pattern filtering
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/vs/workbench/contrib/snippets/browser/snippetsFile.ts |
Added include and exclude fields to Snippet class, implemented isFileIncluded() method with glob pattern matching, updated select() method to filter snippets by file URI |
src/vs/workbench/contrib/snippets/browser/snippets.ts |
Updated ISnippetsService interface to add optional resourceUri parameter to getSnippets() and getSnippetsSync() methods |
src/vs/workbench/contrib/snippets/browser/snippetsService.ts |
Updated service implementation to pass resourceUri parameter through to snippet file selection logic |
src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts |
Updated completion provider to pass model.uri when fetching snippets for file-specific filtering |
src/vs/workbench/contrib/snippets/browser/snippets.contribution.ts |
Added JSON schema definitions for include and exclude fields with markdown documentation and examples |
src/vs/workbench/contrib/snippets/browser/commands/configureSnippets.ts |
Updated snippet file templates to include documentation and examples for the new include/exclude patterns |
src/vs/workbench/contrib/snippets/test/browser/snippetFile.test.ts |
Added comprehensive tests for include patterns, exclude patterns, and combined include/exclude scenarios |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 #75955
Added
includeandexcludesettings to snippet schema to allow specifying glob patterns for files which the snippet should run on, with semantics similar tofilesandsearchsettings.