Avoid setting a title annotation when applying branding

Effect-TS · Dec 20, 2024 · fdfe472 · fdfe472
1 parent db94bca
commit fdfe472
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 20 deletions.
diff --git a/packages/effect/src/Schema.ts b/packages/effect/src/Schema.ts
@@ -2993,8 +2993,6 @@ export const brand = <S extends Schema.AnyNoContext, B extends string | symbol>(
   const ast = AST.annotations(
     self.ast,
     toASTAnnotations({
-      title: `${String(self.ast)} & Brand<${util_.formatUnknown(brand)}>`,
-      description: `${String(self.ast)} & Brand<${util_.formatUnknown(brand)}>`,
       [AST.BrandAnnotationId]: annotation,
       ...annotations
     })

diff --git a/packages/effect/src/SchemaAST.ts b/packages/effect/src/SchemaAST.ts
@@ -2925,10 +2925,21 @@ export const rename = (ast: AST, mapping: { readonly [K in PropertyKey]?: Proper
 
 const formatKeyword = (ast: AST): string => Option.getOrElse(getExpected(ast), () => ast._tag)
 
+function getBrands(ast: Annotated): string {
+  return Option.match(getBrandAnnotation(ast), {
+    onNone: () => "",
+    onSome: (brands) => brands.map((brand) => ` & Brand<${util_.formatUnknown(brand)}>`).join("")
+  })
+}
+
 const getExpected = (ast: Annotated): Option.Option<string> => {
   return getIdentifierAnnotation(ast).pipe(
-    Option.orElse(() => getTitleAnnotation(ast)),
-    Option.orElse(() => getDescriptionAnnotation(ast)),
-    Option.orElse(() => getAutoTitleAnnotation(ast))
+    Option.orElse(() =>
+      getTitleAnnotation(ast).pipe(
+        Option.orElse(() => getDescriptionAnnotation(ast)),
+        Option.orElse(() => getAutoTitleAnnotation(ast)),
+        Option.map((s) => s + getBrands(ast))
+      )
+    )
   )
 }
diff --git a/packages/effect/test/Schema/Schema/brand.test.ts b/packages/effect/test/Schema/Schema/brand.test.ts
@@ -23,12 +23,6 @@ describe("brand", () => {
   })
 
   describe("annotations", () => {
-    it("toString / format", () => {
-      const schema = S.Number.pipe(S.brand("A"))
-      expect(String(schema)).toBe(`number & Brand<"A">`)
-      expect(S.format(schema)).toBe(`number & Brand<"A">`)
-    })
-
     it("using .annotations() twice", () => {
       const schema = S.Number.pipe(S.brand("A"))
       const annotatedSchema = schema.annotations({
@@ -56,15 +50,15 @@ describe("brand", () => {
       const schema = S.Number.pipe(
         S.int(),
         S.brand("A", {
-          description: "an A brand"
+          description: "description"
         })
       )
+      expect(String(schema)).toBe(`description & Brand<"A">`)
 
       expect(schema.ast.annotations).toEqual({
         [AST.SchemaIdAnnotationId]: S.IntSchemaId,
         [AST.BrandAnnotationId]: ["A"],
-        [AST.TitleAnnotationId]: `an integer & Brand<"A">`,
-        [AST.DescriptionAnnotationId]: "an A brand",
+        [AST.DescriptionAnnotationId]: "description",
         [AST.JSONSchemaAnnotationId]: { type: "integer" }
       })
     })
@@ -74,15 +68,16 @@ describe("brand", () => {
         S.int(),
         S.brand("A"),
         S.brand("B", {
-          description: "a B brand"
+          description: "description"
         })
       )
 
+      expect(String(schema)).toBe(`description & Brand<"A"> & Brand<"B">`)
+
       expect(schema.ast.annotations).toEqual({
         [AST.SchemaIdAnnotationId]: S.IntSchemaId,
         [AST.BrandAnnotationId]: ["A", "B"],
-        [AST.TitleAnnotationId]: `an integer & Brand<"A"> & Brand<"B">`,
-        [AST.DescriptionAnnotationId]: "a B brand",
+        [AST.DescriptionAnnotationId]: "description",
         [AST.JSONSchemaAnnotationId]: { type: "integer" }
       })
     })
@@ -94,14 +89,16 @@ describe("brand", () => {
         S.int(),
         S.brand(A),
         S.brand(B, {
-          description: "a B brand"
+          description: "description"
         })
       )
+
+      expect(String(schema)).toBe("description & Brand<Symbol(A)> & Brand<Symbol(B)>")
+
       expect(schema.ast.annotations).toEqual({
         [AST.SchemaIdAnnotationId]: S.IntSchemaId,
         [AST.BrandAnnotationId]: [A, B],
-        [AST.TitleAnnotationId]: "an integer & Brand<Symbol(A)> & Brand<Symbol(B)>",
-        [AST.DescriptionAnnotationId]: "a B brand",
+        [AST.DescriptionAnnotationId]: "description",
         [AST.JSONSchemaAnnotationId]: { type: "integer" }
       })
     })