vscode namespace API

Executes the command denoted by the given command identifier.

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 classes defined in this API. 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 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.

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 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.

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. '${workspaceRoot}') are resolved against the given folder.

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

• readonly

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.

Create a diagnostics collection.

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 maximun 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 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 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 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.

The input box in the Source Control viewlet.

Creates a new source control instance.

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.

The currently visible editors or an empty array.

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 array of visible editors has changed.

An event which fires when a terminal is disposed.

Create a new output channel with the given name.

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.

Register a TreeDataProvider for the view contributed using the extension point views.

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 selection list.

Shows a selection list.

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

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 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.

An event that is emitted when a text document is opened.

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 as defined by the given workspace edit.

When applying a workspace edit, the editor implements an 'all-or-nothing'-strategy, that means failure to load one document or make changes to one document will cause the edit to be rejected.

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 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 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 a workspace folder for the provided resource. When the resource is a workspace folder itself, its parent workspace folder or undefined is returned.

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 task provider.

Register a text document content provider.

Only one provider can be registered per scheme.

Save all dirty files.

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. Will call cancel.

An array of diagnostics.

Provide commands for the given document and range.

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.

Arguments that the command handler should be invoked with.

The identifier of the actual command handler.

• see - commands.registerCommand.

Title of the command, like save.

A tooltip for for command, when represented in the UI.

The block comment character pair, like / block comment /

The line comment token, like // this is a comment

Creates a new completion item.

Completion items must have at least a label which then will be used as insert text as well as for sorting and filtering.

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

An optional command that is executed after inserting this completion. Note that additional modifications to the current document should be described with the additionalTextEdits-property.

An optional set of characters that when pressed while this completion is active will accept it first and then type that character. Note that all commit characters should have length=1 and that superfluous characters will be ignored.

A human-readable string with additional information about this item, like type or symbol information.

A human-readable string that represents a doc-comment.

A string that should be used when filtering a set of completion items. When falsy the label is used.

A string or snippet that should be inserted in a document when selecting this completion. When falsy the label is used.

The kind of this completion item. Based on the kind an icon is chosen by the editor.

The label of this completion item. By default this is also the text that is inserted when selecting this completion.

A range of text that should be replaced by this completion item.

Defaults to a range from the start of the current word to the current position.

Note: The range must be a single line and it must contain the position at which completion has been requested.

A string that should be used when comparing this item with other items. When falsy the label is used.

• deprecated - Use CompletionItem.insertText and CompletionItem.range instead.

An edit which is applied to a document when selecting this completion. When an edit is provided the value of insertText is ignored.

The range of the edit must be single-line and on the same line completions were requested at.

Provide completion items for the given position and document.

Given a completion item fill in more data, like doc-comment or details.

The editor will only resolve a completion item once.

Creates a new completion list.

This list it not complete. Further typing should result in recomputing this list.

The completion items.

An optional name for the debug session.

The request type of the debug session.

The type for the debug session.

The unique ID of this debug session.

The debug session's name from the debug configuration.

The debug session's type from the debug configuration.

Send a custom request to the debug adapter.

Event specific information.

Type of event.

The debug session for which the custom event was received.

Defines the rendering options of the attachment that is inserted after the decorated text

Defines the rendering options of the attachment that is inserted before the decorated text

Overwrite options for dark themes.

Overwrite options for light themes.

A message that should be rendered when hovering over the decoration.

Range to which this decoration is applied. The range must not be empty.

Render options applied to the current decoration. For performance reasons, keep the number of decoration specific options small, and use decoration types whereever possible.

Defines the rendering options of the attachment that is inserted after the decorated text

Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations. Alternativly a color from the color registry an be referenced.

Defines the rendering options of the attachment that is inserted before the decorated text

CSS styling property that will be applied to text enclosed by a decoration.

CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

CSS styling property that will be applied to text enclosed by a decoration. Better use 'border' for setting one or more of the individual border properties.

CSS styling property that will be applied to text enclosed by a decoration.

CSS styling property that will be applied to text enclosed by a decoration.

Overwrite options for dark themes.

An absolute path or an URI to an image to be rendered in the gutter.

Specifies the size of the gutter icon. Available values are 'auto', 'contain', 'cover' and any percentage value. For further information: https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx

Should the decoration be rendered also on the whitespace after the line text. Defaults to false.

CSS styling property that will be applied to text enclosed by a decoration.

Overwrite options for light themes.

CSS styling property that will be applied to text enclosed by a decoration.

CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

CSS styling property that will be applied to text enclosed by a decoration. Better use 'outline' for setting one or more of the individual outline properties.

The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.

The position in the overview ruler where the decoration should be rendered.

Customize the growing behavior of the decoration when edits occur at the edges of the decoration's range. Defaults to DecorationRangeBehavior.OpenOpen.

CSS styling property that will be applied to text enclosed by a decoration.

Provide the definition of the symbol at the given position and document.

Creates a new diagnostic object.

A code or identifier for this diagnostics. Will not be surfaced to the user, but should be used for later processing, e.g. when providing code actions.

The human-readable message.

The range to which this diagnostic applies.

The severity, default is error.

A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.

The name of this diagnostic collection, for instance typescript. Every diagnostic from this collection will be associated with this name. Also, the task framework uses this name when defining problem matchers.

Remove all diagnostics from this collection. The same as calling #set(undefined);

Remove all diagnostics from this collection that belong to the provided uri. The same as #set(uri, undefined).

Dispose and free associated resources. Calls clear.

Iterate over each entry in this collection.

Get the diagnostics for a given resource. Note that you cannot modify the diagnostics-array returned from this call.

Check if this collection contains diagnostics for a given resource.

Assign diagnostics for given resource. Will replace existing diagnostics for that resource.

Replace all entries in this collection.

Diagnostics of multiple tuples of the same uri will be merged, e.g [[file1, [d1]], [file1, [d2]]] is equivalent to [[file1, [d1, d2]]]. If a diagnostics item is undefined as in [file1, undefined] all previous but not subsequent diagnostics are removed.

Combine many disposable-likes into one. Use this method when having objects with a dispose function which are not instances of Disposable.

Creates a new Disposable calling the provided function on dispose.

Dispose this object.

A language id, like typescript.

A glob pattern, like *.{ts,js}.

A Uri scheme, like file or untitled.

Provide formatting edits for a whole document.

Creates a new document highlight object.

The highlight kind, default is text.

The range this highlight applies to.

Provide a set of document highlights, like all occurrences of a variable or all exit-points of a function.

Creates a new document link.

The range this link applies to.

The uri this link points to.

Provide links for the given document. Note that the editor ships with a default provider that detects http(s) and file links.