import { VSBuffer, VSBufferReadable, VSBufferReadableStream } from '../../../base/common/buffer.js'; import { CancellationToken } from '../../../base/common/cancellation.js'; import { Event } from '../../../base/common/event.js'; import { IRelativePattern } from '../../../base/common/glob.js'; import { IDisposable } from '../../../base/common/lifecycle.js'; import { ReadableStreamEvents } from '../../../base/common/stream.js'; import { URI } from '../../../base/common/uri.js'; export declare const IFileService: import("../../instantiation/common/instantiation.js").ServiceIdentifier; export interface IFileService { readonly _serviceBrand: undefined; /** * An event that is fired when a file system provider is added or removed */ readonly onDidChangeFileSystemProviderRegistrations: Event; /** * An event that is fired when a registered file system provider changes its capabilities. */ readonly onDidChangeFileSystemProviderCapabilities: Event; /** * An event that is fired when a file system provider is about to be activated. Listeners * can join this event with a long running promise to help in the activation process. */ readonly onWillActivateFileSystemProvider: Event; /** * Registers a file system provider for a certain scheme. */ registerProvider(scheme: string, provider: IFileSystemProvider): IDisposable; /** * Returns a file system provider for a certain scheme. */ getProvider(scheme: string): IFileSystemProvider | undefined; /** * Tries to activate a provider with the given scheme. */ activateProvider(scheme: string): Promise; /** * Checks if this file service can handle the given resource by * first activating any extension that wants to be activated * on the provided resource scheme to include extensions that * contribute file system providers for the given resource. */ canHandleResource(resource: URI): Promise; /** * Checks if the file service has a registered provider for the * provided resource. * * Note: this does NOT account for contributed providers from * extensions that have not been activated yet. To include those, * consider to call `await fileService.canHandleResource(resource)`. */ hasProvider(resource: URI): boolean; /** * Checks if the provider for the provided resource has the provided file system capability. */ hasCapability(resource: URI, capability: FileSystemProviderCapabilities): boolean; /** * List the schemes and capabilities for registered file system providers */ listCapabilities(): Iterable<{ scheme: string; capabilities: FileSystemProviderCapabilities; }>; /** * Allows to listen for file changes. The event will fire for every file within the opened workspace * (if any) as well as all files that have been watched explicitly using the #watch() API. */ readonly onDidFilesChange: Event; /** * An event that is fired upon successful completion of a certain file operation. */ readonly onDidRunOperation: Event; /** * Resolve the properties of a file/folder identified by the resource. For a folder, children * information is resolved as well depending on the provided options. Use `stat()` method if * you do not need children information. * * If the optional parameter "resolveTo" is specified in options, the stat service is asked * to provide a stat object that should contain the full graph of folders up to all of the * target resources. * * If the optional parameter "resolveSingleChildDescendants" is specified in options, * the stat service is asked to automatically resolve child folders that only * contain a single element. * * If the optional parameter "resolveMetadata" is specified in options, * the stat will contain metadata information such as size, mtime and etag. */ resolve(resource: URI, options: IResolveMetadataFileOptions): Promise; resolve(resource: URI, options?: IResolveFileOptions): Promise; /** * Same as `resolve()` but supports resolving multiple resources in parallel. * * If one of the resolve targets fails to resolve returns a fake `IFileStat` instead of * making the whole call fail. */ resolveAll(toResolve: { resource: URI; options: IResolveMetadataFileOptions; }[]): Promise; resolveAll(toResolve: { resource: URI; options?: IResolveFileOptions; }[]): Promise; /** * Same as `resolve()` but without resolving the children of a folder if the * resource is pointing to a folder. */ stat(resource: URI): Promise; /** * Finds out if a file/folder identified by the resource exists. */ exists(resource: URI): Promise; /** * Read the contents of the provided resource unbuffered. */ readFile(resource: URI, options?: IReadFileOptions, token?: CancellationToken): Promise; /** * Read the contents of the provided resource buffered as stream. */ readFileStream(resource: URI, options?: IReadFileStreamOptions, token?: CancellationToken): Promise; /** * Updates the content replacing its previous value. * * Emits a `FileOperation.WRITE` file operation event when successful. */ writeFile(resource: URI, bufferOrReadableOrStream: VSBuffer | VSBufferReadable | VSBufferReadableStream, options?: IWriteFileOptions): Promise; /** * Moves the file/folder to a new path identified by the resource. * * The optional parameter overwrite can be set to replace an existing file at the location. * * Emits a `FileOperation.MOVE` file operation event when successful. */ move(source: URI, target: URI, overwrite?: boolean): Promise; /** * Find out if a move operation is possible given the arguments. No changes on disk will * be performed. Returns an Error if the operation cannot be done. */ canMove(source: URI, target: URI, overwrite?: boolean): Promise; /** * Copies the file/folder to a path identified by the resource. A folder is copied * recursively. * * Emits a `FileOperation.COPY` file operation event when successful. */ copy(source: URI, target: URI, overwrite?: boolean): Promise; /** * Find out if a copy operation is possible given the arguments. No changes on disk will * be performed. Returns an Error if the operation cannot be done. */ canCopy(source: URI, target: URI, overwrite?: boolean): Promise; /** * Clones a file to a path identified by the resource. Folders are not supported. * * If the target path exists, it will be overwritten. */ cloneFile(source: URI, target: URI): Promise; /** * Creates a new file with the given path and optional contents. The returned promise * will have the stat model object as a result. * * The optional parameter content can be used as value to fill into the new file. * * Emits a `FileOperation.CREATE` file operation event when successful. */ createFile(resource: URI, bufferOrReadableOrStream?: VSBuffer | VSBufferReadable | VSBufferReadableStream, options?: ICreateFileOptions): Promise; /** * Find out if a file create operation is possible given the arguments. No changes on disk will * be performed. Returns an Error if the operation cannot be done. */ canCreateFile(resource: URI, options?: ICreateFileOptions): Promise; /** * Creates a new folder with the given path. The returned promise * will have the stat model object as a result. * * Emits a `FileOperation.CREATE` file operation event when successful. */ createFolder(resource: URI): Promise; /** * Deletes the provided file. The optional useTrash parameter allows to * move the file to trash. The optional recursive parameter allows to delete * non-empty folders recursively. * * Emits a `FileOperation.DELETE` file operation event when successful. */ del(resource: URI, options?: Partial): Promise; /** * Find out if a delete operation is possible given the arguments. No changes on disk will * be performed. Returns an Error if the operation cannot be done. */ canDelete(resource: URI, options?: Partial): Promise; /** * An event that signals an error when watching for file changes. */ readonly onDidWatchError: Event; /** * Allows to start a watcher that reports file/folder change events on the provided resource. * * The watcher runs correlated and thus, file events will be reported on the returned * `IFileSystemWatcher` and not on the generic `IFileService.onDidFilesChange` event. */ createWatcher(resource: URI, options: IWatchOptionsWithoutCorrelation): IFileSystemWatcher; /** * Allows to start a watcher that reports file/folder change events on the provided resource. * * The watcher runs uncorrelated and thus will report all events from `IFileService.onDidFilesChange`. * This means, most listeners in the application will receive your events. It is encouraged to * use correlated watchers (via `IWatchOptionsWithCorrelation`) to limit events to your listener. */ watch(resource: URI, options?: IWatchOptionsWithoutCorrelation): IDisposable; /** * Frees up any resources occupied by this service. */ dispose(): void; } export interface IFileOverwriteOptions { /** * Set to `true` to overwrite a file if it exists. Will * throw an error otherwise if the file does exist. */ readonly overwrite: boolean; } export interface IFileUnlockOptions { /** * Set to `true` to try to remove any write locks the file might * have. A file that is write locked will throw an error for any * attempt to write to unless `unlock: true` is provided. */ readonly unlock: boolean; } export interface IFileAtomicOptions { /** * The postfix is used to create a temporary file based * on the original resource. The resulting temporary * file will be in the same folder as the resource and * have `postfix` appended to the resource name. * * Example: given a file resource `file:///some/path/foo.txt` * and a postfix `.vsctmp`, the temporary file will be * created as `file:///some/path/foo.txt.vsctmp`. */ readonly postfix: string; } export interface IFileAtomicWriteOptions { /** * The optional `atomic` flag can be used to make sure * the `writeFile` method updates the target file atomically * by first writing to a temporary file in the same folder * and then renaming it over the target. */ readonly atomic: IFileAtomicOptions | false; } export interface IFileReadLimits { /** * If the file exceeds the given size, an error of kind * `FILE_TOO_LARGE` will be thrown. */ size?: number; } export interface IFileReadStreamOptions { /** * Is an integer specifying where to begin reading from in the file. If position is undefined, * data will be read from the current file position. */ readonly position?: number; /** * Is an integer specifying how many bytes to read from the file. By default, all bytes * will be read. */ readonly length?: number; /** * If provided, the size of the file will be checked against the limits * and an error will be thrown if any limit is exceeded. */ readonly limits?: IFileReadLimits; } export interface IFileWriteOptions extends IFileOverwriteOptions, IFileUnlockOptions, IFileAtomicWriteOptions { /** * Set to `true` to create a file when it does not exist. Will * throw an error otherwise if the file does not exist. */ readonly create: boolean; } export type IFileOpenOptions = IFileOpenForReadOptions | IFileOpenForWriteOptions; export interface IFileOpenForReadOptions { /** * A hint that the file should be opened for reading only. */ readonly create: false; } export interface IFileOpenForWriteOptions extends IFileUnlockOptions { /** * A hint that the file should be opened for reading and writing. */ readonly create: true; } export interface IFileDeleteOptions { /** * Set to `true` to recursively delete any children of the file. This * only applies to folders and can lead to an error unless provided * if the folder is not empty. */ readonly recursive: boolean; /** * Set to `true` to attempt to move the file to trash * instead of deleting it permanently from disk. * * This option maybe not be supported on all providers. */ readonly useTrash: boolean; /** * The optional `atomic` flag can be used to make sure * the `delete` method deletes the target atomically by * first renaming it to a temporary resource in the same * folder and then deleting it. * * This option maybe not be supported on all providers. */ readonly atomic: IFileAtomicOptions | false; } export declare enum FileType { /** * File is unknown (neither file, directory nor symbolic link). */ Unknown = 0, /** * File is a normal file. */ File = 1, /** * File is a directory. */ Directory = 2, /** * File is a symbolic link. * * Note: even when the file is a symbolic link, you can test for * `FileType.File` and `FileType.Directory` to know the type of * the target the link points to. */ SymbolicLink = 64 } export declare enum FilePermission { /** * File is readonly. Components like editors should not * offer to edit the contents. */ Readonly = 1, /** * File is locked. Components like editors should offer * to edit the contents and ask the user upon saving to * remove the lock. */ Locked = 2 } export interface IStat { /** * The file type. */ readonly type: FileType; /** * The last modification date represented as millis from unix epoch. */ readonly mtime: number; /** * The creation date represented as millis from unix epoch. */ readonly ctime: number; /** * The size of the file in bytes. */ readonly size: number; /** * The file permissions. */ readonly permissions?: FilePermission; } export interface IWatchOptionsWithoutCorrelation { /** * Set to `true` to watch for changes recursively in a folder * and all of its children. */ recursive: boolean; /** * A set of glob patterns or paths to exclude from watching. * Paths can be relative or absolute and when relative are * resolved against the watched folder. Glob patterns are * always matched relative to the watched folder. */ excludes: string[]; /** * An optional set of glob patterns or paths to include for * watching. If not provided, all paths are considered for * events. * Paths can be relative or absolute and when relative are * resolved against the watched folder. Glob patterns are * always matched relative to the watched folder. */ includes?: Array; /** * If provided, allows to filter the events that the watcher should consider * for emitting. If not provided, all events are emitted. * * For example, to emit added and updated events, set to: * `FileChangeFilter.ADDED | FileChangeFilter.UPDATED`. */ filter?: FileChangeFilter; } export interface IWatchOptions extends IWatchOptionsWithoutCorrelation { /** * If provided, file change events from the watcher that * are a result of this watch request will carry the same * id. */ readonly correlationId?: number; } export declare enum FileChangeFilter { UPDATED = 2, ADDED = 4, DELETED = 8 } export interface IFileSystemWatcher extends IDisposable { /** * An event which fires on file/folder change only for changes * that correlate to the watch request with matching correlation * identifier. */ readonly onDidChange: Event; } export declare enum FileSystemProviderCapabilities { /** * No capabilities. */ None = 0, /** * Provider supports unbuffered read/write. */ FileReadWrite = 2, /** * Provider supports open/read/write/close low level file operations. */ FileOpenReadWriteClose = 4, /** * Provider supports stream based reading. */ FileReadStream = 16, /** * Provider supports copy operation. */ FileFolderCopy = 8, /** * Provider is path case sensitive. */ PathCaseSensitive = 1024, /** * All files of the provider are readonly. */ Readonly = 2048, /** * Provider supports to delete via trash. */ Trash = 4096, /** * Provider support to unlock files for writing. */ FileWriteUnlock = 8192, /** * Provider support to read files atomically. This implies the * provider provides the `FileReadWrite` capability too. */ FileAtomicRead = 16384, /** * Provider support to write files atomically. This implies the * provider provides the `FileReadWrite` capability too. */ FileAtomicWrite = 32768, /** * Provider support to delete atomically. */ FileAtomicDelete = 65536, /** * Provider support to clone files atomically. */ FileClone = 131072 } export interface IFileSystemProvider { readonly capabilities: FileSystemProviderCapabilities; readonly onDidChangeCapabilities: Event; readonly onDidChangeFile: Event; readonly onDidWatchError?: Event; watch(resource: URI, opts: IWatchOptions): IDisposable; stat(resource: URI): Promise; mkdir(resource: URI): Promise; readdir(resource: URI): Promise<[string, FileType][]>; delete(resource: URI, opts: IFileDeleteOptions): Promise; rename(from: URI, to: URI, opts: IFileOverwriteOptions): Promise; copy?(from: URI, to: URI, opts: IFileOverwriteOptions): Promise; readFile?(resource: URI): Promise; writeFile?(resource: URI, content: Uint8Array, opts: IFileWriteOptions): Promise; readFileStream?(resource: URI, opts: IFileReadStreamOptions, token: CancellationToken): ReadableStreamEvents; open?(resource: URI, opts: IFileOpenOptions): Promise; close?(fd: number): Promise; read?(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise; write?(fd: number, pos: number, data: Uint8Array, offset: number, length: number): Promise; cloneFile?(from: URI, to: URI): Promise; } export interface IFileSystemProviderRegistrationEvent { readonly added: boolean; readonly scheme: string; readonly provider?: IFileSystemProvider; } export interface IFileSystemProviderCapabilitiesChangeEvent { readonly provider: IFileSystemProvider; readonly scheme: string; } export interface IFileSystemProviderActivationEvent { readonly scheme: string; join(promise: Promise): void; } export declare enum FileOperation { CREATE = 0, DELETE = 1, MOVE = 2, COPY = 3, WRITE = 4 } export interface IFileOperationEvent { readonly resource: URI; readonly operation: FileOperation; isOperation(operation: FileOperation.DELETE | FileOperation.WRITE): boolean; isOperation(operation: FileOperation.CREATE | FileOperation.MOVE | FileOperation.COPY): this is IFileOperationEventWithMetadata; } export interface IFileOperationEventWithMetadata extends IFileOperationEvent { readonly target: IFileStatWithMetadata; } export declare class FileOperationEvent implements IFileOperationEvent { readonly resource: URI; readonly operation: FileOperation; readonly target?: IFileStatWithMetadata | undefined; constructor(resource: URI, operation: FileOperation.DELETE | FileOperation.WRITE); constructor(resource: URI, operation: FileOperation.CREATE | FileOperation.MOVE | FileOperation.COPY, target: IFileStatWithMetadata); isOperation(operation: FileOperation.DELETE | FileOperation.WRITE): boolean; isOperation(operation: FileOperation.CREATE | FileOperation.MOVE | FileOperation.COPY): this is IFileOperationEventWithMetadata; } /** * Possible changes that can occur to a file. */ export declare enum FileChangeType { UPDATED = 0, ADDED = 1, DELETED = 2 } /** * Identifies a single change in a file. */ export interface IFileChange { /** * The type of change that occurred to the file. */ type: FileChangeType; /** * The unified resource identifier of the file that changed. */ readonly resource: URI; /** * If provided when starting the file watcher, the correlation * identifier will match the original file watching request as * a way to identify the original component that is interested * in the change. */ readonly cId?: number; } export declare class FileChangesEvent { private readonly ignorePathCasing; private static readonly MIXED_CORRELATION; private readonly correlationId; constructor(changes: readonly IFileChange[], ignorePathCasing: boolean); private readonly added; private readonly updated; private readonly deleted; /** * Find out if the file change events match the provided resource. * * Note: when passing `FileChangeType.DELETED`, we consider a match * also when the parent of the resource got deleted. */ contains(resource: URI, ...types: FileChangeType[]): boolean; /** * Find out if the file change events either match the provided * resource, or contain a child of this resource. */ affects(resource: URI, ...types: FileChangeType[]): boolean; private doContains; /** * Returns if this event contains added files. */ gotAdded(): boolean; /** * Returns if this event contains deleted files. */ gotDeleted(): boolean; /** * Returns if this event contains updated files. */ gotUpdated(): boolean; /** * Returns if this event contains changes that correlate to the * provided `correlationId`. * * File change event correlation is an advanced watch feature that * allows to identify from which watch request the events originate * from. This correlation allows to route events specifically * only to the requestor and not emit them to all listeners. */ correlates(correlationId: number): boolean; /** * Figure out if the event contains changes that correlate to one * correlation identifier. * * File change event correlation is an advanced watch feature that * allows to identify from which watch request the events originate * from. This correlation allows to route events specifically * only to the requestor and not emit them to all listeners. */ hasCorrelation(): boolean; /** * @deprecated use the `contains` or `affects` method to efficiently find * out if the event relates to a given resource. these methods ensure: * - that there is no expensive lookup needed (by using a `TernarySearchTree`) * - correctly handles `FileChangeType.DELETED` events */ readonly rawAdded: URI[]; /** * @deprecated use the `contains` or `affects` method to efficiently find * out if the event relates to a given resource. these methods ensure: * - that there is no expensive lookup needed (by using a `TernarySearchTree`) * - correctly handles `FileChangeType.DELETED` events */ readonly rawUpdated: URI[]; /** * @deprecated use the `contains` or `affects` method to efficiently find * out if the event relates to a given resource. these methods ensure: * - that there is no expensive lookup needed (by using a `TernarySearchTree`) * - correctly handles `FileChangeType.DELETED` events */ readonly rawDeleted: URI[]; } export interface IBaseFileStat { /** * The unified resource identifier of this file or folder. */ readonly resource: URI; /** * The name which is the last segment * of the {{path}}. */ readonly name: string; /** * The size of the file. * * The value may or may not be resolved as * it is optional. */ readonly size?: number; /** * The last modification date represented as millis from unix epoch. * * The value may or may not be resolved as * it is optional. */ readonly mtime?: number; /** * The creation date represented as millis from unix epoch. * * The value may or may not be resolved as * it is optional. */ readonly ctime?: number; /** * A unique identifier that represents the * current state of the file or directory. * * The value may or may not be resolved as * it is optional. */ readonly etag?: string; /** * File is readonly. Components like editors should not * offer to edit the contents. */ readonly readonly?: boolean; /** * File is locked. Components like editors should offer * to edit the contents and ask the user upon saving to * remove the lock. */ readonly locked?: boolean; } export interface IBaseFileStatWithMetadata extends Required { } /** * A file resource with meta information and resolved children if any. */ export interface IFileStat extends IBaseFileStat { /** * The resource is a file. */ readonly isFile: boolean; /** * The resource is a directory. */ readonly isDirectory: boolean; /** * The resource is a symbolic link. Note: even when the * file is a symbolic link, you can test for `FileType.File` * and `FileType.Directory` to know the type of the target * the link points to. */ readonly isSymbolicLink: boolean; /** * The children of the file stat or undefined if none. */ children: IFileStat[] | undefined; } export interface IFileStatWithMetadata extends IFileStat, IBaseFileStatWithMetadata { readonly mtime: number; readonly ctime: number; readonly etag: string; readonly size: number; readonly readonly: boolean; readonly locked: boolean; readonly children: IFileStatWithMetadata[] | undefined; } export interface IFileStatResult { readonly stat?: IFileStat; readonly success: boolean; } export interface IFileStatWithPartialMetadata extends Omit { } export interface IFileContent extends IBaseFileStatWithMetadata { /** * The content of a file as buffer. */ readonly value: VSBuffer; } export interface IFileStreamContent extends IBaseFileStatWithMetadata { /** * The content of a file as stream. */ readonly value: VSBufferReadableStream; } export interface IBaseReadFileOptions extends IFileReadStreamOptions { /** * The optional etag parameter allows to return early from resolving the resource if * the contents on disk match the etag. This prevents accumulated reading of resources * that have been read already with the same etag. * It is the task of the caller to makes sure to handle this error case from the promise. */ readonly etag?: string; } export interface IReadFileStreamOptions extends IBaseReadFileOptions { } export interface IReadFileOptions extends IBaseReadFileOptions { /** * The optional `atomic` flag can be used to make sure * the `readFile` method is not running in parallel with * any `write` operations in the same process. * * Typically you should not need to use this flag but if * for example you are quickly reading a file right after * a file event occurred and the file changes a lot, there * is a chance that a read returns an empty or partial file * because a pending write has not finished yet. * * Note: this does not prevent the file from being written * to from a different process. If you need such atomic * operations, you better use a real database as storage. */ readonly atomic?: boolean; } export interface IWriteFileOptions { /** * The last known modification time of the file. This can be used to prevent dirty writes. */ readonly mtime?: number; /** * The etag of the file. This can be used to prevent dirty writes. */ readonly etag?: string; /** * Whether to attempt to unlock a file before writing. */ readonly unlock?: boolean; /** * The optional `atomic` flag can be used to make sure * the `writeFile` method updates the target file atomically * by first writing to a temporary file in the same folder * and then renaming it over the target. */ readonly atomic?: IFileAtomicOptions | false; } export interface IResolveFileOptions { /** * Automatically continue resolving children of a directory until the provided resources * are found. */ readonly resolveTo?: readonly URI[]; /** * Automatically continue resolving children of a directory if the number of children is 1. */ readonly resolveSingleChildDescendants?: boolean; /** * Will resolve mtime, ctime, size and etag of files if enabled. This can have a negative impact * on performance and thus should only be used when these values are required. */ readonly resolveMetadata?: boolean; } export interface IResolveMetadataFileOptions extends IResolveFileOptions { readonly resolveMetadata: true; } export interface ICreateFileOptions { /** * Overwrite the file to create if it already exists on disk. Otherwise * an error will be thrown (FILE_MODIFIED_SINCE). */ readonly overwrite?: boolean; } export declare enum FileKind { FILE = 0, FOLDER = 1, ROOT_FOLDER = 2 }