add Transform issue and add Format module

.changeset/gentle-readers-call.md

@@ -4,9 +4,10 @@
 
 Refactor `ParseResult` module:
 
-- replace `UnionMember` with `Union`
+- add `Union` issue, and replace `UnionMember` with `Union`
+- add `Tuple` issue, and replace `Index` with `Tuple`
+- add `TypeLiteral` issue
+- add `Transform` issue
+- add `ast` field to `Member`
 - rename `UnionMember` to `Member`
-- ast `ast` field to `Member`
-- replace `Index` with `Tuple`
 - `Unexpected`: rename `ast` to `expected` and make the field required
-- add `TypeLiteral`

.changeset/rotten-flowers-jam.md

@@ -0,0 +1,5 @@
+---
+"@effect/schema": patch
+---
+
+add Format module

docs/modules/Format.ts.md

@@ -0,0 +1,52 @@
+---
+title: Format.ts
+nav_order: 5
+parent: Modules
+---
+
+## Format overview
+
+Added in v1.0.0
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [formatting](#formatting)
+  - [format](#format)
+  - [formatAST](#formatast)
+  - [formatSchema](#formatschema)
+
+---
+
+# formatting
+
+## format
+
+**Signature**
+
+```ts
+export declare const format: (u: unknown) => string
+```
+
+Added in v1.0.0
+
+## formatAST
+
+**Signature**
+
+```ts
+export declare const formatAST: (ast: AST.AST) => string
+```
+
+Added in v1.0.0
+
+## formatSchema
+
+**Signature**
+
+```ts
+export declare const formatSchema: <I, A>(schema: Schema.Schema<I, A>) => string
+```
+
+Added in v1.0.0

docs/modules/JSONSchema.ts.md

@@ -1,6 +1,6 @@
 ---
 title: JSONSchema.ts
-nav_order: 6
+nav_order: 7
 parent: Modules
 ---
 

docs/modules/ParseResult.ts.md

@@ -1,6 +1,6 @@
 ---
 title: ParseResult.ts
-nav_order: 8
+nav_order: 9
 parent: Modules
 ---
 
@@ -20,6 +20,7 @@ Added in v1.0.0
   - [member](#member)
   - [missing](#missing)
   - [succeed](#succeed)
+  - [transform](#transform)
   - [try](#try)
   - [tuple](#tuple)
   - [type](#type)
@@ -33,6 +34,7 @@ Added in v1.0.0
   - [Member (interface)](#member-interface)
   - [Missing (interface)](#missing-interface)
   - [ParseIssue (type alias)](#parseissue-type-alias)
+  - [Transform (interface)](#transform-interface)
   - [Tuple (interface)](#tuple-interface)
   - [Type (interface)](#type-interface)
   - [TypeLiteral (interface)](#typeliteral-interface)
@@ -126,6 +128,21 @@ export declare const succeed: <A>(a: A) => ParseResult<A>
 
 Added in v1.0.0
 
+## transform
+
+**Signature**
+
+```ts
+export declare const transform: (
+  ast: AST.Transform,
+  actual: unknown,
+  kind: "From" | "Transformation" | "To",
+  errors: readonly [ParseIssue, ...ParseIssue[]]
+) => Transform
+```
+
+Added in v1.0.0
+
 ## try
 
 **Signature**
@@ -141,7 +158,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const tuple: (ast: AST.Tuple, errors: readonly [Index, ...Index[]]) => Tuple
+export declare const tuple: (ast: AST.Tuple, actual: unknown, errors: readonly [Index, ...Index[]]) => Tuple
 ```
 
 Added in v1.0.0
@@ -161,7 +178,11 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const typeLiteral: (ast: AST.TypeLiteral, errors: readonly [Key, ...Key[]]) => TypeLiteral
+export declare const typeLiteral: (
+  ast: AST.TypeLiteral,
+  actual: unknown,
+  errors: readonly [Key, ...Key[]]
+) => TypeLiteral
 ```
 
 Added in v1.0.0
@@ -183,6 +204,7 @@ Added in v1.0.0
 ```ts
 export declare const union: (
   ast: AST.Union,
+  actual: unknown,
   errors: readonly [Key | Type | Member, ...(Key | Type | Member)[]]
 ) => Union
 ```
@@ -284,9 +306,10 @@ Added in v1.0.0
 export type ParseIssue =
   // context
   | Tuple
-  | Key
   | TypeLiteral
   | Union
+  | Key
+  | Transform
   // primitives
   | Type
   | Missing
@@ -296,6 +319,24 @@ export type ParseIssue =
 
 Added in v1.0.0
 
+## Transform (interface)
+
+Error that occurs when a transformation has an error.
+
+**Signature**
+
+```ts
+export interface Transform {
+  readonly _tag: "Transform"
+  readonly ast: AST.Transform
+  readonly actual: unknown
+  readonly kind: "From" | "Transformation" | "To"
+  readonly errors: ReadonlyArray.NonEmptyReadonlyArray<ParseIssue>
+}
+```
+
+Added in v1.0.0
+
 ## Tuple (interface)
 
 **Signature**
@@ -304,6 +345,7 @@ Added in v1.0.0
 export interface Tuple {
   readonly _tag: "Tuple"
   readonly ast: AST.Tuple
+  readonly actual: unknown
   readonly errors: ReadonlyArray.NonEmptyReadonlyArray<Index>
 }
 ```
@@ -339,6 +381,7 @@ Added in v1.0.0
 export interface TypeLiteral {
   readonly _tag: "TypeLiteral"
   readonly ast: AST.TypeLiteral
+  readonly actual: unknown
   readonly errors: ReadonlyArray.NonEmptyReadonlyArray<Key>
 }
 ```
@@ -370,6 +413,7 @@ Error that occurs when a union has an error.
 export interface Union {
   readonly _tag: "Union"
   readonly ast: AST.Union
+  readonly actual: unknown
   readonly errors: ReadonlyArray.NonEmptyReadonlyArray<Member | Key | Type>
 }
 ```

docs/modules/Parser.ts.md

@@ -1,6 +1,6 @@
 ---
 title: Parser.ts
-nav_order: 7
+nav_order: 8
 parent: Modules
 ---
 

docs/modules/Pretty.ts.md

@@ -1,6 +1,6 @@
 ---
 title: Pretty.ts
-nav_order: 9
+nav_order: 10
 parent: Modules
 ---
 

docs/modules/Schema.ts.md

@@ -1,6 +1,6 @@
 ---
 title: Schema.ts
-nav_order: 10
+nav_order: 11
 parent: Modules
 ---
 

docs/modules/Serializable.ts.md

@@ -1,6 +1,6 @@
 ---
 title: Serializable.ts
-nav_order: 11
+nav_order: 12
 parent: Modules
 ---
 

docs/modules/TreeFormatter.ts.md

@@ -1,6 +1,6 @@
 ---
 title: TreeFormatter.ts
-nav_order: 12
+nav_order: 13
 parent: Modules
 ---
 

docs/modules/index.ts.md

@@ -1,6 +1,6 @@
 ---
 title: index.ts
-nav_order: 5
+nav_order: 6
 parent: Modules
 ---
 
@@ -17,6 +17,7 @@ Added in v1.0.0
   - [From "./Arbitrary.js"](#from-arbitraryjs)
   - [From "./ArrayFormatter.js"](#from-arrayformatterjs)
   - [From "./Equivalence.js"](#from-equivalencejs)
+  - [From "./Format.js"](#from-formatjs)
   - [From "./JSONSchema.js"](#from-jsonschemajs)
   - [From "./ParseResult.js"](#from-parseresultjs)
   - [From "./Parser.js"](#from-parserjs)
@@ -77,6 +78,18 @@ export * as Equivalence from "./Equivalence.js"
 
 Added in v1.0.0
 
+## From "./Format.js"
+
+Re-exports all named exports from the "./Format.js" module as `Format`.
+
+**Signature**
+
+```ts
+export * as Format from "./Format.js"
+```
+
+Added in v1.0.0
+
 ## From "./JSONSchema.js"
 
 Re-exports all named exports from the "./JSONSchema.js" module as `JSONSchema`.

src/ArrayFormatter.ts

@@ -2,8 +2,9 @@
  * @since 1.0.0
  */
 import * as ReadonlyArray from "effect/ReadonlyArray"
+import * as Format from "./Format.js"
 import type { ParseIssue } from "./ParseResult.js"
-import { formatAST, getMessage } from "./TreeFormatter.js"
+import { formatMessage } from "./TreeFormatter.js"
 
 /**
  * @category model
@@ -19,7 +20,7 @@ const format = (self: ParseIssue, path: ReadonlyArray<PropertyKey> = []): Array<
   const _tag = self._tag
   switch (_tag) {
     case "Type":
-      return [{ _tag, path, message: getMessage(self) }]
+      return [{ _tag, path, message: formatMessage(self) }]
     case "Key":
       return ReadonlyArray.flatMap(self.errors, (e) => format(e, [...path, self.key]))
     case "Missing":
@@ -30,7 +31,7 @@ const format = (self: ParseIssue, path: ReadonlyArray<PropertyKey> = []): Array<
       return [{
         _tag,
         path,
-        message: `Unexpected, expected ${formatAST(self.expected)}`
+        message: `Unexpected, expected ${Format.formatAST(self.expected)}`
       }]
     case "Union":
       return ReadonlyArray.flatMap(self.errors, (e) => {
@@ -53,6 +54,7 @@ const format = (self: ParseIssue, path: ReadonlyArray<PropertyKey> = []): Array<
         (key) => ReadonlyArray.flatMap(key.errors, (e) => format(e, [...path, key.key]))
       )
   }
+  return ReadonlyArray.flatMap(self.errors, (e) => format(e, path))
 }
 
 /**