Skip to content

Commit 5c94f3d

Browse files
committed
add Test(Suite)Info#description, Test(Suite)Event#description and Test(Suite)Event#tooltip
1 parent a55fed9 commit 5c94f3d

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

src/index.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,9 @@ export interface TestSuiteInfo {
168168
/** The label to be displayed by the Test Explorer for this suite. */
169169
label: string;
170170

171+
/** The description to be displayed next to the label. */
172+
description?: string;
173+
171174
/** The tooltip text to be displayed by the Test Explorer when you hover over this suite. */
172175
tooltip?: string;
173176

@@ -196,6 +199,9 @@ export interface TestInfo {
196199
/** The label to be displayed by the Test Explorer for this test. */
197200
label: string;
198201

202+
/** The description to be displayed next to the label. */
203+
description?: string;
204+
199205
/** The tooltip text to be displayed by the Test Explorer when you hover over this test. */
200206
tooltip?: string;
201207

@@ -228,6 +234,18 @@ export interface TestSuiteEvent {
228234
suite: string | TestSuiteInfo;
229235

230236
state: 'running' | 'completed';
237+
238+
/**
239+
* This property allows you to update the description of the suite in the Test Explorer.
240+
* When the test states are reset, the description will change back to the one from `TestSuiteInfo`.
241+
*/
242+
description?: string;
243+
244+
/**
245+
* This property allows you to update the tooltip of the suite in the Test Explorer.
246+
* When the test states are reset, the tooltip will change back to the one from `TestSuiteInfo`.
247+
*/
248+
tooltip?: string;
231249
}
232250

233251
/**
@@ -257,6 +275,18 @@ export interface TestEvent {
257275
* They are usually used to show information about a test failure at the location of that failure.
258276
*/
259277
decorations?: TestDecoration[];
278+
279+
/**
280+
* This property allows you to update the description of the test in the Test Explorer.
281+
* When the test states are reset, the description will change back to the one from `TestInfo`.
282+
*/
283+
description?: string;
284+
285+
/**
286+
* This property allows you to update the tooltip of the test in the Test Explorer.
287+
* When the test states are reset, the tooltip will change back to the one from `TestInfo`.
288+
*/
289+
tooltip?: string;
260290
}
261291

262292
export interface TestDecoration {

0 commit comments

Comments
 (0)