dots.vscode.test-message — io.github.dots-cljs/dots-vscode 1.89.0-6

Message associated with the test state. Can be linked to a specific source range -- useful for assertion failures, for example.

actual-output cljs

(actual-output test-message)

Actual test output. If given with {@link TestMessage.expectedOutput expectedOutput }, a diff view will be shown.

Returns: string | undefined

context-value cljs

(context-value test-message)

Context value of the test item. This can be used to contribute message- specific actions to the test peek view. The value set here can be found in the testMessage property of the following menus contribution points:

• testing/message/context - context menu for the message in the results tree
• testing/message/content - a prominent button overlaying editor content where the message is displayed.

For example:

"contributes": {
  "menus": {
    "testing/message/content": [
      {
        "command": "extension.deleteCommentThread",
        "when": "testMessage == canApplyRichDiff"
      }
    ]
  }
}

The command will be called with an object containing:

• test: the {@link TestItem } the message is associated with, if it is still present in the {@link TestController.items } collection.
• message: the {@link TestMessage } instance.

Returns: string | undefined

diff cljs

(diff message expected actual)

Creates a new TestMessage that will present as a diff in the editor.

Parameters:

• message: string | MarkdownString - Message to display to the user.
• expected: string - Expected output.
• actual: string - Actual output.

Returns: TestMessage

expected-output cljs

(expected-output test-message)

Expected test output. If given with {@link TestMessage.actualOutput actualOutput }, a diff view will be shown.

Returns: string | undefined

location cljs

(location test-message)

Associated file location.

Returns: Location | undefined

message cljs

(message test-message)

Human-readable message text to display.

Returns: string | MarkdownString

set-actual-output! cljs

(set-actual-output! test-message value)

Actual test output. If given with {@link TestMessage.expectedOutput expectedOutput }, a diff view will be shown.

set-context-value! cljs

(set-context-value! test-message value)

Context value of the test item. This can be used to contribute message- specific actions to the test peek view. The value set here can be found in the testMessage property of the following menus contribution points:

• testing/message/context - context menu for the message in the results tree
• testing/message/content - a prominent button overlaying editor content where the message is displayed.

For example:

"contributes": {
  "menus": {
    "testing/message/content": [
      {
        "command": "extension.deleteCommentThread",
        "when": "testMessage == canApplyRichDiff"
      }
    ]
  }
}

The command will be called with an object containing:

• test: the {@link TestItem } the message is associated with, if it is still present in the {@link TestController.items } collection.
• message: the {@link TestMessage } instance.

set-expected-output! cljs

(set-expected-output! test-message value)

Expected test output. If given with {@link TestMessage.actualOutput actualOutput }, a diff view will be shown.

set-location! cljs

(set-location! test-message value)

Associated file location.

set-message! cljs

(set-message! test-message value)

Human-readable message text to display.