vscode namespace API

Executes the command denoted by the given command identifier.

• Note 1: When executing an editor command not all types are allowed to be passed as arguments. Allowed are the primitive types string, boolean, number, undefined, and null, as well as Position, Range, Uri and Location.
• Note 2: There are no restrictions when executing commands that have been contributed by extensions.

Retrieve the list of all available commands. Commands starting an underscore are treated as internal commands.

Registers a command that can be invoked via a keyboard shortcut, a menu item, an action, or directly.

Registering a command with an existing command identifier twice will cause an error.

Registers a text editor command that can be invoked via a keyboard shortcut, a menu item, an action, or directly.

Text editor commands are different from ordinary commands as they only execute when there is an active editor when the command is called. Also, the command handler of an editor command has access to the active editor and to an edit-builder.

The currently active debug console. If no debug session is active, output sent to the debug console is not shown.

The currently active debug session or undefined. The active debug session is the one represented by the debug action floating window or the one currently shown in the drop down menu of the debug action floating window. If no debug session is active, the value is undefined.

List of breakpoints.

An event which fires when the active debug session has changed. Note that the event also fires when the active debug session changes to undefined.

An event that is emitted when the set of breakpoints is added, removed, or changed.

An event which fires when a custom DAP event is received from the debug session.

An event which fires when a new debug session has been started.

An event which fires when a debug session has terminated.

Add breakpoints.

Register a debug adapter descriptor factory for a specific debug type. An extension is only allowed to register a DebugAdapterDescriptorFactory for the debug type(s) defined by the extension. Otherwise an error is thrown. Registering more than one DebugAdapterDescriptorFactory for a debug type results in an error.

Register a debug adapter tracker factory for the given debug type.

Register a debug configuration provider for a specific debug type. More than one provider can be registered for the same type.

Remove breakpoints.

Start debugging by using either a named launch or named compound configuration, or by directly passing a DebugConfiguration. The named configurations are looked up in '.vscode/launch.json' found in the given folder. Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date. Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.

The application name of the editor, like 'VS Code'.

• readonly

The application root folder from which the editor is running.

• readonly

The system clipboard.

Represents the preferred user-language, like de-CH, fr, or en-US.

• readonly

A unique identifier for the computer.

• readonly

A unique identifier for the current session. Changes each time the editor is started.

• readonly

All extensions currently known to the system.

Get an extension by its full identifier in the form of: publisher.name.

Get an extension its full identifier in the form of: publisher.name.

An event which fires when the global set of diagnostics changes. This is newly added and removed diagnostics.

Create a diagnostics collection.

Get all diagnostics for a given resource. Note that this includes diagnostics from all extensions but not yet from the task framework.

Get all diagnostics. Note that this includes diagnostics from all extensions but not yet from the task framework.

Return the identifiers of all known languages.

Compute the match between a document selector and a document. Values greater than zero mean the selector matches the document.

A match is computed according to these rules:

1. When DocumentSelector is an array, compute the match for each contained DocumentFilter or language identifier and take the maximum value.
2. A string will be desugared to become the language-part of a DocumentFilter, so "fooLang" is like { language: "fooLang" }.
3. A DocumentFilter will be matched against the document by comparing its parts with the document. The following rules apply:
   1. When the DocumentFilter is empty ({}) the result is 0
   2. When scheme, language, or pattern are defined but one doesn’t match, the result is 0
   3. Matching against * gives a score of 5, matching via equality or via a glob-pattern gives a score of 10
   4. The result is the maximum value of each match

Samples:

// default document from disk (file-scheme)
doc.uri; //'file:///my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({language: 'javascript'}, doc); // 10;
match({language: 'javascript', scheme: 'file'}, doc); // 10;
match('*', doc); // 5
match('fooLang', doc); // 0
match(['fooLang', '*'], doc); // 5

// virtual document, e.g. from git-index
doc.uri; // 'git:/my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({language: 'javascript', scheme: 'git'}, doc); // 10;
match('*', doc); // 5

Register a code action provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a code lens provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a color provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a completion provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and groups of equal score are sequentially asked for completion items. The process stops when one or many providers of a group return a result. A failing provider (rejected promise or exception) will not fail the whole operation.

Register a declaration provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a definition provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a formatting provider for a document.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.

Register a document highlight provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and groups sequentially asked for document highlights. The process stops when a provider returns a non-falsy or non-failure result.

Register a document link provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a formatting provider for a document range.

Note: A document range provider is also a document formatter which means there is no need to register a document formatter when also registering a range provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.

Register a document symbol provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a folding range provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. If multiple folding ranges start at the same position, only the range of the first registered provider is used. If a folding range overlaps with an other range that has a smaller position, it is also ignored.

A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a hover provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register an implementation provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a formatting provider that works on type. The provider is active when the user enables the setting editor.formatOnType.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.

Register a reference provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a reference provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.

Register a signature help provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and called sequentially until a provider returns a valid result.

Register a type definition provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a workspace symbol provider.

Multiple providers can be registered. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Set a language configuration for a language.

Set (and change) the language that is associated with the given document.

Note that calling this function will trigger the onDidCloseTextDocument event followed by the onDidOpenTextDocument event.

The input box for the last source control created by the extension.

• deprecated - Use SourceControl.inputBox instead

Creates a new source control instance.

The currently active task executions or an empty array.

• readonly

Fires when a task ends.

Fires when the underlying process has ended. This event will not fire for tasks that don't execute an underlying process.

Fires when a task starts.

Fires when the underlying process has been started. This event will not fire for tasks that don't execute an underlying process.

Executes a task that is managed by VS Code. The returned task execution can be used to terminate the task.

Fetches all tasks available in the systems. This includes tasks from tasks.json files as well as tasks from task providers contributed through extensions.

Register a task provider.

The currently active terminal or undefined. The active terminal is the one that currently has focus or most recently had focus.

The currently active editor or undefined. The active editor is the one that currently has focus or, when none has focus, the one that has changed input most recently.

Represents the current window's state.

• readonly

The currently opened terminals or an empty array.

The currently visible editors or an empty array.

An event which fires when the active terminal has changed. Note that the event also fires when the active terminal changes to undefined.

An event which fires when the active editor has changed. Note that the event also fires when the active editor changes to undefined.

An event which fires when the options of an editor have changed.

An event which fires when the selection in an editor has changed.

An event which fires when the view column of an editor has changed.

An event which fires when the visible ranges of an editor has changed.

An event which fires when the array of visible editors has changed.

An event which fires when the focus state of the current window changes. The value of the event represents whether the window is focused.

An event which fires when a terminal is disposed.

An event which fires when a terminal has been created, either through the createTerminal API or commands.

Creates a InputBox to let the user enter some text input.

Note that in many cases the more convenient window.showInputBox is easier to use. window.createInputBox should be used when window.showInputBox does not offer the required flexibility.

Creates a new output channel with the given name.

Creates a QuickPick to let the user pick an item from a list of items of type T.

Note that in many cases the more convenient window.showQuickPick is easier to use. window.createQuickPick should be used when window.showQuickPick does not offer the required flexibility.

Creates a status bar item.

Creates a Terminal. The cwd of the terminal will be the workspace directory if it exists, regardless of whether an explicit customStartPath setting exists.

Creates a Terminal. The cwd of the terminal will be the workspace directory if it exists, regardless of whether an explicit customStartPath setting exists.

Create a TextEditorDecorationType that can be used to add decorations to text editors.

Create a TreeView for the view contributed using the extension point views.

Create and show a new webview panel.

Register a TreeDataProvider for the view contributed using the extension point views. This will allow you to contribute data to the TreeView and update if the data changes.

Note: To get access to the TreeView and perform operations on it, use createTreeView.

Registers a uri handler capable of handling system-wide uris. In case there are multiple windows open, the topmost window will handle the uri. A uri handler is scoped to the extension it is contributed from; it will only be able to handle uris which are directed to the extension itself. A uri must respect the following rules:

• The uri-scheme must be the product name;
• The uri-authority must be the extension id (eg. my.extension);
• The uri-path, -query and -fragment parts are arbitrary.

For example, if the my.extension extension registers a uri handler, it will only be allowed to handle uris with the prefix product-name://my.extension.

An extension can only register a single uri handler in its entire activation lifetime.

• Note: There is an activation event onUri that fires when a uri directed for the current extension is about to be handled.

Registers a webview panel serializer.

Extensions that support reviving should have an "onWebviewPanel:viewType" activation event and make sure that registerWebviewPanelSerializer is called during activation.

Only a single serializer may be registered at a time for a given viewType.

Set a message to the status bar. This is a short hand for the more powerful status bar items.

Set a message to the status bar. This is a short hand for the more powerful status bar items.

Set a message to the status bar. This is a short hand for the more powerful status bar items.

Note that status bar messages stack and that they must be disposed when no longer used.

Show an error message.

• see - showInformationMessage

Show an error message.

• see - showInformationMessage

Show an error message.

• see - showInformationMessage

Show an error message.

• see - showInformationMessage

Show an information message to users. Optionally provide an array of items which will be presented as clickable buttons.

Show an information message to users. Optionally provide an array of items which will be presented as clickable buttons.

Show an information message.

• see - showInformationMessage

Show an information message.

• see - showInformationMessage

Opens an input box to ask the user for input.

The returned value will be undefined if the input box was canceled (e.g. pressing ESC). Otherwise the returned value will be the string typed by the user or an empty string if the user did not type anything but dismissed the input box with OK.

Shows a file open dialog to the user which allows to select a file for opening-purposes.

Shows a selection list allowing multiple selections.

Shows a selection list.

Shows a selection list allowing multiple selections.

Shows a selection list.

Shows a file save dialog to the user which allows to select a file for saving-purposes.

Show the given document in a text editor. A column can be provided to control where the editor is being shown. Might change the active editor.

Show the given document in a text editor. Options can be provided to control options of the editor is being shown. Might change the active editor.

A short-hand for openTextDocument(uri).then(document => showTextDocument(document, options)).

• see - openTextDocument

Show a warning message.

• see - showInformationMessage

Show a warning message.

• see - showInformationMessage

Show a warning message.

• see - showInformationMessage

Show a warning message.

• see - showInformationMessage

Shows a selection list of workspace folders to pick from. Returns undefined if no folder is open.

Show progress in the editor. Progress is shown while running the given callback and while the promise it returned isn't resolved nor rejected. The location at which progress should show (and other details) is defined via the passed ProgressOptions.

Show progress in the Source Control viewlet while running the given callback and while its returned promise isn't resolve or rejected.

• deprecated - Use withProgress instead.

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

• readonly

The folder that is open in the editor. undefined when no folder has been opened.

• deprecated - Use workspaceFolders instead.

• readonly

All text documents currently known to the system.

• readonly

List of workspace folders or undefined when no folder is open. Note that the first entry corresponds to the value of rootPath.

• readonly

An event that is emitted when the configuration changed.

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.

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

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

To add an event listener when a visible text document is closed, use the TextEditor events in the window namespace. Note that this event is not emitted when a TextEditor is closed but the document remains open in another visible text editor.

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

To add an event listener when a visible text document is opened, use the TextEditor events in the window namespace. Note that:

• The event is emitted before the document is updated in the active text editor
• When a text document is already open (e.g.: open in another visible text editor) this event is not emitted

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

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

Note 1: Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor might save without firing this event. For instance when shutting down with dirty files.

Note 2: Subscribers are called sequentially and they can delay saving by registering asynchronous work. Protection against misbehaving listeners is implemented as such:

• there is an overall time budget that all listeners share and if that is exhausted no further listener is called
• listeners that take a long time or produce errors frequently will not be called anymore

The current thresholds are 1.5 seconds as overall time budget and a listener can misbehave 3 times before being ignored.

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

All changes of a workspace edit are applied in the same order in which they have been added. If multiple textual inserts are made at the same position, these strings appear in the resulting text in the order the 'inserts' were made. Invalid sequences like 'delete file a' -> 'insert text in file a' cause failure of the operation.

When applying a workspace edit that consists only of text edits an 'all-or-nothing'-strategy is used. A workspace edit with resource creations or deletions aborts the operation, e.g. consective edits will not be attempted, when a single edit fails.

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

When there are no workspace folders or when the path is not contained in them, the input is returned.

Creates a file system watcher.

A glob pattern that filters the file events on their absolute path must be provided. Optionally, flags to ignore certain kinds of events can be provided. To stop listening to events the watcher must be disposed.

Note that only files within the current workspace folders can be watched.

Find files across all workspace folders in the workspace.

• sample - findFiles('**/*.js', '**/node_modules/**', 10)

Get a workspace configuration object.

When a section-identifier is provided only that part of the configuration is returned. Dots in the section-identifier are interpreted as child-access, like { myExt: { setting: { doIt: true }}} and getConfiguration('myExt.setting').get('doIt') === true.

When a resource is provided, configuration scoped to that resource is returned.

Returns the workspace folder that contains a given uri.

• returns undefined when the given uri doesn't match any workspace folder
• returns the input when the given uri is a workspace folder itself

Opens a document. Will return early if this document is already open. Otherwise the document is loaded and the didOpen-event fires.

The document is denoted by an uri. Depending on the scheme the following rules apply:

• file-scheme: Open a file on disk, will be rejected if the file does not exist or cannot be loaded.
• untitled-scheme: A new file that should be saved on disk, e.g. untitled:c:\frodo\new.js. The language will be derived from the file name.
• For all other schemes the registered text document content providers are consulted.

Note that the lifecycle of the returned document is owned by the editor and not by the extension. That means an onDidClose-event can occur at any time after opening it.

A short-hand for openTextDocument(Uri.file(fileName)).

• see - openTextDocument

Opens an untitled text document. The editor will prompt the user for a file path when the document is to be saved. The options parameter allows to specify the language and/or the content of the document.

Register a filesystem provider for a given scheme, e.g. ftp.

There can only be one provider per scheme and an error is being thrown when a scheme has been claimed by another provider or when it is reserved.

Register a task provider.

• deprecated - Use the corresponding function on the tasks namespace instead

Register a text document content provider.

Only one provider can be registered per scheme.

Save all dirty files.

This method replaces deleteCount workspace folders starting at index start by an optional set of workspaceFoldersToAdd on the vscode.workspace.workspaceFolders array. This "splice" behavior can be used to add, remove and change workspace folders in a single operation.

If the first workspace folder is added, removed or changed, the currently executing extensions (including the one that called this method) will be terminated and restarted so that the (deprecated) rootPath property is updated to point to the first workspace folder.

Use the onDidChangeWorkspaceFolders() event to get notified when the workspace folders have been updated.

Example: adding a new workspace folder at the end of workspace folders

workspace.updateWorkspaceFolders(workspace.workspaceFolders ? workspace.workspaceFolders.length : 0, null, { uri: ...});

Example: removing the first workspace folder

workspace.updateWorkspaceFolders(0, 1);

Example: replacing an existing workspace folder with a new one

workspace.updateWorkspaceFolders(0, 1, { uri: ...});

It is valid to remove an existing workspace folder and add it again with a different name to rename that folder.

Note: it is not valid to call updateWorkspaceFolders() multiple times without waiting for the onDidChangeWorkspaceFolders() to fire.

An optional expression for conditional breakpoints.

Is breakpoint enabled.

An optional expression that controls how many hits of the breakpoint are ignored.

The unique ID of the breakpoint.

An optional message that gets logged when this breakpoint is hit. Embedded expressions within {} are interpolated by the debug adapter.

Added breakpoints.

Changed breakpoints.

Removed breakpoints.

Is true when the token has been cancelled, false otherwise.

An event which fires upon cancellation.

The cancellation token of this source.

Signal cancellation on the token.

Dispose object and free resources.

Read the current clipboard contents as text.

Writes text into the clipboard.

Creates a new code action.

A code action must have at least a title and edits and/or a command.

A command this code action executes.

Diagnostics that this code action resolves.

A workspace edit this code action performs.

Kind of the code action.

Used to filter code actions.

A short, human-readable, title for this code action.

Requested kind of actions to return.

Actions not of this kind are filtered out before being shown by the lightbulb.

An array of diagnostics.

Empty kind.

Base kind for quickfix actions: quickfix.

Quick fix actions address a problem in the code and are shown in the normal code action context menu.

Base kind for refactoring actions: refactor

Refactoring actions are shown in the refactoring context menu.

Base kind for refactoring extraction actions: refactor.extract

Example extract actions:

• Extract method
• Extract function
• Extract variable
• Extract interface from class
• ...

Base kind for refactoring inline actions: refactor.inline

Example inline actions:

• Inline function
• Inline variable
• Inline constant
• ...

Base kind for refactoring rewrite actions: refactor.rewrite

Example rewrite actions:

• Convert JavaScript function to class
• Add or remove parameter
• Encapsulate field
• Make method static
• Move method to base class
• ...

Base kind for source actions: source

Source code actions apply to the entire file and can be run on save using editor.codeActionsOnSave. They also are shown in source context menu.

Base kind for an organize imports source action: source.organizeImports.

String value of the kind, e.g. "refactor.extract.function".

Create a new kind by appending a more specific selector to the current kind.

Does not modify the current kind.

Does this kind contain other?

The kind "refactor" for example contains "refactor.extract" and `"refactor.extract.function", but not "unicorn.refactor.extract" or "refactory.extract"

Provide commands for the given document and range.

CodeActionKinds that this provider may return.

The list of kinds may be generic, such as CodeActionKind.Refactor, or the provider may list our every specific kind they provide, such as CodeActionKind.Refactor.Extract.append('function)`

Creates a new code lens object.

The command this code lens represents.

true when there is a command associated.

The range in which this code lens is valid. Should only span a single line.

An optional event to signal that the code lenses from this provider have changed.

Compute a list of lenses. This call should return as fast as possible and if computing the commands is expensive implementors should only return code lens objects with the range set and implement resolve.

This function will be called for each visible code lens, usually when scrolling and after calls to compute-lenses.

Creates a new color instance.

The alpha component of this color in the range [0-1].

The blue component of this color in the range [0-1].

The green component of this color in the range [0-1].

The red component of this color in the range [0-1].

Creates a new color range.

The actual color value for this color range.

The range in the document where this color appears.

Creates a new color presentation.

An optional array of additional text edits that are applied when selecting this color presentation. Edits must not overlap with the main edit nor with themselves.