Package-level declarations
Types
Accessibility information which controls screen reader behavior.
Namespace for authentication.
Optional options to be used when calling authentication.getSession with the flag forceNewSession
.
Options to be used when getting an AuthenticationSession from an AuthenticationProvider.
Optional options to be used when calling authentication.getSession with interactive options forceNewSession
&createIfNone
.
A provider for performing authentication to a service.
An Event which fires when an AuthenticationSession is added, removed, or changed.
Basic information about an AuthenticationProvider
Options for creating an AuthenticationProvider.
The options passed in to the AuthenticationProvider.getSessions and AuthenticationProvider.createSession call.
Represents a session of a currently logged in user.
The information of an account associated with an AuthenticationSession.
An Event which fires when an AuthenticationSession is added, removed, or changed.
Describes pairs of strings where the close string will be automatically inserted when typing the opening string.
Contains coverage information for a branch of a StatementCoverage.
The base class of all breakpoint types.
An event describing the changes to the set of breakpoints.
Represents an incoming call, e.g. a caller of a method or constructor.
Represents programming constructs like functions or constructors in the context of call hierarchy.
Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
The call hierarchy provider interface describes the contract between extensions and the call hierarchy feature which allows to browse calls and caller of function, methods, constructor etc.
An error type that should be used to signal cancellation of an operation.
A cancellation token is passed to an asynchronous or long running operation to request cancellation, like cancelling a request for completion items because the user continued to type.
A cancellation source creates and controls a cancellation token.
A tuple of two characters, like a pair of opening and closing brackets.
Namespace for chat functionality. Users interact with chat participants by sending messages to them in the chat view. Chat participants can respond with markdown or other types of content via the ChatResponseStream.
Extra context passed to a participant.
Represents an error result from a chat request.
A followup question suggested by the participant.
Will be invoked once after each request to get suggested followup questions to show the user. The user can click the followup to send it to the chat.
A reference to a tool that the user manually attached to their request, either using the #
-syntax inline, or as an attachment via the paperclip button.
A chat participant can be invoked by the user in a chat session, using the @
prefix. When it is invoked, it handles the chat request and is solely responsible for providing a response to the user. A ChatParticipant is created using chat.createChatParticipant.
A token that can be passed to lm.invokeTool when invoking a tool inside the context of handling a chat request.
A reference to a value that the user added to their chat request.
A request to a chat participant.
A chat request handler is a callback that will be invoked when a request is made to a chat participant.
Represents a user request in chat history.
Represents a part of a chat response that is an anchor, that is rendered as a link to a target.
Represents a part of a chat response that is a button that executes a command.
Represents a file tree structure in a chat response.
Represents a part of a chat response that is a file tree.
Represents a part of a chat response that is formatted as Markdown.
Represents the different chat response types.
Represents a part of a chat response that is a progress message.
Represents a part of a chat response that is a reference, rendered separately from the content.
The ChatResponseStream is how a participant is able to return content to the chat view. It provides several methods for streaming different types of content which will be rendered in an appropriate way in the chat view. A participant can use the helper method for the type of content it wants to return, or it can instantiate a ChatResponsePart and use the generic ChatResponseStream.push method to return it.
Represents a chat participant's response in chat history.
The result of a chat request.
Represents user feedback for a result.
Represents the type of user feedback received.
A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.
Contains additional diagnostic information about the context in which a code action is run.
Kind of a code action.
Provides contextual actions for code. Code actions typically either fix problems or beautify/refactor code.
Metadata about the type of code actions that a CodeActionProvider provides.
The reason why code actions were requested.
A code lens provider adds commands to source text. The commands will be shown as dedicated horizontal lines in between the source text.
Represents a color range from a document.
A color presentation object describes how a {@linkcode Color} should be represented as text and what edits are required to refer to it from source code.
Represents a color theme.
Represents a color theme kind.
Author information of a Comment
A comment controller is able to provide comments support to the editor and provide users various ways to interact with comments.
Commenting range provider for a comment controller.
The ranges a CommentingRangeProvider enables commenting on.
Comment mode of a {@link Comment}
Reactions of a Comment
Command argument for actions registered in comments/commentThread/context
.
Describes how comments for a language work.
A collection of comments representing a conversation at a particular range in a document.
Collapsible state of a {@link CommentThread comment thread}
The state of a comment thread.
Contains additional information about the context in which completion provider is triggered.
A completion item represents a text snippet that is proposed to complete text that is being typed.
Completion item kinds.
A structured label for a completion item.
The completion item provider interface defines the contract between extensions and IntelliSense.
Completion item tags are extra annotations that tweak the rendering of a completion item.
Represents a collection of completion items to be presented in the editor.
How a {@link CompletionItemProvider completion provider} was triggered
An event describing the change in Configuration
The configuration scope which can be:
The configuration target
Represents a custom document used by a {@linkcode CustomEditorProvider}.
A backup for an {@linkcode CustomDocument}.
Additional information used to implement {@linkcode CustomDocumentBackup}.
Event triggered by extensions to signal to the editor that the content of a {@linkcode CustomDocument} has changed.
Event triggered by extensions to signal to the editor that an edit has occurred on an {@linkcode CustomDocument}.
Additional information about the opening custom document.
Provider for editable custom editors that use a custom document model.
Class used to execute an extension callback as a task.
Provider for readonly custom editors that use a custom document model.
Provider for text based custom editors.
A map containing a mapping of the mime type of the corresponding transferred data.
A file associated with a {@linkcode DataTransferItem}.
Encapsulates data transferred during drag and drop operations.
A debug adapter that implements the Debug Adapter Protocol can be registered with the editor if it implements the DebugAdapter interface.
Represents the different types of debug adapters
A debug adapter factory that creates debug adapter descriptors.
Represents a debug adapter executable and optional arguments and runtime options passed to it.
Options for a debug adapter executable.
A debug adapter descriptor for an inline implementation.
Represents a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.
Represents a debug adapter running as a socket based server.
A Debug Adapter Tracker is a means to track the communication between the editor and a Debug Adapter.
A debug adapter factory that creates debug adapter trackers.
Configuration for a debug session.
A debug configuration provider allows to add debug configurations to the debug service and to resolve launch configurations before they are used to start a debug session. A debug configuration provider is registered via debug.registerDebugConfigurationProvider.
A DebugConfigurationProviderTriggerKind specifies when the provideDebugConfigurations
method of a DebugConfigurationProvider
is triggered. Currently there are two situations: to provide the initial debug configurations for a newly created launch.json or to provide dynamically generated debug configurations when the user asks for them through the UI (e.g. via the "Select and Start Debugging" command). A trigger kind is used when registering a DebugConfigurationProvider
with {@link debug.registerDebugConfigurationProvider}.
Represents the debug console.
Debug console mode used by debug session, see {@link DebugSessionOptions options}.
A DebugProtocolBreakpoint is an opaque stand-in type for the Breakpoint type defined in the Debug Adapter Protocol.
A DebugProtocolMessage is an opaque stand-in type for the ProtocolMessage type defined in the Debug Adapter Protocol.
A DebugProtocolSource is an opaque stand-in type for the Source type defined in the Debug Adapter Protocol.
A debug session.
A custom Debug Adapter Protocol event received from a debug session.
Options for starting a debug session.
Represents a stack frame in a debug session.
Represents a thread in a debug session.
The declaration of a symbol representation as one or many locations or location links.
Contains coverage information for a declaration. Depending on the reporter and language, this may be types such as functions, methods, or namespaces.
The declaration provider interface defines the contract between extensions and the go to declaration feature.
Represents render options for decoration instances. See DecorationOptions.renderOptions.
Represents options for a specific decoration in a decoration set.
Describes the behavior of decorations when typing/editing at their edges.
Represents rendering styles for a text editor decoration.
The definition of a symbol represented as one or many locations. For most programming languages there is only one location at which a symbol is defined.
Information about where a symbol is defined.
The definition provider interface defines the contract between extensions and the go to definition and peek definition features.
Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a file.
The event that is fired when diagnostics change.
A diagnostics collection is a container that manages a set of diagnostics. Diagnostics are always scopes to a diagnostics collection and a resource.
Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or related to a diagnostics, e.g. when duplicating a symbol in a scope.
Represents the severity of diagnostics.
Additional metadata about the type of a diagnostic.
Represents a type which can release resources, such as event listening or a timer.
The document color provider defines the contract between extensions and feature of picking and modifying colors in the editor.
An edit operation applied on drop.
Provider which handles dropping of resources into a text editor.
Provides additional metadata about how a {@linkcode DocumentDropEditProvider} works.
Identifies a {@linkcode DocumentDropEdit} or {@linkcode DocumentPasteEdit}
A document filter denotes a document by different properties like the language}, the {@link Uri.scheme scheme of its resource, or a glob-pattern that is applied to the path.
The document formatting provider interface defines the contract between extensions and the formatting-feature.
A document highlight is a range inside a text document which deserves special attention. Usually a document highlight is visualized by changing the background color of its range.
A document highlight kind.
The document highlight provider interface defines the contract between extensions and the word-highlight-feature.
A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.
The document link provider defines the contract between extensions and feature of showing links in the editor.
An edit the applies a paste operation.
Additional information about the paste operation.
Provider invoked when the user copies or pastes in a {@linkcode TextDocument}.
Provides additional metadata about how a {@linkcode DocumentPasteEditProvider} works.
The reason why paste edits were requested.
The document formatting provider interface defines the contract between extensions and the formatting-feature.
The document range semantic tokens provider interface defines the contract between extensions and semantic tokens.
A language selector is the combination of one or many language identifiers and language filters.
The document semantic tokens provider interface defines the contract between extensions and semantic tokens.
Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.
The document symbol provider interface defines the contract between extensions and the go to symbol-feature.
Metadata about a document symbol provider.
Describes what to do when pressing Enter.
A collection of mutations that an extension can apply to a process environment.
A type of mutation and its value to be applied to an environment variable.
Options applied to the mutator.
A type of mutation that can be applied to an environment variable.
The scope object to which the environment variable collection applies.
An EvaluatableExpression represents an expression in a document that can be evaluated by an active debugger or runtime. The result of this evaluation is shown in a tooltip-like widget. If only a range is specified, the expression will be extracted from the underlying document. An optional expression can be used to override the extracted expression. In this case the range is still used to highlight the range in the document.
The evaluatable expression provider interface defines the contract between extensions and the debug hover. In this contract the provider returns an evaluatable expression for a given position in a document and the editor evaluates this expression in the active debug session and shows the result in a debug hover.
An event emitter can be used to create and manage an Event for others to subscribe to. One emitter always owns one event.
An extension context is a collection of utilities private to an extension.
In a remote window the extension kind describes if an extension runs where the UI (window) runs or if an extension runs remotely.
The ExtensionMode is provided on the ExtensionContext
and indicates the mode the specific extension is running in.
Namespace for dealing with installed extensions. Extensions are represented by an Extension-interface which enables reflection on them.
Value-object describing what options a virtual process terminal should use.
The event filesystem providers must use to signal a file change.
Enumeration of file change types.
Contains coverage metadata for a file.
Coverage details returned from TestRunProfile.loadDetailedCoverage.
An event that is fired after files are created.
A file decoration represents metadata that can be rendered with a file.
The decoration provider interfaces defines the contract between extensions and file decorations.
An event that is fired after files are deleted.
Permissions of a file.
An event that is fired after files are renamed.
The file system interface exposes the editor's built-in and contributed file system providers. It allows extensions to work with files from the local disk as well as files from remote places, like the remote extension host or ftp-servers.
A type that filesystem providers should use to signal errors.
The filesystem provider defines what the editor needs to read, write, discover, and to manage files and folders. It allows extensions to serve files from remote places, like ftp-servers, and to seamlessly integrate those into the editor.
A file system watcher notifies about changes to files and folders on disk or from other FileSystemProviders.
An event that is fired when files are going to be created.
An event that is fired when files are going to be deleted.
An event that is fired when files are going to be renamed.
Folding context (for future use)
A line based folding range. To be valid, start and end line must be bigger than zero and smaller than the number of lines in the document. Invalid ranges will be ignored.
An enumeration of specific folding range kinds. The kind is an optional field of a {@link FoldingRange} and is used to distinguish specific folding ranges such as ranges originated from comments. The kind is used by commands like Fold all comments
or Fold all regions
. If the kind is not set on the range, the range originated from a syntax element other than comments, imports or region markers.
The folding range provider interface defines the contract between extensions and Folding in the editor.
Value-object describing what options formatting should use.
A breakpoint specified by a function name.
A collection of mutations that an extension can apply to a process environment. Applies to all scopes.
A file glob pattern to match file paths against. This can either be a glob pattern string (like **/*.{ts,js}
or *.{ts,js}
) or a relative pattern.
The hover provider interface defines the contract between extensions and the hover-feature.
Represents an icon in the UI. This is either an uri, separate uris for the light- and dark-themes, or a theme icon.
The implementation provider interface defines the contract between extensions and the go to implementation feature.
Describes what to do with the indentation when pressing Enter.
Describes indentation rules for a language.
Inlay hint kinds.
An inlay hint label part allows for interactive and composite labels of inlay hints.
The inlay hints provider interface defines the contract between extensions and the inlay hints feature.
Provides information about the context in which an inline completion was requested.
An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
The inline completion item provider interface defines the contract between extensions and the inline completion feature.
Represents a collection of inline completion items to be presented in the editor.
Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
Inline value information can be provided by different means:
A value-object that contains contextual information when requesting inline values from a InlineValuesProvider.
Provide an inline value through an expression evaluation. If only a range is specified, the expression will be extracted from the underlying document. An optional expression can be used to override the extracted expression.
The inline values provider interface defines the contract between extensions and the editor's debugger inline values feature. In this contract the provider returns inline value information for a given document range and the editor shows this information in the editor at the end of lines.
Provide inline value as text.
Provide inline value through a variable lookup. If only a range is specified, the variable name will be extracted from the underlying document. An optional variable name can be used to override the extracted name.
A concrete QuickInput to let the user input a text value.
Options to configure the behavior of the input box UI.
Object to configure the behavior of the validation message.
Impacts the behavior and appearance of the validation message. The severity level for input box validation.
Namespace for localization-related functionality in the extension API. To use this properly, you must have l10n
defined in your extension manifest and have bundle.l10n.
The language configuration interfaces defines the contract between extensions and various editor features, like automatic bracket insertion, automatic indentation etc.
Represents extension specific information about the access to language models.
Represents a language model for making chat requests.
Represents a message in a chat. Can assume different roles, like user or assistant.
Represents the role of a chat message. This is either the user or the assistant.
Options for making a chat request using a language model.
Represents a language model response.
Describes how to select language models for chat requests.
A tool that is available to the language model via LanguageModelChatRequestOptions. A language model uses all the properties of this interface to decide which tool to call, and how to call it.
A tool-calling mode for the language model to use.
An error type for language model specific errors.
A language model response part containing a PromptElementJSON from @vscode/prompt-tsx
.
A language model response part containing a piece of text, returned from a LanguageModelChatResponse.
A tool that can be invoked by a call to a LanguageModelChat.
A language model response part indicating a tool call, returned from a LanguageModelChatResponse, and also can be included as a content part on a LanguageModelChatMessage, to represent a previous tool call in a chat request.
When this is returned in PreparedToolInvocation, the user will be asked to confirm before running the tool. These messages will be shown with buttons that say "Continue" and "Cancel".
Information about a registered tool available in lm.tools.
Options provided for tool invocation.
Options for LanguageModelTool.prepareInvocation.
A result returned from a tool invocation. If using @vscode/prompt-tsx
, this result may be rendered using a ToolResult
.
The result of a tool call. This is the counterpart of a tool call and it can only be included in the content of a User message
Options related to tokenization for a tool invocation.
A language status item is the preferred way to present language status reports for the active text editors, such as selected linter or notifying about a configuration problem.
Represents the severity of a language status item. Represents the severity level of a language status.
The linked editing range provider interface defines the contract between extensions and the linked editing feature.
Represents a list of ranges that can be edited together along with a word pattern to describe valid range contents.
Represents the connection of two locations. Provides additional metadata over normal locations, including an origin range.
A channel for containing log output.
Human-readable text that supports formatting via the markdown syntax.
MarkedString can be used to render human-readable text. It is either a markdown string or a code-block that provides a language and a code snippet. Note that markdown strings will be sanitized - that means html will be escaped.
McpHttpServerDefinition represents an MCP server available using the Streamable HTTP transport.
Definitions that describe different types of Model Context Protocol servers, which can be returned from the McpServerDefinitionProvider.
A type that can provide Model Context Protocol server definitions. This should be registered using lm.registerMcpServerDefinitionProvider during extension activation.
McpStdioServerDefinition represents an MCP server available by running a local process and operating on its stdin and stdout streams. The process will be spawned as a child process of the extension host and by default will not run in a shell environment.
Represents an action that is shown with an information, warning, or error message.
Options to configure the behavior of the message.
Represents a cell of a notebook}, either a {@link NotebookCellKind.Code code-cell or markup-cell.
NotebookCellData is the raw representation of notebook cells. Its is part of {@linkcode NotebookData}.
A NotebookCellExecution is how notebook controller modify a notebook cell as it is executing.
The summary of a notebook cell execution.
A notebook cell kind.
Notebook cell output represents a result of executing a cell. It is a container type for multiple output items where contained items represent the same result but use different MIME types.
One representation of a notebook output, defined by MIME type and data.
Represents the alignment of status bar items.
A contribution to a cell's status bar
A provider that can contribute items to the status bar that appears below a cell's editor.
A notebook controller represents an entity that can execute notebook cells. This is often referred to as a kernel.
Notebook controller affinity for notebook documents.
Raw representation of a notebook.
Represents a notebook which itself is a sequence of code or markup cells. Notebook documents are created from notebook data.
Describes a change to a notebook cell.
An event describing a transactional notebook change.
Describes a structural change to a notebook document, e.g newly added and removed cells.
Notebook content options define what parts of a notebook are persisted. Note
Represents options to configure the behavior of showing a notebook document} in an {@link NotebookEditor notebook editor.
An event that is fired when a notebook document will be saved.
A notebook edit represents edits that should be applied to the contents of a notebook.
Represents a notebook editor that is attached to a notebook. Additional properties of the NotebookEditor are available in the proposed API, which will be finalized later.
Represents a notebook editor that is attached to a {@link NotebookDocument notebook}.
Represents an event describing the change in a notebook editor's selections.
Represents an event describing the change in a notebook editor's visibleRanges.
A notebook range represents an ordered pair of two cell indices. It is guaranteed that start is less than or equal to end.
Renderer messaging is used to communicate with a single renderer. It's returned from notebooks.createRendererMessaging.
The notebook serializer enables the editor to open notebook files.
Describes a rule to be evaluated when pressing Enter.
The document formatting provider interface defines the contract between extensions and the formatting-feature.
Options to configure the behaviour of a file open dialog.
An output channel is a container for readonly textual information.
Represents different positions for rendering a decoration in an {@link DecorationRenderOptions.overviewRulerLane overview ruler}. The overview ruler supports three lanes.
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
The result of a call to LanguageModelTool.prepareInvocation.
The execution of a task happens as an external process without shell interaction.
Options for a process execution
A location in the editor at which progress information can be shown. It depends on the location how progress is visually represented.
Value-object describing where and how progress should show.
A provider result represents the values a provider, like the {@linkcode HoverProvider}, may return. For once this is the actual result type T
, like Hover
, or a thenable that resolves to that type T
. In addition, null
and undefined
can be returned - either directly or from a thenable.
Defines the interface of a terminal pty, enabling extensions to control a terminal.
A quick diff provider provides a uri to the original state of a modified resource. The editor will use this information to render ad'hoc diffs within the text.
A light-weight user input UI that is initially not visible. After configuring it through its properties the extension can make it visible by calling QuickInput.show.
A concrete QuickInput to let the user pick an item from a list of items of type T. The items can be filtered through a filter text field and there is an option canSelectMany to allow for selecting multiple items.
Represents an item that can be selected from a list of items.
An event signaling when a button in a particular QuickPickItem was triggered. This event does not fire for buttons in the title bar.
The kind of {@link QuickPickItem quick pick item}.
Options to configure the behavior of the quick pick UI.
A range represents an ordered pair of two positions. It is guaranteed that start}.isBeforeOrEqual({@link Range.end end)
Value-object that contains additional information when requesting references.
The reference provider interface defines the contract between extensions and the find references-feature.
A relative pattern is a helper to construct glob patterns that are matched relatively to a base file path. The base path can either be an absolute file path as string or uri or a workspace folder, which is the preferred way of creating the relative pattern.
The rename provider interface defines the contract between extensions and the rename-feature.
Run options for a task.
Options to configure the behaviour of a file save dialog.
Represents a storage utility for secrets (or any information that is sensitive) that will be stored encrypted. The implementation of the secret storage will be different on each platform and the secrets will not be synced across machines.
The event data that is fired when a secret is added or removed.
Describes the currently selected completion item.
A selection range represents a part of a selection hierarchy. A selection range may have a parent selection range that contains it.
The selection range provider interface defines the contract between extensions and the "Expand and Shrink Selection" feature.
Represents semantic tokens, either in a range or in an entire document.
A semantic tokens builder can help with creating a SemanticTokens
instance which contains delta encoded semantic tokens.
Represents an edit to semantic tokens.
Represents edits to semantic tokens.
A semantic tokens legend contains the needed information to decipher the integer encoded representation of semantic tokens.
Represents a task execution that happens inside a shell.
Options for a shell execution
A string that will be quoted depending on the used shell.
Defines how an argument should be quoted if it contains spaces or unsupported characters.
The shell quoting options.
Signature help represents the signature of something callable. There can be multiple signatures but only one active and only one active parameter.
Additional information about the context in which a {@linkcode SignatureHelpProvider.provideSignatureHelp SignatureHelpProvider} was triggered.
The signature help provider interface defines the contract between extensions and the parameter hints-feature.
Metadata about a registered {@linkcode SignatureHelpProvider}.
How a {@linkcode SignatureHelpProvider} was triggered.
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
A snippet string is a template which allows to insert text and to control the editor cursor when insertion happens.
A snippet edit represents an interactive edit that is performed by the editor.
A breakpoint specified by a source location.
An source control is able to provide resource states to the editor and interact with the editor in several source control related ways.
Represents the input box in the Source Control viewlet.
The decorations for a source control resource state. Can be independently specified for light and dark themes.
A source control resource group is a collection of source control resource states.
An source control resource state represents the state of an underlying workspace resource within a certain source control group.
The theme-aware decorations for a source control resource state.
Contains coverage information for a single statement or line.
Represents the alignment of status bar items.
A status bar item is a status bar contribution that can show text and icons and run a command on click.
Represents information about programming constructs like variables, classes, interfaces etc.
A symbol kind.
Enumeration of commonly encountered syntax token types.
Represents a tab within a group of tabs. Tabs are merely the graphical representation within the editor area. A backing editor is not a guarantee.
An event describing change to tabs.
An event describing changes to tab groups.
The tab represents a custom editor.
The tab represents a notebook.
The tabs represents two notebooks in a diff configuration.
The tab represents a terminal in the editor area.
The tab represents a single text based resource.
The tab represents two text based resources being rendered as a diff.
The tab represents a webview.
A structure that defines a task kind in the system. The value must be JSON-stringifyable.
An event signaling the end of an executed task.
An object representing an executed Task. It can be used to terminate a task.
A task filter denotes tasks by their version and types
Controls how the task channel is used between tasks
Controls how the task is presented in the UI.
An event signaling the end of a process execution triggered through a task
An event signaling the start of a process execution triggered through a task
A task provider allows to add tasks to the task service. A task provider is registered via tasks.registerTaskProvider.
Controls the behaviour of the terminal's visibility.
An event signaling the start of a task execution.
A telemetry logger which can be used by extensions to log usage and error telemetry.
Options for creating a TelemetryLogger
The telemetry sender is the contract between a telemetry logger and some telemetry service. Note that extensions must NOT call the methods of their sender directly as the logger provides extra guards and cleaning.
A special value wrapper denoting a value that is safe to not clean. This is to be used when you can guarantee no identifiable information is contained in the value and the cleaning is improperly redacting it.
An individual terminal instance within the integrated terminal.
Represents the dimensions of a terminal.
Assumes a TerminalLocation of editor and allows specifying a ViewColumn and preserveFocus property
Terminal exit reason kind.
Represents how a terminal exited.
A link on a terminal line.
Provides information on a line in a terminal in order to provide links for it.
A provider that enables detection and handling of links within terminals.
The location of the terminal.
Value-object describing what options a terminal should use.
A terminal profile defines how a terminal will be launched.
Provides a terminal profile for the contributed terminal profile when launched via the UI or command.
A command that was executed in a terminal.
A command line that was executed in a terminal.
The confidence of a {@link TerminalShellExecutionCommandLine} value.
An event signalling that an execution has ended in a terminal.
An event signalling that an execution has started in a terminal.
Shell integration-powered capabilities owned by a terminal.
An event signalling that a terminal's shell integration has changed.
Uses the parent Terminal's location for the terminal
Represents the state of a Terminal.
Entry point to discover and execute tests. It contains TestController.items which are used to populate the editor UI, and is associated with run profiles to allow for tests to be executed.
A class that contains information about a covered resource. A count can be give for lines, branches, and declarations in a file.
Collection of test items, found in TestItem.children and TestController.items.
Message associated with the test state. Can be linked to a specific source range -- useful for assertion failures, for example.
A stack frame found in the TestMessage.stackTrace.
A TestRunProfile describes one way to execute tests in a TestController.
The kind of executions that {@link TestRunProfile TestRunProfiles} control.
A TestRunRequest is a precursor to a TestRun, which in turn is created by passing a request to TestController.createTestRun. The TestRunRequest contains information about which tests should be run, which should not be run, and how they are run (via the profile).
Namespace for testing functionality. Tests are published by registering TestController instances, then adding TestItems. Controllers may also describe how to run tests by creating one or more TestRunProfile instances.
Tags can be associated with TestItems and TestRunProfiles. A profile with a tag can only execute tests that include that tag in their TestItem.tags array.
Represents a text document, such as a source file. Text documents have lines and knowledge about an underlying resource like a file.
An event describing a transactional document change.
Reasons for why a text document has changed.
An event describing an individual change in the text of a document.
A text document content provider allows to add readonly documents to the editor, such as source from a dll or generated html from md.
Represents reasons why a text document is saved.
Represents options to configure the behavior of showing a document} in an {@link TextEditor editor.
An event that is fired when a document will be saved.
Represents an editor that is attached to a document.
Rendering style of the cursor.
Represents a handle to a set of decorations sharing the same styling options} in a {@link TextEditor text editor.
A complex edit that will be applied in one transaction on a TextEditor. This holds a description of the edits and if the edits are valid (i.e. no overlapping regions, document was not changed in the meantime, etc.) they can be applied on a document} associated with a {@link TextEditor text editor.
Rendering style of the line numbers.
Represents a text editor}'s {@link TextEditor.options options.
Represents an event describing the change in a text editor's options.
Represents different {@link TextEditor.revealRange reveal} strategies in a text editor.
Represents an event describing the change in a text editor's selections.
Represents sources that can cause {@link window.onDidChangeTextEditorSelection selection change events}.
Represents an event describing the change of a text editor's view column.
Represents an event describing the change in a text editor's visible ranges.
Represents themable render options for decoration instances.
Represents theme specific rendering styles for a text editor decoration.
A reference to one of the workbench colors as defined in https://code.visualstudio.com/api/references/theme-color. Using a theme color is preferred over a custom color as it gives theme authors and users the possibility to change the color.
A reference to a named icon. Currently, File}, {@link ThemeIcon.Folder Folder, and ThemeIcon ids are supported. Using a theme icon is preferred over a custom icon as it gives product theme authors the possibility to change the icons.
An event describing the change in a tree item's checkbox state.
A data provider that provides tree data
Provides support for drag and drop in TreeView
.
A tree item is an UI element of the tree. Tree items are created by the data provider.
Checkbox state of the tree item
Collapsible state of the tree item
Label describing the Tree item
Represents a Tree view
The event that is fired when an element in the TreeView is expanded or collapsed
Options for creating a TreeView
The event that is fired when there is a change in tree view's selection
The event that is fired when there is a change in tree view's visibility
The type definition provider defines the contract between extensions and the go to type definition feature.
Represents an item of a type hierarchy, like a class or an interface.
The type hierarchy provider interface describes the contract between extensions and the type hierarchy feature.
A uri handler is responsible for handling system-wide uris.
Denotes a location of an editor in the window. Editors can be arranged in a grid and each column represents one editor location in that grid by counting the editors in order of their appearance.
Content settings for a webview.
A panel that contains a webview.
Event fired when a webview panel's view state changes.
Content settings for a webview panel.
Restore webview panels that have been persisted when vscode shuts down.
Defines a port mapping used for localhost inside the webview.
A webview based view.
Provider for creating WebviewView
elements.
Additional information the webview view being resolved.
Represents the state of a window.
Represents the configuration. It is a merged view of
A workspace edit is a collection of textual and files changes for multiple resources and documents.
Additional data for entries of a workspace edit. Supports to label entries and marks entries as needing confirmation by the user. The editor groups edits with equal labels into tree nodes, for instance all edits labelled with "Changes in Strings" would be a tree node.
Additional data about a workspace edit.
A workspace folder is one of potentially many roots opened by the editor. All workspace folders are equal which means there is no notion of an active or primary workspace folder.
Options to configure the behaviour of the workspace folder pick UI.
An event describing a change to the set of workspace folders.
The workspace symbol provider interface defines the contract between extensions and the symbol search-feature.