Merge pull request #680 from fable-hub/add_optional_msg_in_expect

feat: add support for optional message in `expect` API

Author: Freymaurer

build.sh

@@ -1,4 +1,5 @@
 {
+    "name": "feliz-packages",
     "private": true,
     "scripts": {
         "publish-docs": "npm run build && node publish.js",

package-lock.json

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## 1.0.0-rc.2 - 2025-10-20
+
+### Changed
+
+- PR #680: Add support for optional message in expect API (by @MangelMaxime)
+
 ## 1.0.0-rc.1 - 2025-09-18
 
 ### Added

package.json

@@ -239,6 +239,7 @@ type TestAPI =
 type TestContext =
     abstract member task: Task
     abstract member expect: value: obj -> IAssertion<obj>
+    abstract member expect: value: obj * ?msg: string -> IAssertion<obj>
     abstract member skip: unit -> unit
     abstract member skip: note: string -> unit
     abstract member skip: condition: bool -> unit
@@ -396,7 +397,7 @@ type Vitest =
     // static member expectPromise<'a>(value: Promise<'a>) : IPromiseAssertion<'a> = jsNative
 
     [<ImportMember("vitest")>]
-    static member expect<'a>(value: 'a) : IAssertion<'a> = jsNative
+    static member expect<'a>(value: 'a, ?msg : string) : IAssertion<'a> = jsNative
 
     [<Import("expect", "vitest")>]
     static member Expect: ExpectStatic = jsNative

src/Vitest/CHANGELOG.md

@@ -28,6 +28,12 @@ Vitest.describe("Vitest basics", fun () ->
         Vitest.expect(result).toBe(5)
     )
 
+    Vitest.test("sum adds two numbers with custom message", fun () ->
+        let result = Examples.sum 2 3
+        // To test this API, you need to make the test fail and check the message in the output
+        Vitest.expect(result, "custom message, value should be 5").toBe(5)
+    )
+
     Vitest.test("TestOptions timeout", TestOptions(timeout = 1000), fun () ->
         let result = Examples.sum 2 3
         Vitest.expect(result).toBe(5)
@@ -198,6 +204,12 @@ Vitest.describe("TextContext", fun () ->
         ctx.expect(result).toBe(5)
     )
 
+    Vitest.test("sum adds two numbers with context and custom message", fun (ctx: TestContext) -> 
+        let result = Examples.sum 2 3
+        // To test this API, you need to make the test fail and check the message in the output
+        ctx.expect(result, "custom message, value should be 5").toBe(5)
+    )
+
     Vitest.test("sum adds two numbers with context", fun (ctx: TestContext) -> 
         ctx.skip()
         failwith "This test should be skipped"