ReadonlyonAn event to signal that a resource has been created, changed, or deleted. This event should fire for resources that are being watched by clients of this provider.
Note: It is important that the metadata of the file that changed provides an
updated mtime that advanced from the previous value in the stat and a
correct size value. Otherwise there may be optimizations in place that will not show
the change in an editor for example.
OptionalcopyCopy files or folders. Implementing this function is optional but it will speedup the copy operation.
FileNotFound when source doesn't exist.
FileNotFound when parent of destination doesn't exist, e.g. no mkdirp-logic required.
FileExists when destination exists and when the overwrite option is not true.
NoPermissions when permissions aren't sufficient.
Create a new directory (Note, that new files are created via write-calls).
The uri of the new folder.
FileNotFound when the parent of uri doesn't exist, e.g. no mkdirp-logic required.
FileExists when uri already exists.
NoPermissions when permissions aren't sufficient.
Delete a file.
The resource that is to be deleted.
Defines if deletion of folders is recursive.
Readonlyrecursive: booleanDelete the content recursively if a folder is denoted.
FileNotFound when uri doesn't exist.
NoPermissions when permissions aren't sufficient.
Read the entire contents of a file.
The uri of the file.
An array of bytes or a thenable that resolves to such.
FileNotFound when uri doesn't exist.
Rename a file or folder.
FileNotFound when oldUri doesn't exist.
FileNotFound when parent of newUri doesn't exist, e.g. no mkdirp-logic required.
FileExists when newUri exists and when the overwrite option is not true.
NoPermissions when permissions aren't sufficient.
Retrieve metadata about a file.
Note that the metadata for symbolic links should be the metadata of the file they refer to.
Still, the SymbolicLink-type must be used in addition to the actual type, e.g.
FileType.SymbolicLink | FileType.Directory.
The uri of the file to retrieve metadata about.
The file metadata about the file.
FileNotFound when uri doesn't exist.
Subscribes to file change events in the file or folder denoted by uri. For folders,
the option recursive indicates whether subfolders, sub-subfolders, etc. should
be watched for file changes as well. With recursive: false, only changes to the
files that are direct children of the folder should trigger an event.
The excludes array is used to indicate paths that should be excluded from file
watching. It is typically derived from the files.watcherExclude setting that
is configurable by the user. Each entry can be be:
build/output)**/build, output/**)Note that case-sensitivity of the 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 onDidChangeFile
for every change given these rules. No event should be emitted for files that match any of the provided
excludes.
The uri of the file or folder to be watched.
Configures the watch.
Readonlyexcludes: readonly string[]A list of paths and pattern to exclude from watching.
Readonlyrecursive: booleanWhen enabled also watch subfolders.
A disposable that tells the provider to stop watching the uri.
Write data to a file, replacing its entire contents.
The uri of the file.
The new content of the file.
Defines if missing files should or must be created.
Readonlycreate: booleanCreate the file if it does not exist already.
Readonlyoverwrite: booleanOverwrite the file if it does exist.
FileNotFound when uri doesn't exist and create is not set.
FileNotFound when the parent of uri doesn't exist and create is set, e.g. no mkdirp-logic required.
FileExists when uri already exists, create is set but overwrite is not set.
NoPermissions when permissions aren't sufficient.
The filesystem provider defines what the editor needs to read, write, discover, and to manage files and folders. It allows extensions to serve files from remote places, like ftp-servers, and to seamlessly integrate those into the editor.
foo:/my/pathis a child offoo:/my/and a parent offoo:/my/path/deeper.onFileSystem:<scheme>that fires when a file or folder is being accessed.