VS Code Debug Protocol
This npm module contains declarations for the json-based Visual Studio Code debug protocol.
History
-
1.25.x:
- Adds a new enum value
virtualfor thepresentationHintattribute of typeVariable. - To remove env variables from the environment support a 'null' value for
envattribute inrunInTerminalrequest.
- Adds a new enum value
-
1.24.x:
- Adds
removedto the value set of thereasonattribute of theBreakpointEvent. - Adds a
localeattribute to theinitializerequest. The adapter can use this information to translate user visible information.
- Adds
-
1.23.x:
- Adds a
source,line, andcolumnattributes to theOutputevent. With this a frontend can show a link to the source where the output was generated. - Adds support for retrieving loaded scripts and receiving loaded script events (
LoadedSourcesRequest,LoadedSourceEvent). - Adds display hints for variables and evaluation results (type
VariablePresentationHint).
- Adds a
-
1.22.x:
- Adds a new enum value
normalfor thepresentationHintattribute of typeSource. - Adds a new event
processthat conveys process ID and other information about the debuggee.
- Adds a new enum value
-
1.21.x:
- Adds optional attribute
includeAllto typeStackFrameFormat. With this theStackTraceRequestcan be parameterized to include all stack frames, including those the DA might otherwise hide. - Adds capability
supportsDelayedStackTraceLoadingthat indicates that a debug adapter supports the delayed loading of parts of the stack. This requires that both thestartFrameandlevelsarguments and thetotalFramesresult of theStackTraceRequestare supported.
- Adds optional attribute
-
1.20.x:
- Extends the type of the
TerminatedEvent.body.restartattribute frombooleantoany. This makes it possible to loop arbitrary data from one debug session to the next. - Adds a new enum value
subtlefor thepresentationHintattribute of typeStackFrame.
- Extends the type of the
-
1.19.x:
- Adds a new optional argument
terminateDebuggeeto thedisconnectrequest. If a debug adapter has opted into this feature with the 'supportTerminateDebuggee' capability, a client can use this to control whether the debuggee should be terminated when the debugger is disconnected.
- Adds a new optional argument
-
1.18.x:
- Adds optional attribute
sourceto theSourceArguments. - Made StoppedEvent's
reasonattribute robust against translation by introducing a newdescriptionattribute. - Add a new optional attribute
presentationHintto theStackFrametype. This attribute can be used to control how the frame is rendered in the UI.
- Adds optional attribute
-
1.17.x:
- Adds optional attribute
clientIDto theInitializeRequestArguments. - Adds support for obtaining exception details:
ExceptionInfoRequest,ExceptionDetails. - Adds optional parameter
formatto theSetVariableRequest.
- Adds optional attribute
-
1.16.x:
- Updated comments for
pathandsourceReferenceattributes ofSourcetype (the frontend no longer needs to have a notion of 'internal' modules; it just loads the content of a Source either through the sourceReference or the path). - Adds optional
presentationHintattribute toSourcetype. This allows to control how the frontend shows a source reference in th UI. - Removed
SHA1NormalizedandSHA256Normalizedvalues from typeChecksumAlgorithm.
- Updated comments for
-
1.15.x:
- Adds a
reverseContinuerequest. - Adds a
restartrequest and a correspondingsupportsRestartRequestcapability. - Adds a
variablesReferenceattribute to theOutputEvent. - Adds support for exception configuration options.
- Adds formatting options support for values returned from
VariablesRequest,EvaluateRequest, andStackTraceRequest.
- Adds a
-
1.14.x:
- Adds optional
typeattribute to theSetVariableResponsetype. - Support to return a structured object from the
SetVariableRequest. - Fine tuning of
Modulepart of the protocol. - Adds optional attribute
evaluatabletoVariabletype. - Adds optional checksum support to
Sourcetype. - Adds optional source range to
Scopetype.
- Adds optional
-
1.13.x:
- Fix typo in
Capabilitiestype. - Adds an optional
hitConditionattribute to breakpoints and a correspondingsupportsHitConditionalBreakpointscapability.
- Fix typo in
-
1.12.x:
- Adds a new optional attribute
frameIdto thecompletionRequest. - Introduces a
runInTerminalRequestso that a debug adapter can run a debuggee in a terminal managed by the frontend. - Adds a
typeattribute (and a value set) to theCompletionItem.
- Adds a new optional attribute
-
1.11.x:
- Adds a new optional attribute
mimeTypeto theSourceResponse. - Adds a new optional attribute
sourceModifiedto theSetBreakpointsArgumentsthat indicates that the underlying source has been modified which results in new breakpoint locations. - Adds a new optional attribute
supportsVariableTypetoInitializeRequestArguments. True indicates that the client shows the variable's type attribute in the UI. - Adds optional 'type' attribute to the
EvaluateResponse. - Introduces the
RestartFrameRequestand a correspondingsupportsRestartFramecapability. - Introduces a
ContinuedEventso that a debug adapter can explicit trigger that a thread has continued execution. - Adds support for step in targets (request
StepInTargetsRequest, typeStepInTarget, capabilitysupportsStepInTargetsRequest) - Adds support for goto targets (requests
GotoTargetsRequestandGotoRequest, typeGotoTarget, capabilitysupportsGotoTargetsRequest) - Adds support for variable paging, that is named and indexed children of a variable can be requested in pages (chunks).
- Adds experimental support for completion proposals.
- Adds a new optional attribute
-
1.10.x:
- Introduces a
stepBackrequest and a correspondingsupportsStepBackcapability. - Introduces the type
Module, aModuleRequest, and aModuleEvent - Introduces the
setVariableRequest - Adds new optional attributes
typeandkindfor aVariable. - Adds optional attributes
endLineandendColumntoStackFrameandBreakpointtypes.
- Introduces a
-
1.9.x:
- Introduces a
allThreadsContinuedattribute on theContinueResponseto indicate that all threads are continued and not only the one specified.
- Introduces a
-
1.8.x:
- Introduces
ExceptionBreakpointsFilterand fixed corresponding capability. - Adds optional
noDebugattribute toLaunchRequestArguments. - Adds optional
startFrameargument toStackTraceArgumentsto allow for paging. - Adds optional
totalFramesargument toStackTraceResponseto allow for paging. - Improve comment:
InitializedEventmust not be sent beforeInitializeRequesthas returned its result.
- Introduces
-
1.7.x:
- Adds optional
urlandurlLabelattributes to the error messages. The frontend will show this as a UI to open additional information in a browser. - Added option
defaultattribute to theexceptionBreakpointFilterscapability. - Adds optional attribute
allThreadsStoppedto theStoppedEventto indicate that all threads are stopped (and not only the one mentioned in the event).
- Adds optional
-
1.6.x:
- A boolean
supportsConditionalBreakpointsinCapabilitiesindicates whether the debug adapter supports conditional breakpoints. - Adds an optional
exceptionBreakpointFilterscapability that lists the filters available for thesetExceptionBreakpointsrequest. - Adds an optional
restartattribute to theTerminatedEventwhich can be used to request a restart of the debug session.
- A boolean
-
1.5.x:
- A boolean
supportsFunctionBreakpointsinCapabilitiesindicates whether the debug adapter implements the function breakpoints. - Renamed
supportEvaluateForHoversinCapabilitiestosupportsEvaluateForHovers.
- A boolean
-
1.4.x:
- Made the
bodyof theInitializeResponseoptional (for backward compatibility).
- Made the
-
1.3.x: Version introduces support for feature negotiation.
- The
InitializeResponsehas now attributes for these features:- A boolean
supportsConfigurationDoneRequestindicates whether the debug adapter implements theConfigurationDoneRequest. - A boolean
supportEvaluateForHoversindicates whether the debug adapter supports a side effect freeEvaluateRequest.
- A boolean
- Adds an optional
dataattribute to theOutputEventand atelemetrycategory. - Adds a new context type
hoverto thecontextattribute of theEvaluateArguments.
- The
-
1.2.x: Version adds a new request:
- Introduces a
ConfigurationDoneRequestthat VS Code sends to indicate that the configuration of the debug session has finished and that debugging can start.
- Introduces a
-
1.1.x: Version adds support for conditional breakpoints and breakpoints in virtual documents:
- Type
Sourcesupports optionaloriginattribute to provide information that is shown in the debug UI. - Type
Sourcesupports an optionaladapterDataattribute that the VS Code debug UI will transparently persists for breakpoints. - Introduces type
SourceBreakpointthat makes it possible to providecolumnandconditioninformation when specifying a breakpoint.
- Type
-
1.0.1: Initial version of the debug protocol