Schema: add missing description annotation to BooleanFromString (#4426)

Author: gcanti

.changeset/nice-spies-lick.md

@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+Schema: add missing `description` annotation to `BooleanFromString`.

packages/effect/src/Schema.ts

@@ -9771,7 +9771,7 @@ export class BooleanFromUnknown extends transform(
  * @since 3.11.0
  */
 export class BooleanFromString extends transform(
-  Literal("true", "false"),
+  Literal("true", "false").annotations({ description: "a string to be decoded into a boolean" }),
   Boolean$,
   { strict: true, decode: (value) => value === "true", encode: (value) => value ? "true" : "false" }
 ).annotations({ identifier: "BooleanFromString" }) {}

packages/effect/test/Schema/Schema/Boolean/BooleanFromString.test.ts

@@ -12,7 +12,7 @@ describe("BooleanFromString", () => {
       "a",
       `BooleanFromString
 └─ Encoded side transformation failure
-   └─ "true" | "false"
+   └─ a string to be decoded into a boolean
       ├─ Expected "true", actual "a"
       └─ Expected "false", actual "a"`
     )

packages/effect/test/Schema/Schema/Either/EitherFromSelf.test.ts

@@ -43,7 +43,7 @@ describe("EitherFromSelf", () => {
       `Either<BooleanFromString, NumberFromString>
 └─ BooleanFromString
    └─ Encoded side transformation failure
-      └─ "true" | "false"
+      └─ a string to be decoded into a boolean
          ├─ Expected "true", actual ""
          └─ Expected "false", actual ""`
     )

packages/effect/test/Schema/Schema/Exit/ExitFromSelf.test.ts

@@ -26,7 +26,7 @@ describe("ExitFromSelf", () => {
       `Exit<BooleanFromString, NumberFromString>
 └─ BooleanFromString
    └─ Encoded side transformation failure
-      └─ "true" | "false"
+      └─ a string to be decoded into a boolean
          ├─ Expected "true", actual ""
          └─ Expected "false", actual ""`
     )