Readonly
environmentGets the extension's environment variable collection for this workspace, enabling changes to be applied to terminal environment variables.
Readonly
extensionThe current extension instance.
Readonly
extensionThe mode the extension is running in. This is specific to the current
extension. One extension may be in ExtensionMode.Development
while
other extensions in the host run in ExtensionMode.Release
.
The absolute file path of the directory containing the extension.
Readonly
extensionThe uri of the directory containing the extension.
A memento object that stores state independent of the current opened workspace.workspaceFolders workspace.
Set the keys whose values should be synchronized across devices when synchronizing user-data like configuration, extensions, and mementos.
Note that this function defines the whole set of keys whose values are synchronized:
For any given set of keys this function needs to be called only once but there is no harm in repeatedly calling it.
The set of keys whose values are synced.
Readonly
globalAn absolute file path in which the extension can store global state. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent.
Use globalState
to store key value data.
Use globalStorageUri instead.
Readonly
globalThe uri of a directory in which the extension can store global state. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent.
Use globalState
to store key value data.
workspace.fs
for how to read and write files and folders from
an uri.
Readonly
languageAn object that keeps information about how this extension can use language models.
Readonly
logAn absolute file path of a directory in which the extension can create log files. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent.
Readonly
logThe uri of a directory in which the extension can create log files. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent. see - workspace.fs for how to read and write files and folders from an uri.
Readonly
secretsA storage utility for secrets.
An absolute file path of a workspace specific directory in which the extension can store private state. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent.
Use workspaceState
or
globalState
to store key value data.
Use storageUri instead.
Readonly
storageThe uri of a workspace specific directory in which the extension
can store private state. The directory might not exist and creation is
up to the extension. However, the parent directory is guaranteed to be existent.
The value is undefined
when no workspace nor folder has been opened.
Use workspaceState
or
globalState
to store key value data.
workspace.fs
for how to read and write files and folders from
an uri.
An array to which disposables can be added. When this extension is deactivated the disposables will be disposed.
A memento object that stores state in the context of the currently opened workspace.workspaceFolders workspace.
A plug-in context is a collection of utilities private to a plug-in.
An instance of a
PluginContext
is provided as the first parameter to thestart
of a plug-in.