Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-20 02:08:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #280037 from microsoft/dev/dmitriv/watch-api-comments

Browse Source 
Update public watcher APIs to reflect glob case-sensitivity changes
This commit is contained in:
Dmitriy Vasyura
2025-12-01 05:07:42 -08:00
committed by GitHub
parent 96a90aa18e ae7f5ec803
commit 8f9dd683ca
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/vscode-dts/vscode.d.ts vendored
View File

@@ -9591,6 +9591,10 @@ declare module 'vscode' {
* - a relative path to exclude (for example `build/output`) * - a relative path to exclude (for example `build/output`)
* - a simple glob pattern (for example `**​/build`, `output/**`) * - a simple glob pattern (for example `**​/build`, `output/**`)
* *
* *Note* that case-sensitivity of the {@link excludes} patterns for built-in file system providers
* will depend on the underlying file system: on Windows and macOS the matching will be case-insensitive and
* on Linux it will be case-sensitive.
*
* It is the file system provider's job to call {@linkcode FileSystemProvider.onDidChangeFile onDidChangeFile} * It is the file system provider's job to call {@linkcode FileSystemProvider.onDidChangeFile onDidChangeFile}
* for every change given these rules. No event should be emitted for files that match any of the provided * for every change given these rules. No event should be emitted for files that match any of the provided
* excludes. * excludes.
@@ -13889,6 +13893,10 @@ declare module 'vscode' {
* all opened workspace folders. It cannot be used to add more folders for file watching, nor will * all opened workspace folders. It cannot be used to add more folders for file watching, nor will
* it report any file events from folders that are not part of the opened workspace folders. * it report any file events from folders that are not part of the opened workspace folders.
* *
* *Note* that case-sensitivity of the {@link globPattern} parameter will depend on the file system
* where the watcher is running: on Windows and macOS the matching will be case-insensitive and
* on Linux it will be case-sensitive.
*
* Optionally, flags to ignore certain kinds of events can be provided. * Optionally, flags to ignore certain kinds of events can be provided.
* *
* To stop listening to events the watcher must be disposed. * To stop listening to events the watcher must be disposed.
@@ -13896,7 +13904,7 @@ declare module 'vscode' {
* *Note* that file events from deleting a folder may not include events for the contained files. * *Note* that file events from deleting a folder may not include events for the contained files.
* For example, when a folder is moved to the trash, only one event is reported because technically * For example, when a folder is moved to the trash, only one event is reported because technically
* this is a rename/move operation and not a delete operation for each files within. * this is a rename/move operation and not a delete operation for each files within.
* On top of that, performance optimisations are in place to fold multiple events that all belong * On top of that, performance optimizations are in place to fold multiple events that all belong
* to the same parent operation (e.g. delete folder) into one event for that parent. As such, if * to the same parent operation (e.g. delete folder) into one event for that parent. As such, if
* you need to know about all deleted files, you have to watch with `**` and deal with all file * you need to know about all deleted files, you have to watch with `**` and deal with all file
* events yourself. * events yourself.