From 155d2bb9fb250ee29ef2ac5140d822bbad4090d1 Mon Sep 17 00:00:00 2001 From: Connor Peet Date: Wed, 30 Oct 2024 15:42:44 -0700 Subject: [PATCH 1/5] fix: clarify how StackTraceArguments.format applies (#510) Closes #411 --- changelog.md | 3 +++ debugAdapterProtocol.json | 2 +- specification.md | 4 +++- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/changelog.md b/changelog.md index b1045b3..c469c89 100644 --- a/changelog.md +++ b/changelog.md @@ -6,6 +6,9 @@ sectionid: changelog #### All notable changes to the specification will be documented in this file. +* 1.70.x + * Clarify how `StackTraceArguments.format` applies + * 1.69.x * Clarify the flow diagram to start a debug session * Add `supportsANSIStyling` capabilities to allow colorization of text from debug adapters diff --git a/debugAdapterProtocol.json b/debugAdapterProtocol.json index 51737da..9e148d6 100644 --- a/debugAdapterProtocol.json +++ b/debugAdapterProtocol.json @@ -2033,7 +2033,7 @@ }, "format": { "$ref": "#/definitions/StackFrameFormat", - "description": "Specifies details on how to format the stack frames.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsValueFormattingOptions` is true." + "description": "Specifies details on how to format the returned `StackFrame.name`. The debug adapter may format requested details in any way that would make sense to a developer.\nThe attribute is only honored by a debug adapter if the corresponding capability `supportsValueFormattingOptions` is true." } }, "required": [ "threadId" ] diff --git a/specification.md b/specification.md index d299a99..691cd73 100644 --- a/specification.md +++ b/specification.md @@ -2222,7 +2222,9 @@ interface StackTraceArguments { levels?: number; /** - * Specifies details on how to format the stack frames. + * Specifies details on how to format the returned `StackFrame.name`. The + * debug adapter may format requested details in any way that would make sense + * to the developer. * The attribute is only honored by a debug adapter if the corresponding * capability `supportsValueFormattingOptions` is true. */ From 77434168a4c9095eed1b54fd88ea4d1cd3891b40 Mon Sep 17 00:00:00 2001 From: Connor Peet Date: Tue, 12 Nov 2024 10:19:52 -0800 Subject: [PATCH 2/5] fix: clarify `ContinuedEvent.allThreadsContinued` (#514) Fixes #513 --- changelog.md | 1 + debugAdapterProtocol.json | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/changelog.md b/changelog.md index c469c89..4d7884c 100644 --- a/changelog.md +++ b/changelog.md @@ -8,6 +8,7 @@ sectionid: changelog * 1.70.x * Clarify how `StackTraceArguments.format` applies + * Clarify the default behavior of `ContinuedEvent.allThreadsContinued` * 1.69.x * Clarify the flow diagram to start a debug session diff --git a/debugAdapterProtocol.json b/debugAdapterProtocol.json index 9e148d6..7c7fea1 100644 --- a/debugAdapterProtocol.json +++ b/debugAdapterProtocol.json @@ -249,7 +249,7 @@ }, "allThreadsContinued": { "type": "boolean", - "description": "If `allThreadsContinued` is true, a debug adapter can announce that all threads have continued." + "description": "If omitted or set to `true`, this event signals to the client that all threads have been resumed. The value `false` indicates that not all threads were resumed." } }, "required": [ "threadId" ] @@ -1673,7 +1673,7 @@ "properties": { "allThreadsContinued": { "type": "boolean", - "description": "The value true (or a missing property) signals to the client that all threads have been resumed. The value false indicates that not all threads were resumed." + "description": "If omitted or set to `true`, this response signals to the client that all threads have been resumed. The value `false` indicates that not all threads were resumed." } } } From b15b1cc697d4ce5c0bd095ca1439f73178239dbe Mon Sep 17 00:00:00 2001 From: Song Date: Tue, 10 Dec 2024 05:18:06 +0800 Subject: [PATCH 3/5] chore: add luau debugger (#516) --- _implementors/adapters.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_implementors/adapters.md b/_implementors/adapters.md index 32fcbe3..67a7b25 100644 --- a/_implementors/adapters.md +++ b/_implementors/adapters.md @@ -56,6 +56,7 @@ Many adapters publish releases tailored for specific editors, such as VS Code, a [LLDB Debugger](https://github.com/vadimcn/vscode-lldb)|[@vadimcn](https://github.com/vadimcn)|[VS Code](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) [Lua and Ravi 5.3 Debugger](https://github.com/dibyendumajumdar/ravi-vscode-debugger)|[@dibyendumajumdar](https://github.com/dibyendumajumdar)|[VS Code](https://marketplace.visualstudio.com/items?itemName=ravilang.ravi-debug) [Lua Debug](https://github.com/actboy168/lua-debug)|[@actboy168](https://github.com/actboy168)|[VS Code](https://marketplace.visualstudio.com/items?itemName=actboy168.lua-debug) +[Luau Debugger](https://github.com/sssooonnnggg/luau-debugger)|[@sssooonnnggg](https://github.com/sssooonnnggg)|[VS Code](https://marketplace.visualstudio.com/items?itemName=sssooonnnggg.luau-debugger) [Mock Debug](https://github.com/Microsoft/vscode-mock-debug)|[@roblourens](https://github.com/roblourens)|[VS Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.mock-debug) [Mono Debug](https://github.com/Microsoft/vscode-mono-debug)|[@akoeplinger](https://github.com/akoeplinger)|[VS Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.mono-debug) [NAME](https://github.com/utdscheld/name)|[John Cole](https://personal.utdallas.edu/~John.Cole/)| From 62e4f563b5d717b747c86687c748a51e3abff6f7 Mon Sep 17 00:00:00 2001 From: Connor Peet Date: Wed, 11 Dec 2024 11:52:57 -0800 Subject: [PATCH 4/5] chore: prep for 1.70 (#517) --- index.html | 2 +- specification.md | 13 +++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/index.html b/index.html index e4b1653..fb443ce 100644 --- a/index.html +++ b/index.html @@ -86,7 +86,7 @@

Specification

- The latest version of the protocol specification is version 1.64.0. + The latest version of the protocol specification is version 1.70.0.

Change History diff --git a/specification.md b/specification.md index 691cd73..3cb9842 100644 --- a/specification.md +++ b/specification.md @@ -313,8 +313,9 @@ interface ContinuedEvent extends Event { threadId: number; /** - * If `allThreadsContinued` is true, a debug adapter can announce that all - * threads have continued. + * If omitted or set to `true`, this event signals to the client that all + * threads have been resumed. The value `false` indicates that not all + * threads were resumed. */ allThreadsContinued?: boolean; }; @@ -1811,9 +1812,9 @@ Response to `continue` request. interface ContinueResponse extends Response { body: { /** - * The value true (or a missing property) signals to the client that all - * threads have been resumed. The value false indicates that not all threads - * were resumed. + * If omitted or set to `true`, this response signals to the client that all + * threads have been resumed. The value `false` indicates that not all + * threads were resumed. */ allThreadsContinued?: boolean; }; @@ -2224,7 +2225,7 @@ interface StackTraceArguments { /** * Specifies details on how to format the returned `StackFrame.name`. The * debug adapter may format requested details in any way that would make sense - * to the developer. + * to a developer. * The attribute is only honored by a debug adapter if the corresponding * capability `supportsValueFormattingOptions` is true. */ From bcb11b3e3b440fec3f0af3d27d77916d8213ee05 Mon Sep 17 00:00:00 2001 From: Connor Peet Date: Mon, 16 Dec 2024 15:51:54 -0800 Subject: [PATCH 5/5] chore: add alt text for sequence diagrams (#520) --- overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/overview.md b/overview.md index 815ce4f..978594e 100644 --- a/overview.md +++ b/overview.md @@ -179,7 +179,7 @@ After the response to `configurationDone` is sent, the debug adapter may respond The following sequence diagram summarizes the sequence of requests and events for a hypothetical _gdb_ debug adapter: - +Sequence diagram of the launch flow ### Stopping and accessing debuggee state @@ -233,7 +233,7 @@ If the debuggee has ended (and the debug adapter is able to detect this), an opt This diagram summarizes the sequence of request and events for a hypothetical debug adapter for _gdb_: - +Sequence diagram of the termination flow ## Libraries (SDKs) for DAP providers and consumers