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.

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. The more individual matches a selector and a document have, the higher the score is. These are the abstract rules given a selector:

(1) When selector is an array, return the maximum individual result.
(2) When selector is a string match that against the [languageId](#TextDocument.languageId).
    (2.1) When both are equal score is `10`,
    (2.2) When the selector is `*` score is `5`,
    (2.3) Else score is `0`.
(3) When selector is a [filter](#DocumentFilter) every property must score higher `0`. Iff the score is the sum of the following:
    (3.1) When [language](#DocumentFilter.language) is set apply rules from #2, when `0` the total score is `0`.
    (3.2) When [scheme](#Document.scheme) is set and equals the [uri](#TextDocument.uri)-scheme add `10` to the score, else the total score is `0`.
    (3.3) When [pattern](#Document.pattern) is set
        (3.3.1) pattern eqauls the [uri](#TextDocument.uri)-fsPath add `10` to the score,
        (3.3.1) if the pattern matches as glob-pattern add `5` to the score,
        (3.3.1) the total score is `0`

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 result of 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 formatting provider for a document range.

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

Register a workspace 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.

Set a language configuration for a language.

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.

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

Create a new output channel with the given name.

Creates a status bar item.

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

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.

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.

• 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 a warning message.

• see - showInformationMessage

Show a warning message.

• see - showInformationMessage

The folder that is open in VS Code. undefined when no folder has been opened.

• readonly

All text documents currently known to the system.

• readonly

An event that is emitted when the configuration changed.

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

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.

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

When there is no workspace root or when the path is not a child of that folder, 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.

Find files in the workspace.

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

Get a 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.doIt') === true.

Opens the denoted document from disk. Will return early if the document is already open, otherwise the document is loaded and the open document-event fires. The document to open is denoted by the uri. Two schemes are supported:

file: A file on disk, will be rejected if the file does not exist or cannot be loaded, e.g. 'file:///Users/frodo/r.ini'. untitled: A new file that should be saved on disk, e.g. 'untitled:/Users/frodo/new.js'. The language will be derived from the file name.

Uris with other schemes will make this method return a rejected promise.

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

• see - openTextDocument

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.

• readonly

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.

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.

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.

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 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 string that should be used when comparing this item with other items. When falsy the label is used.

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 one the same line completions where 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.

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

Range to which this decoration is applied.

Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations.

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.

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.

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.

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

Overwrite options for dark themes.

An absolute path to an image to be rendered in the gutterIconPath.

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.

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

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.

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.

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

Replace all entries in this collection.

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.

Provide formatting edits for a range in a document.

The given range is a hint and providers can decide to format a smaller or larger range. Often this is done by adjusting the start and end of the range to full syntax nodes.

Provide symbol information for the given document.

Describes text to be appended after the new line and after the indentation.

Describe what to do with the indentation.

Describes the number of characters to remove from the new line's indentation.

A function that represents an event to which you subscribe by calling it with a listener function as argument.

A function that represents an event to which you subscribe by calling it with a listener function as argument.

The event listeners can subscribe to.

Dispose this object and free resources.

Notify all subscribers of the event. Failure of one or more listener will not fail this function call.

The public API exported by this extension. It is an invalid action to access this field before this extension has been activated.

• readonly

The absolute file path of the directory containing this extension.

• readonly

The canonical extension identifier in the form of: publisher.name.

• readonly

true if the extension has been activated.

• readonly

The parsed contents of the extension's package.json.

• readonly

Activates this extension and returns its public API.

The absolute file path of the directory containing the extension.

A memento object that stores state independent of the current opened workspace.

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.

Get the absolute path of a resource contained in the extension.

An event which fires on file/folder change.

An event which fires on file/folder creation.

An event which fires on file/folder deletion.

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.

true if this file system watcher has been created such that it ignores change file system events.

true if this file system watcher has been created such that it ignores creation file system events.

true if this file system watcher has been created such that it ignores delete file system events.

Dispose this object.

Prefer spaces over tabs.

Size of a tab in spaces.

Creates a new hover object.

The contents of this hover.

The range to which this hover applies. When missing, the editor will use the range at the current position or the current position itself.

Provide a hover for the given position and document. Multiple hovers at the same position will be merged by the editor. A hover can have a range which defaults to the word range at the position when omitted.

If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).

If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).

If a line matches this pattern, then only the next line after it should be indented once.

If a line matches this pattern, then its indentation should not be changed and it should not be evaluated against the other rules.

Set to true to show a password prompt that will not show the typed value.

An optional string to show as place holder in the input box to guide the user what to type.

The text to display underneath the input box.

An optional function that will be called to valide input and to give a hint to the user.

• param - The current value of the input box.

• returns - A human readable string which is presented as diagnostic message. Return undefined, null, or the empty string when 'value' is valid.

The value to prefill in the input box.

Deprecated Do not use.

• deprecated - Will be replaced by a better API soon.

Deprecated Do not use.

• deprecated - Will be replaced by a better API soon.

The language's brackets. This configuration implicitly affects pressing Enter around these brackets.

The language's comment settings.

The language's indentation settings.

The language's rules to be evaluated when pressing Enter.

The language's word definition. If the language supports Unicode identifiers (e.g. JavaScript), it is preferable to provide a word definition that uses exclusion of known separators. e.g.: A regex that matches anything except known separators (and dot is allowed to occur in a floating point number): /(-?\d.\d\w)|([^`~!\@@#\%\^\&*()-\=+[{]}\|\;\:\'\"\,.\<>\/\?\s]+)/g

Creates a new location object.

The document range of this locations.

The resource identifier of this location.

Return a value.

Store a value. The value must be JSON-stringifyable.

A short title like 'Retry', 'Open Log' etc.

The action to execute.

This rule will only execute if the text after the cursor matches this regular expression.

This rule will only execute if the text before the cursor matches this regular expression.

Provide formatting edits after a character has been typed.

The given position and character should hint to the provider what range the position to expand to, like find the matching { when } has been entered.

The human-readable name of this output channel.

• readonly

Append the given value to the channel.

Append the given value and a line feed character to the channel.

Removes all output from the channel.

Dispose and free associated resources.

Hide this channel from the UI.

Reveal this channel in the UI.

• deprecated - This method is deprecated.

Reveal this channel in the UI.

Creates a new parameter information object.

The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

The label of this signature. Will be shown in the UI.

The zero-based character value.

• readonly

The zero-based line value.

• readonly

Compare this to other.

Check if other is after this position.

Check if other is after or equal to this position.

Check if other is before this position.

Check if other is before or equal to this position.

Check if other equals this position.

Create a new position relative to this position.

Create a new position derived from this position.

A human readable string which is rendered less prominent.

A human readable string which is rendered less prominent.

A human readable string which is rendered prominent.

An optional function that is invoked whenever an item is selected.

An optional flag to include the description when filtering the picks.

An optional flag to include the detail when filtering the picks.

An optional string to show as place holder in the input box to guide the user what to pick on.

Create a new range from two positions. If start is not before or equal to end, the values will be swapped.

Create a new range from number coordinates. It is a shorter equivalent of using new Range(new Position(startLine, startCharacter), new Position(endLine, endCharacter))

The end position. It is after or equal to start.

• readonly

true iff start and end are equal.

true iff start.line and end.line are equal.

The start position. It is before or equal to end.

• readonly

Check if a position or a range is contained in this range.

Intersect range with this range and returns a new range or undefined if the ranges have no overlap.