effect 4.0.0-beta.31 → 4.0.0-beta.32

package/src/unstable/cli/HelpDoc.ts

@@ -3,6 +3,7 @@
  */
 
 import type { NonEmptyReadonlyArray } from "../../Array.ts"
+import type * as Option from "../../Option.ts"
 import type * as ServiceMap from "../../ServiceMap.ts"
 
 /**
@@ -12,7 +13,7 @@ import type * as ServiceMap from "../../ServiceMap.ts"
  *
  * @example
  * ```ts
- * import { ServiceMap } from "effect"
+ * import { Option as O, ServiceMap } from "effect"
  * import type * as HelpDoc from "effect/unstable/cli/HelpDoc"
  *
  * const deployCommandHelp: HelpDoc.HelpDoc = {
@@ -24,14 +25,14 @@ import type * as ServiceMap from "../../ServiceMap.ts"
  *       name: "verbose",
  *       aliases: ["-v"],
  *       type: "boolean",
- *       description: "Enable verbose logging",
+ *       description: O.some("Enable verbose logging"),
  *       required: false
  *     },
  *     {
  *       name: "env",
  *       aliases: ["-e"],
  *       type: "string",
- *       description: "Target environment",
+ *       description: O.some("Target environment"),
  *       required: true
  *     }
  *   ],
@@ -39,7 +40,7 @@ import type * as ServiceMap from "../../ServiceMap.ts"
  *     {
  *       name: "target",
  *       type: "string",
- *       description: "Deployment target (e.g., 'production', 'staging')",
+ *       description: O.some("Deployment target (e.g., 'production', 'staging')"),
  *       required: true,
  *       variadic: false
  *     }
@@ -116,13 +117,14 @@ export interface ExampleDoc {
  *
  * @example
  * ```ts
+ * import { Option as O } from "effect"
  * import type { HelpDoc } from "effect/unstable/cli"
  *
  * const verboseFlag: HelpDoc.FlagDoc = {
  *   name: "verbose",
  *   aliases: ["-v", "--verbose"],
  *   type: "boolean",
- *   description: "Enable verbose output",
+ *   description: O.some("Enable verbose output"),
  *   required: false
  * }
  *
@@ -130,7 +132,7 @@ export interface ExampleDoc {
  *   name: "port",
  *   aliases: ["-p"],
  *   type: "integer",
- *   description: "Port number to use",
+ *   description: O.some("Port number to use"),
  *   required: true
  * }
  * ```
@@ -157,7 +159,7 @@ export interface FlagDoc {
   /**
    * Description of what the flag does
    */
-  readonly description: string | undefined
+  readonly description: Option.Option<string>
 
   /**
    * Whether this flag is required
@@ -170,7 +172,7 @@ export interface FlagDoc {
  *
  * @example
  * ```ts
- * import { ServiceMap } from "effect"
+ * import { Option as O, ServiceMap } from "effect"
  * import type { HelpDoc } from "effect/unstable/cli"
  *
  * const deploySubcommand: HelpDoc.SubcommandDoc = {
@@ -249,13 +251,13 @@ export interface SubcommandGroupDoc {
  *
  * @example
  * ```ts
- * import { ServiceMap } from "effect"
+ * import { Option as O, ServiceMap } from "effect"
  * import type { HelpDoc } from "effect/unstable/cli"
  *
  * const sourceArg: HelpDoc.ArgDoc = {
  *   name: "source",
  *   type: "file",
- *   description: "Source file to process",
+ *   description: O.some("Source file to process"),
  *   required: true,
  *   variadic: false
  * }
@@ -263,7 +265,7 @@ export interface SubcommandGroupDoc {
  * const filesArg: HelpDoc.ArgDoc = {
  *   name: "files",
  *   type: "file",
- *   description: "Files to process (can specify multiple)",
+ *   description: O.some("Files to process (can specify multiple)"),
  *   required: false,
  *   variadic: true
  * }
@@ -295,7 +297,7 @@ export interface ArgDoc {
   /**
    * Description of what the argument is for
    */
-  readonly description: string | undefined
+  readonly description: Option.Option<string>
 
   /**
    * Whether this argument is required or optional

package/src/unstable/cli/Param.ts

@@ -147,7 +147,7 @@ export interface Single<Kind extends ParamKind, out A> extends Param<Kind, A> {
   readonly _tag: "Single"
   readonly kind: Kind
   readonly name: string
-  readonly description: string | undefined
+  readonly description: Option.Option<string>
   readonly aliases: ReadonlyArray<string>
   readonly primitiveType: Primitive.Primitive<A>
   readonly typeName?: string | undefined
@@ -193,8 +193,8 @@ export interface Variadic<Kind extends ParamKind, A> extends Param<Kind, Readonl
   readonly _tag: "Variadic"
   readonly kind: Kind
   readonly param: Param<Kind, A>
-  readonly min: number | undefined
-  readonly max: number | undefined
+  readonly min: Option.Option<number>
+  readonly max: Option.Option<number>
 }
 
 const Proto = {
@@ -268,7 +268,7 @@ export const makeSingle = <const Kind extends ParamKind, A>(params: {
   readonly name: string
   readonly primitiveType: Primitive.Primitive<A>
   readonly typeName?: string | undefined
-  readonly description?: string | undefined
+  readonly description?: Option.Option<string> | undefined
   readonly aliases?: ReadonlyArray<string> | undefined
 }): Single<Kind, A> => {
   const parse: Parse<A> = (args) =>
@@ -278,7 +278,7 @@ export const makeSingle = <const Kind extends ParamKind, A>(params: {
   return Object.assign(Object.create(Proto), {
     _tag: "Single",
     ...params,
-    description: params.description,
+    description: params.description ?? Option.none(),
     aliases: params.aliases ?? [],
     parse
   })
@@ -734,7 +734,7 @@ export const fileParse = <Kind extends ParamKind>(
  * const configSchema = Schema.Struct({
  *   port: Schema.Number,
  *   host: Schema.String
- * }).pipe(Schema.fromJsonString)
+ * })
  *
  * const config = Param.fileSchema(Param.flagKind, "config", configSchema, {
  *   format: "json"
@@ -754,7 +754,7 @@ export const fileParse = <Kind extends ParamKind>(
 export const fileSchema = <Kind extends ParamKind, A>(
   kind: Kind,
   name: string,
-  schema: Schema.Codec<A, string>,
+  schema: Schema.Decoder<A>,
   options?: Primitive.FileSchemaOptions | undefined
 ): Param<Kind, A> =>
   makeSingle({
@@ -1005,7 +1005,7 @@ export const withDescription: {
   return transformSingle(self, <X>(single: Single<Kind, X>) =>
     makeSingle({
       ...single,
-      description
+      description: Option.some(description)
     }))
 })
 
@@ -1603,8 +1603,8 @@ export const variadic = <Kind extends ParamKind, A>(
     _tag: "Variadic",
     kind: self.kind,
     param: self,
-    min: options?.min,
-    max: options?.max,
+    min: Option.fromUndefinedOr(options?.min),
+    max: Option.fromUndefinedOr(options?.max),
     parse
   })
 }
@@ -2587,7 +2587,11 @@ const transformSingle = <Kind extends ParamKind, A>(
     Map: (mapped) => map(transformSingle(mapped.param, f), mapped.f),
     Transform: (mapped) => transform(transformSingle(mapped.param, f), mapped.f),
     Optional: (p) => optional(transformSingle(p.param, f)) as Param<Kind, A>,
-    Variadic: (p) => variadic(transformSingle(p.param, f), { min: p.min, max: p.max }) as Param<Kind, A>
+    Variadic: (p) =>
+      variadic(transformSingle(p.param, f), {
+        min: Option.getOrUndefined(p.min),
+        max: Option.getOrUndefined(p.max)
+      }) as Param<Kind, A>
   })
 }
 

package/src/unstable/cli/Primitive.ts

@@ -575,7 +575,7 @@ export type FileSchemaOptions = Struct.Simplify<
  * @category constructors
  */
 export const fileSchema = <A>(
-  schema: Schema.Codec<A, string>,
+  schema: Schema.Decoder<A>,
   options?: FileSchemaOptions | undefined
 ): Primitive<A> => {
   const decode = Schema.decodeUnknownEffect(schema)