Skip to content

Commit 3bbecab

Browse files
dkattandkattan
committed
fix: update descriptions and enforce required action field in StartDebuggingAndWaitForStopParams interface
1 parent f8a708c commit 3bbecab

File tree

9 files changed

+136
-113
lines changed

9 files changed

+136
-113
lines changed

‎README.md‎

Lines changed: 38 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,12 @@ npm run compile
4848
<!-- commands-list -->
4949

5050
#### Copilot Breakpoint Debugger: Copilot Breakpoint Debugger: Manual Start &amp; Wait
51-
Command : `copilotBreakpointDebugger.startAndWaitManual`
51+
52+
Command : `copilotBreakpointDebugger.startAndWaitManual`
5253

5354
#### Copilot Breakpoint Debugger: Copilot Breakpoint Debugger: Insert Sample Start Payload
54-
Command : `copilotBreakpointDebugger.insertSampleStartDebuggerPayload`
55+
56+
Command : `copilotBreakpointDebugger.insertSampleStartDebuggerPayload`
5557

5658
<!-- commands-list -->
5759

@@ -60,53 +62,58 @@ Command : `copilotBreakpoint
6062
<!-- configs-list -->
6163

6264
#### `copilot-debugger.defaultLaunchConfiguration`
63-
Description : Name of the default launch configuration to use when starting the debugger
64-
Type : `string`
65-
Default : `""`
65+
66+
Description : Name of the default launch configuration to use when starting the debugger
67+
Type : `string`
68+
Default : `""`
6669

6770
#### `copilot-debugger.entryTimeoutSeconds`
68-
Description : Timeout in seconds waiting for initial entry stop after launching (before first user breakpoint). Supports long startup/build times; must be &gt; 0.
69-
Type : `integer`
70-
Default : `60`
71+
72+
Description : Timeout in seconds waiting for initial entry stop after launching (before first user breakpoint). Supports long startup/build times; must be &gt; 0.
73+
Type : `integer`
74+
Default : `60`
7175

7276
#### `copilot-debugger.captureMaxVariables`
73-
Description : Maximum number of variables auto-captured when a breakpoint action=capture omits variableFilter (capture-all mode).
74-
Type : `integer`
75-
Default : `40`
77+
78+
Description : Maximum number of variables auto-captured when a breakpoint action=capture omits variableFilter (capture-all mode).
79+
Type : `integer`
80+
Default : `40`
7681

7782
#### `copilot-debugger.serverReadyEnabled`
78-
Description : Enable serverReady automation (trigger + action). When disabled, provided serverReady payloads are ignored.
79-
Type : `boolean`
80-
Default : `true`
8183

82-
> When this flag is `false`, the Start Debugger tool logs the attempted payload and skips all serverReady processing, ensuring automation never runs accidentally.
84+
Description : Enable serverReady automation (trigger + action). When disabled, provided serverReady payloads are ignored.
85+
Type : `boolean` F
86+
Default : `true`
8387

8488
#### `copilot-debugger.serverReadyDefaultActionType`
85-
Description : Preferred serverReady action type surfaced in samples and quick insert command.
86-
Type : `string`
87-
Default : `"httpRequest"`
8889

89-
> The `copilotBreakpointDebugger.insertSampleStartDebuggerPayload` command reads this value every time it runs so you can get sample JSON pre-filled with your preferred action style (HTTP request, shell command, or VS Code command).
90+
Description : Preferred serverReady action type surfaced in samples and quick insert command.
91+
Type : `string`
92+
Default : `"httpRequest"`
9093

9194
#### `copilot-debugger.maxBuildErrors`
92-
Description : Maximum number of build diagnostics (from problem matchers) to include in error messages when debug session fails to start.
93-
Type : `integer`
94-
Default : `5`
95+
96+
Description : Maximum number of build diagnostics (from problem matchers) to include in error messages when debug session fails to start.
97+
Type : `integer`
98+
Default : `5`
9599

96100
#### `copilot-debugger.maxOutputLines`
97-
Description : Maximum number of output lines (stderr/stdout) to buffer per debug session for runtime error reporting.
98-
Type : `integer`
99-
Default : `50`
101+
102+
Description : Maximum number of output lines (stderr/stdout) to buffer per debug session for runtime error reporting.
103+
Type : `integer`
104+
Default : `50`
100105

101106
#### `copilot-debugger.consoleLogLevel`
102-
Description : Controls how verbosely logs are mirrored to the developer console (Output panel always receives every log; this only gates console.* mirroring). Changes take effect immediately without reloading.
103-
Type : `string`
104-
Default : `"info"`
107+
108+
Description : Controls how verbosely logs are mirrored to the developer console (Output panel always receives every log; this only gates console.\* mirroring). Changes take effect immediately without reloading.
109+
Type : `string`
110+
Default : `"info"`
105111

106112
#### `copilot-debugger.enableTraceLogging`
107-
Description : Emit verbose Debug Adapter Protocol trace logs to the output channel for troubleshooting.
108-
Type : `boolean`
109-
Default : `false`
113+
114+
Description : Emit verbose Debug Adapter Protocol trace logs to the output channel for troubleshooting.
115+
Type : `boolean`
116+
Default : `false`
110117

111118
<!-- configs-list -->
112119

‎package.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@
167167
"capture",
168168
"stopDebugging"
169169
],
170-
"description": "Breakpoint action: break pauses and returns; capture collects variables & interpolated log messages then resumes (non-blocking); stopDebugging terminates session after hit. Default is break."
170+
"description": "Breakpoint action: break pauses and returns; capture collects variables & interpolated log messages then resumes (non-blocking); stopDebugging terminates session after hit."
171171
},
172172
"condition": {
173173
"type": "string",
@@ -188,7 +188,8 @@
188188
},
189189
"required": [
190190
"path",
191-
"line"
191+
"line",
192+
"action"
192193
]
193194
},
194195
"description": "Breakpoints to add before starting session."

‎src/session.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -909,7 +909,7 @@ export interface StartDebuggingAndWaitForStopParams {
909909
hitCount?: number; // numeric hit count (exact)
910910
logMessage?: string;
911911
variableFilter?: string[]; // optional; when capture and omitted we auto-capture all locals (bounded in StartDebuggerTool)
912-
action?: "break" | "stopDebugging" | "capture"; // 'capture' collects data + log messages then continues
912+
action: "break" | "stopDebugging" | "capture"; // 'capture' collects data + log messages then continues
913913
reasonCode?: string; // internal telemetry tag
914914
}>;
915915
};

‎src/startDebuggerTool.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export interface BreakpointDefinition {
1616
path: string;
1717
line: number;
1818
variableFilter?: string[]; // Optional: when action=capture and omitted we auto-capture all locals (bounded by captureMaxVariables setting)
19-
action?: "break" | "stopDebugging" | "capture"; // 'capture' returns data then continues (non-blocking)
19+
action: "break" | "stopDebugging" | "capture"; // 'capture' returns data then continues (non-blocking)
2020
condition?: string; // Expression evaluated at breakpoint; stop only if true
2121
hitCount?: number; // Exact numeric hit count (3 means pause on 3rd hit)
2222
logMessage?: string; // Logpoint style message with {var} interpolation

‎src/test/buildDiagnostics.test.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ describe("build diagnostics integration tests", () => {
4444
{
4545
path: "broken.ts",
4646
line: 4,
47+
action: "break",
4748
variableFilter: ["x"],
4849
},
4950
],

0 commit comments

Comments
 (0)