maxmustermann/vscode
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

better docs for #118566

Browse source
This commit is contained in:
Benjamin Pasero 2021-03-10 07:23:15 +01:00
parent 96fabf5cf9
commit a19fac2442
No known key found for this signature in database
GPG key ID: E6380CC4C8219E65
1 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/vs/vscode.d.ts vendored
View file

@ -10072,9 +10072,16 @@ declare module 'vscode' {
}
/**
* Namespace for dealing with the current workspace. A workspace is the representation
* of the folder that has been opened. There is no workspace when just a file but not a
* folder has been opened.
* Namespace for dealing with the current workspace. A workspace is the collection of one
* or more folders that are opened in a VS Code window (instance).
*
* It is also possible to open VS Code without a workspace. For example, when you open a
* new VS Code window by selecting a file from your platform's File menu, you will not be
* inside a workspace. In this mode, some of VS Code'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 in VS Code.
*
* The workspace offers support for [listening](#workspace.createFileSystemWatcher) to fs
* events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
@ -10091,15 +10098,23 @@ declare module 'vscode' {
export const fs: FileSystem;
/**
* The folder that is open in the editor. `undefined` when no folder
* The workspace folder that is open in VS Code. `undefined` when no workspace
* has been opened.
*
* Refer to https://code.visualstudio.com/docs/editor/workspaces for more information
* on workspaces in VS Code.
*
* @deprecated Use [`workspaceFolders`](#workspace.workspaceFolders) instead.
*/
export const rootPath: string | undefined;
/**
* List of workspace folders or `undefined` when no folder is open.
* List of workspace folders that are open in VS Code. `undefined when no workspace
* has been opened.
*
* Refer to https://code.visualstudio.com/docs/editor/workspaces for more information
* on workspaces in VS Code.
*
* *Note* that the first entry corresponds to the value of `rootPath`.
*/
export const workspaceFolders: ReadonlyArray<WorkspaceFolder> | undefined;