workspace

Namespace for dealing with the current workspace. A workspace is the collection of one or more folders that are opened in an editor window (instance).

It is also possible to open an editor without a workspace. For example, when you open a new editor window by selecting a file from your platform's File menu, you will not be inside a workspace. In this mode, some of the editor's capabilities are reduced but you can still open text files and edit them.

Refer to https://code.visualstudio.com/docs/editor/workspaces for more information on the concept of workspaces.

The workspace offers support for listening to fs events and for finding files. Both perform well and run outside the editor-process so that they should be always used instead of nodejs-equivalents.

Online Documentation

Properties

val fs: FileSystem

A file system instance that allows to interact with local and remote files, e.g. vscode.workspace.fs.readDirectory(someUri) allows to retrieve all entries of a directory or vscode.workspace.fs.stat(anotherUri) returns the meta data for a file.

isTrusted

val isTrusted: Boolean

When true, the user has explicitly trusted the contents of the workspace.

name

val name: String?

The name of the workspace. undefined when no workspace has been opened.

notebookDocuments

val notebookDocuments: ReadonlyArray<NotebookDocument>

All notebook documents currently known to the editor.

onDidChangeConfiguration

val onDidChangeConfiguration: Event<ConfigurationChangeEvent>

An event that is emitted when the configuration changed.

onDidChangeNotebookDocument

val onDidChangeNotebookDocument: Event<NotebookDocumentChangeEvent>

An event that is emitted when a notebook has changed.

onDidChangeTextDocument

val onDidChangeTextDocument: Event<TextDocumentChangeEvent>

An event that is emitted when a text document is changed. This usually happens when the contents changes but also when other things like the dirty-state changes.

onDidChangeWorkspaceFolders

val onDidChangeWorkspaceFolders: Event<WorkspaceFoldersChangeEvent>

An event that is emitted when a workspace folder is added or removed.

onDidCloseNotebookDocument

val onDidCloseNotebookDocument: Event<NotebookDocument>

An event that is emitted when a notebook is disposed.

onDidCloseTextDocument

val onDidCloseTextDocument: Event<TextDocument>

An event that is emitted when a text document is disposed or when the language id of a text document has been changed.

onDidCreateFiles

val onDidCreateFiles: Event<FileCreateEvent>

An event that is emitted when files have been created.

onDidDeleteFiles

val onDidDeleteFiles: Event<FileDeleteEvent>

An event that is emitted when files have been deleted.

onDidGrantWorkspaceTrust

val onDidGrantWorkspaceTrust: Event<Void>

Event that fires when the current workspace has been trusted.

onDidOpenNotebookDocument

val onDidOpenNotebookDocument: Event<NotebookDocument>

An event that is emitted when a notebook is opened.

onDidOpenTextDocument

val onDidOpenTextDocument: Event<TextDocument>

An event that is emitted when a text document is opened or when the language id of a text document has been changed.

onDidRenameFiles

val onDidRenameFiles: Event<FileRenameEvent>

An event that is emitted when files have been renamed.

onDidSaveNotebookDocument

val onDidSaveNotebookDocument: Event<NotebookDocument>

An event that is emitted when a notebook is saved.

onDidSaveTextDocument

val onDidSaveTextDocument: Event<TextDocument>

An event that is emitted when a text document is saved to disk.

onWillCreateFiles

val onWillCreateFiles: Event<FileWillCreateEvent>

An event that is emitted when files are being created.

onWillDeleteFiles

val onWillDeleteFiles: Event<FileWillDeleteEvent>

An event that is emitted when files are being deleted.

onWillRenameFiles

val onWillRenameFiles: Event<FileWillRenameEvent>

An event that is emitted when files are being renamed.

onWillSaveNotebookDocument

val onWillSaveNotebookDocument: Event<NotebookDocumentWillSaveEvent>

An event that is emitted when a notebook document will be saved to disk.

onWillSaveTextDocument

val onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>

An event that is emitted when a text document will be saved to disk.

textDocuments

val textDocuments: ReadonlyArray<TextDocument>

All text documents currently known to the editor.

workspaceFile

val workspaceFile: Uri?

The location of the workspace file, for example:

workspaceFolders

val workspaceFolders: ReadonlyArray<WorkspaceFolder>?

List of workspace folders (0-N) that are open in the editor. undefined when no workspace has been opened.

Functions

applyEdit

fun applyEdit(edit: WorkspaceEdit, metadata: WorkspaceEditMetadata = definedExternally): PromiseLike<JsBoolean>

Make changes to one or many resources or create, delete, and rename resources as defined by the given workspace edit.

asRelativePath

fun asRelativePath(pathOrUri: JsAny, includeWorkspaceFolder: Boolean = definedExternally): String

Returns a path that is relative to the workspace folder or folders.

createFileSystemWatcher

fun createFileSystemWatcher( globPattern: GlobPattern, ignoreCreateEvents: Boolean = definedExternally, ignoreChangeEvents: Boolean = definedExternally, ignoreDeleteEvents: Boolean = definedExternally): FileSystemWatcher

Creates a file system watcher that is notified on file events (create, change, delete) depending on the parameters provided.

decode

fun decode(content: Uint8Array<*>): PromiseLike<JsString>

Decodes the content from a Uint8Array to a string. You MUST provide the entire content at once to ensure that the encoding can properly apply. Do not use this method to decode content in chunks, as that may lead to incorrect results.

encode

fun encode(content: String): PromiseLike<Uint8Array<*>>

Encodes the content of a string to a Uint8Array.

findFiles

fun findFiles( include: GlobPattern, exclude: GlobPattern? = definedExternally, maxResults: Int = definedExternally, token: CancellationToken = definedExternally): PromiseLike<ReadonlyArray<Uri>>

Find files across all workspace folders in the workspace.

getConfiguration

fun getConfiguration(section: String = definedExternally, scope: ConfigurationScope? = definedExternally): WorkspaceConfiguration

Get a workspace configuration object.

getWorkspaceFolder

fun getWorkspaceFolder(uri: Uri): WorkspaceFolder?

Returns the workspace folder that contains a given uri.

openNotebookDocument

fun openNotebookDocument(uri: Uri): PromiseLike<NotebookDocument>

Open a notebook. Will return early if this notebook is already loaded. Otherwise the notebook is loaded and the {@linkcode onDidOpenNotebookDocument}-event fires.

fun openNotebookDocument(notebookType: String, content: NotebookData = definedExternally): PromiseLike<NotebookDocument>

Open an untitled notebook. The editor will prompt the user for a file path when the document is to be saved.

registerNotebookSerializer

fun registerNotebookSerializer( notebookType: String, serializer: NotebookSerializer, options: NotebookDocumentContentOptions = definedExternally): Disposable

registerTextDocumentContentProvider

fun registerTextDocumentContentProvider(scheme: String, provider: TextDocumentContentProvider): Disposable

save

fun save(uri: Uri): PromiseLike<Uri?>

Saves the editor identified by the given resource and returns the resulting resource or undefined if save was not successful or no editor with the given resource was found.

saveAll

fun saveAll(includeUntitled: Boolean = definedExternally): PromiseLike<JsBoolean>

Save all dirty files.

saveAs

fun saveAs(uri: Uri): PromiseLike<Uri?>

Saves the editor identified by the given resource to a new file name as provided by the user and returns the resulting resource or undefined if save was not successful or cancelled or no editor with the given resource was found.