effect 4.0.0-rc.112 → 4.0.0-rc.113

package/src/unstable/cli/CliError.ts

@@ -478,6 +478,8 @@ export class UnknownSubcommand extends Schema.TaggedError<UnknownSubcommand>(
 /**
  * Error wrapper for user handler failures in the CLI error channel.
  *
+ * **Details**
+ *
  * `userMessage` can provide safe, user-facing text independently of the
  * underlying cause. When omitted or empty, `message` uses a non-empty string
  * cause or `Error.message`, then falls back to `"An error occurred"`.

package/src/unstable/cli/CliOutput.ts

@@ -306,7 +306,7 @@ export const defaultFormatter = (options?: { colors?: boolean }): Formatter => {
       typeof globalProcess.stdout === "object" &&
       globalProcess.stdout !== null &&
       globalProcess.stdout.isTTY === true &&
-      globalProcess.env?.NO_COLOR !== "1")
+      !globalProcess.env?.NO_COLOR)
 
   // Color palette using ANSI escape codes
   const colors = useColor
@@ -380,10 +380,47 @@ const stripAnsi = (text: string): string => {
 }
 
 /**
- * Gets the visual length of a string (excluding ANSI codes).
+ * Gets the terminal display width of a string (excluding ANSI codes).
  * @internal
  */
-const visualLength = (text: string): number => stripAnsi(text).length
+const graphemeSegmenter = new Intl.Segmenter(undefined, { granularity: "grapheme" })
+
+const zeroWidthCodePoints = /[\p{Mark}\p{Control}\p{Default_Ignorable_Code_Point}]/gu
+const emojiPresentation = /\p{Emoji_Presentation}/u
+
+const isFullWidthCodePoint = (codePoint: number): boolean => {
+  if (codePoint < 0x1100) return false
+
+  return codePoint <= 0x115f ||
+    codePoint === 0x2329 ||
+    codePoint === 0x232a ||
+    (codePoint >= 0x2e80 && codePoint <= 0x303e) ||
+    (codePoint >= 0x3040 && codePoint <= 0xa4cf) ||
+    (codePoint >= 0xac00 && codePoint <= 0xd7a3) ||
+    (codePoint >= 0xf900 && codePoint <= 0xfaff) ||
+    (codePoint >= 0xfe10 && codePoint <= 0xfe19) ||
+    (codePoint >= 0xfe30 && codePoint <= 0xfe6f) ||
+    (codePoint >= 0xff00 && codePoint <= 0xff60) ||
+    (codePoint >= 0xffe0 && codePoint <= 0xffe6) ||
+    (codePoint >= 0x1b000 && codePoint <= 0x1b2ff) ||
+    (codePoint >= 0x1f200 && codePoint <= 0x1f251) ||
+    (codePoint >= 0x20000 && codePoint <= 0x3fffd)
+}
+
+const graphemeWidth = (grapheme: string): number => {
+  const visible = grapheme.replace(zeroWidthCodePoints, "")
+  if (visible.length === 0) return 0
+  if (emojiPresentation.test(grapheme) || grapheme.includes("\uFE0F")) return 2
+  return isFullWidthCodePoint(visible.codePointAt(0)!) ? 2 : 1
+}
+
+const visualLength = (text: string): number => {
+  let length = 0
+  for (const { segment } of graphemeSegmenter.segment(stripAnsi(text))) {
+    length += graphemeWidth(segment)
+  }
+  return length
+}
 
 /**
  * Helper function to pad strings to a specified width.

package/src/unstable/cli/Command.ts

@@ -97,15 +97,15 @@ import * as Prompt from "./Prompt.ts"
  *   never,
  *   never
  * > = Command.make("deploy", {
- *   env: Flag.string("env"),
- *   force: Flag.boolean("force").pipe(Flag.withDefault(false)),
- *   files: Argument.string("files").pipe(Argument.variadic())
+ *   env: Flag.String("env"),
+ *   force: Flag.Boolean("force").pipe(Flag.withDefault(false)),
+ *   files: Argument.String("files").pipe(Argument.variadic())
  * })
  *
  * // Command with handler
  * const output: Array<string> = []
  * const greet = Command.make("greet", {
- *   name: Flag.string("name")
+ *   name: Flag.String("name")
  * }, (config) => Effect.sync(() => output.push(`Hello, ${config.name}!`)).pipe(Effect.asVoid))
  *
  * await Effect.runPromise(
@@ -225,20 +225,20 @@ export declare namespace Command {
    *
    * // Simple flat configuration
    * const simpleConfig = {
-   *   name: Flag.string("name"),
-   *   age: Flag.integer("age"),
-   *   file: Argument.string("file")
+   *   name: Flag.String("name"),
+   *   age: Flag.Int("age"),
+   *   file: Argument.String("file")
    * } satisfies CliCommand.Command.Config
    *
    * // Nested configuration for organization
    * const nestedConfig = {
    *   user: {
-   *     name: Flag.string("name"),
-   *     email: Flag.string("email")
+   *     name: Flag.String("name"),
+   *     email: Flag.String("email")
    *   },
    *   server: {
-   *     host: Flag.string("host"),
-   *     port: Flag.integer("port")
+   *     host: Flag.String("host"),
+   *     port: Flag.Int("port")
    *   }
    * } satisfies CliCommand.Command.Config
    *
@@ -293,10 +293,10 @@ export declare namespace Command {
      * import type { Command as CliCommand } from "effect/unstable/cli"
      *
      * const config = {
-     *   name: Flag.string("name"),
+     *   name: Flag.String("name"),
      *   server: {
-     *     host: Flag.string("host"),
-     *     port: Flag.integer("port")
+     *     host: Flag.String("host"),
+     *     port: Flag.Int("port")
      *   }
      * } as const
      *
@@ -456,14 +456,14 @@ export type Services<C> = C extends Command<
  *
  * const parent = Command.make("app").pipe(
  *   Command.withSharedFlags({
- *     verbose: Flag.boolean("verbose").pipe(Flag.withDefault(false)),
- *     config: Flag.string("config")
+ *     verbose: Flag.Boolean("verbose").pipe(Flag.withDefault(false)),
+ *     config: Flag.String("config")
  *   })
  * )
  *
  * const output: Array<string> = []
  * const child = Command.make("deploy", {
- *   target: Flag.string("target")
+ *   target: Flag.String("target")
  * }, (config) =>
  *   Effect.gen(function*() {
  *     // Access parent's config by yielding the parent command
@@ -568,21 +568,21 @@ export const isCommand = (u: unknown): u is Command.Any => Predicate.hasProperty
  *
  * // Command with simple flags
  * const greet = Command.make("greet", {
- *   name: Flag.string("name"),
- *   count: Flag.integer("count").pipe(Flag.withDefault(1))
+ *   name: Flag.String("name"),
+ *   count: Flag.Int("count").pipe(Flag.withDefault(1))
  * })
  *
  * // Command with nested configuration
  * const deploy = Command.make("deploy", {
- *   environment: Flag.string("env").pipe(
+ *   environment: Flag.String("env").pipe(
  *     Flag.withDescription("Target environment")
  *   ),
  *   server: {
- *     host: Flag.string("host").pipe(Flag.withDefault("localhost")),
- *     port: Flag.integer("port").pipe(Flag.withDefault(3000))
+ *     host: Flag.String("host").pipe(Flag.withDefault("localhost")),
+ *     port: Flag.Int("port").pipe(Flag.withDefault(3000))
  *   },
- *   files: Argument.string("files").pipe(Argument.variadic),
- *   force: Flag.boolean("force").pipe(
+ *   files: Argument.String("files").pipe(Argument.variadic),
+ *   force: Flag.Boolean("force").pipe(
  *     Flag.withDescription("Force deployment"),
  *     Flag.withDefault(false)
  *   )
@@ -591,8 +591,8 @@ export const isCommand = (u: unknown): u is Command.Any => Predicate.hasProperty
  * // Command with handler
  * const output: Array<string> = []
  * const deployWithHandler = Command.make("deploy", {
- *   environment: Flag.string("env"),
- *   force: Flag.boolean("force").pipe(Flag.withDefault(false))
+ *   environment: Flag.String("env"),
+ *   force: Flag.Boolean("force").pipe(Flag.withDefault(false))
  * }, (config) =>
  *   Effect.gen(function*() {
  *     yield* Effect.sync(() => output.push(`Starting deployment to ${config.environment}`))
@@ -661,21 +661,21 @@ export const make: {
    *
    * // Command with simple flags
    * const greet = Command.make("greet", {
-   *   name: Flag.string("name"),
-   *   count: Flag.integer("count").pipe(Flag.withDefault(1))
+   *   name: Flag.String("name"),
+   *   count: Flag.Int("count").pipe(Flag.withDefault(1))
    * })
    *
    * // Command with nested configuration
    * const deploy = Command.make("deploy", {
-   *   environment: Flag.string("env").pipe(
+   *   environment: Flag.String("env").pipe(
    *     Flag.withDescription("Target environment")
    *   ),
    *   server: {
-   *     host: Flag.string("host").pipe(Flag.withDefault("localhost")),
-   *     port: Flag.integer("port").pipe(Flag.withDefault(3000))
+   *     host: Flag.String("host").pipe(Flag.withDefault("localhost")),
+   *     port: Flag.Int("port").pipe(Flag.withDefault(3000))
    *   },
-   *   files: Argument.string("files").pipe(Argument.variadic),
-   *   force: Flag.boolean("force").pipe(
+   *   files: Argument.String("files").pipe(Argument.variadic),
+   *   force: Flag.Boolean("force").pipe(
    *     Flag.withDescription("Force deployment"),
    *     Flag.withDefault(false)
    *   )
@@ -684,8 +684,8 @@ export const make: {
    * // Command with handler
    * const output: Array<string> = []
    * const deployWithHandler = Command.make("deploy", {
-   *   environment: Flag.string("env"),
-   *   force: Flag.boolean("force").pipe(Flag.withDefault(false))
+   *   environment: Flag.String("env"),
+   *   force: Flag.Boolean("force").pipe(Flag.withDefault(false))
    * }, (config) =>
    *   Effect.gen(function*() {
    *     yield* Effect.sync(() => output.push(`Starting deployment to ${config.environment}`))
@@ -755,21 +755,21 @@ export const make: {
    *
    * // Command with simple flags
    * const greet = Command.make("greet", {
-   *   name: Flag.string("name"),
-   *   count: Flag.integer("count").pipe(Flag.withDefault(1))
+   *   name: Flag.String("name"),
+   *   count: Flag.Int("count").pipe(Flag.withDefault(1))
    * })
    *
    * // Command with nested configuration
    * const deploy = Command.make("deploy", {
-   *   environment: Flag.string("env").pipe(
+   *   environment: Flag.String("env").pipe(
    *     Flag.withDescription("Target environment")
    *   ),
    *   server: {
-   *     host: Flag.string("host").pipe(Flag.withDefault("localhost")),
-   *     port: Flag.integer("port").pipe(Flag.withDefault(3000))
+   *     host: Flag.String("host").pipe(Flag.withDefault("localhost")),
+   *     port: Flag.Int("port").pipe(Flag.withDefault(3000))
    *   },
-   *   files: Argument.string("files").pipe(Argument.variadic),
-   *   force: Flag.boolean("force").pipe(
+   *   files: Argument.String("files").pipe(Argument.variadic),
+   *   force: Flag.Boolean("force").pipe(
    *     Flag.withDescription("Force deployment"),
    *     Flag.withDefault(false)
    *   )
@@ -778,8 +778,8 @@ export const make: {
    * // Command with handler
    * const output: Array<string> = []
    * const deployWithHandler = Command.make("deploy", {
-   *   environment: Flag.string("env"),
-   *   force: Flag.boolean("force").pipe(Flag.withDefault(false))
+   *   environment: Flag.String("env"),
+   *   force: Flag.Boolean("force").pipe(Flag.withDefault(false))
    * }, (config) =>
    *   Effect.gen(function*() {
    *     yield* Effect.sync(() => output.push(`Starting deployment to ${config.environment}`))
@@ -849,21 +849,21 @@ export const make: {
    *
    * // Command with simple flags
    * const greet = Command.make("greet", {
-   *   name: Flag.string("name"),
-   *   count: Flag.integer("count").pipe(Flag.withDefault(1))
+   *   name: Flag.String("name"),
+   *   count: Flag.Int("count").pipe(Flag.withDefault(1))
    * })
    *
    * // Command with nested configuration
    * const deploy = Command.make("deploy", {
-   *   environment: Flag.string("env").pipe(
+   *   environment: Flag.String("env").pipe(
    *     Flag.withDescription("Target environment")
    *   ),
    *   server: {
-   *     host: Flag.string("host").pipe(Flag.withDefault("localhost")),
-   *     port: Flag.integer("port").pipe(Flag.withDefault(3000))
+   *     host: Flag.String("host").pipe(Flag.withDefault("localhost")),
+   *     port: Flag.Int("port").pipe(Flag.withDefault(3000))
    *   },
-   *   files: Argument.string("files").pipe(Argument.variadic),
-   *   force: Flag.boolean("force").pipe(
+   *   files: Argument.String("files").pipe(Argument.variadic),
+   *   force: Flag.Boolean("force").pipe(
    *     Flag.withDescription("Force deployment"),
    *     Flag.withDefault(false)
    *   )
@@ -872,8 +872,8 @@ export const make: {
    * // Command with handler
    * const output: Array<string> = []
    * const deployWithHandler = Command.make("deploy", {
-   *   environment: Flag.string("env"),
-   *   force: Flag.boolean("force").pipe(Flag.withDefault(false))
+   *   environment: Flag.String("env"),
+   *   force: Flag.Boolean("force").pipe(Flag.withDefault(false))
    * }, (config) =>
    *   Effect.gen(function*() {
    *     yield* Effect.sync(() => output.push(`Starting deployment to ${config.environment}`))
@@ -949,7 +949,7 @@ export const make: {
  *
  * // Command without initial handler
  * const greet = Command.make("greet", {
- *   name: Flag.string("name")
+ *   name: Flag.String("name")
  * })
  *
  * // Add handler later
@@ -1005,7 +1005,7 @@ export const withHandler: {
    *
    * // Command without initial handler
    * const greet = Command.make("greet", {
-   *   name: Flag.string("name")
+   *   name: Flag.String("name")
    * })
    *
    * // Add handler later
@@ -1063,7 +1063,7 @@ export const withHandler: {
    *
    * // Command without initial handler
    * const greet = Command.make("greet", {
-   *   name: Flag.string("name")
+   *   name: Flag.String("name")
    * })
    *
    * // Add handler later
@@ -1182,14 +1182,14 @@ const normalizeSubcommandEntries = (
  * // Parent command with shared flags
  * const git = Command.make("git").pipe(
  *   Command.withSharedFlags({
- *     verbose: Flag.boolean("verbose").pipe(Flag.withDefault(false))
+ *     verbose: Flag.Boolean("verbose").pipe(Flag.withDefault(false))
  *   })
  * )
  *
  * // Subcommand that accesses parent config
  * const output: Array<string> = []
  * const clone = Command.make("clone", {
- *   repository: Flag.string("repo")
+ *   repository: Flag.String("repo")
  * }, (config) =>
  *   Effect.gen(function*() {
  *     const parent = yield* git // Access parent's parsed config
@@ -1252,14 +1252,14 @@ export const withSubcommands: {
    * // Parent command with shared flags
    * const git = Command.make("git").pipe(
    *   Command.withSharedFlags({
-   *     verbose: Flag.boolean("verbose").pipe(Flag.withDefault(false))
+   *     verbose: Flag.Boolean("verbose").pipe(Flag.withDefault(false))
    *   })
    * )
    *
    * // Subcommand that accesses parent config
    * const output: Array<string> = []
    * const clone = Command.make("clone", {
-   *   repository: Flag.string("repo")
+   *   repository: Flag.String("repo")
    * }, (config) =>
    *   Effect.gen(function*() {
    *     const parent = yield* git // Access parent's parsed config
@@ -1330,14 +1330,14 @@ export const withSubcommands: {
    * // Parent command with shared flags
    * const git = Command.make("git").pipe(
    *   Command.withSharedFlags({
-   *     verbose: Flag.boolean("verbose").pipe(Flag.withDefault(false))
+   *     verbose: Flag.Boolean("verbose").pipe(Flag.withDefault(false))
    *   })
    * )
    *
    * // Subcommand that accesses parent config
    * const output: Array<string> = []
    * const clone = Command.make("clone", {
-   *   repository: Flag.string("repo")
+   *   repository: Flag.String("repo")
    * }, (config) =>
    *   Effect.gen(function*() {
    *     const parent = yield* git // Access parent's parsed config
@@ -1682,7 +1682,7 @@ type ExtractSubcommandContext<T extends ReadonlyArray<Command.SubcommandEntry>>
  *
  * const output: Array<string> = []
  * const deploy = Command.make("deploy", {
- *   environment: Flag.string("env")
+ *   environment: Flag.String("env")
  * }, (config) =>
  *   Effect.gen(function*() {
  *     yield* Effect.sync(() => output.push(`Deploying to ${config.environment}`))
@@ -1734,7 +1734,7 @@ export const withDescription: {
    *
    * const output: Array<string> = []
    * const deploy = Command.make("deploy", {
-   *   environment: Flag.string("env")
+   *   environment: Flag.String("env")
    * }, (config) =>
    *   Effect.gen(function*() {
    *     yield* Effect.sync(() => output.push(`Deploying to ${config.environment}`))
@@ -1788,7 +1788,7 @@ export const withDescription: {
    *
    * const output: Array<string> = []
    * const deploy = Command.make("deploy", {
-   *   environment: Flag.string("env")
+   *   environment: Flag.String("env")
    * }, (config) =>
    *   Effect.gen(function*() {
    *     yield* Effect.sync(() => output.push(`Deploying to ${config.environment}`))
@@ -2238,7 +2238,7 @@ const mapHandler = <Name extends string, Input, E, R, ContextInput, E2, R2>(
  *
  * const output: Array<string> = []
  * const deploy = Command.make("deploy", {
- *   env: Flag.string("env")
+ *   env: Flag.String("env")
  * }, (config) =>
  *   Effect.gen(function*() {
  *     const fs = yield* FileSystem.FileSystem
@@ -2300,7 +2300,7 @@ export const provide: {
    *
    * const output: Array<string> = []
    * const deploy = Command.make("deploy", {
-   *   env: Flag.string("env")
+   *   env: Flag.String("env")
    * }, (config) =>
    *   Effect.gen(function*() {
    *     const fs = yield* FileSystem.FileSystem
@@ -2369,7 +2369,7 @@ export const provide: {
    *
    * const output: Array<string> = []
    * const deploy = Command.make("deploy", {
-   *   env: Flag.string("env")
+   *   env: Flag.String("env")
    * }, (config) =>
    *   Effect.gen(function*() {
    *     const fs = yield* FileSystem.FileSystem
@@ -2744,7 +2744,7 @@ const showUserError = (error: CliError.UserError): Effect.Effect<void> =>
  *
  * const output: Array<string> = []
  * const greetCommand = Command.make("greet", {
- *   name: Flag.string("name")
+ *   name: Flag.String("name")
  * }, (config) =>
  *   Effect.gen(function*() {
  *     yield* Effect.sync(() => output.push(`Hello, ${config.name}!`))
@@ -2806,7 +2806,7 @@ export const run: {
    *
    * const output: Array<string> = []
    * const greetCommand = Command.make("greet", {
-   *   name: Flag.string("name")
+   *   name: Flag.String("name")
    * }, (config) =>
    *   Effect.gen(function*() {
    *     yield* Effect.sync(() => output.push(`Hello, ${config.name}!`))
@@ -2875,7 +2875,7 @@ export const run: {
    *
    * const output: Array<string> = []
    * const greetCommand = Command.make("greet", {
-   *   name: Flag.string("name")
+   *   name: Flag.String("name")
    * }, (config) =>
    *   Effect.gen(function*() {
    *     yield* Effect.sync(() => output.push(`Hello, ${config.name}!`))
@@ -2955,8 +2955,8 @@ export const run: {
  *
  * const output: Array<string> = []
  * const greet = Command.make("greet", {
- *   name: Flag.string("name"),
- *   count: Flag.integer("count").pipe(Flag.withDefault(1))
+ *   name: Flag.String("name"),
+ *   count: Flag.Int("count").pipe(Flag.withDefault(1))
  * }, (config) =>
  *   Effect.gen(function*() {
  *     for (let i = 0; i < config.count; i++) {
@@ -3041,7 +3041,7 @@ export const runWith = <const Name extends string, Input, E, R, ContextInput>(
             ]
             const wizardResult = yield* Wizard.run(command, { commandPath, prefix })
             yield* Console.log(Wizard.renderCompletion(wizardResult.displayArgs))
-            const shouldRun = yield* Prompt.run(Prompt.toggle({
+            const shouldRun = yield* Prompt.run(Prompt.Toggle({
               message: "Run this command?",
               initial: true,
               active: "yes",

package/src/unstable/cli/Completions.ts

@@ -54,8 +54,8 @@ export interface FlagDescriptor {
 export type FlagType =
   | { readonly _tag: "Boolean" }
   | { readonly _tag: "String" }
-  | { readonly _tag: "Integer" }
-  | { readonly _tag: "Float" }
+  | { readonly _tag: "Int" }
+  | { readonly _tag: "Finite" }
   | { readonly _tag: "Date" }
   | { readonly _tag: "Choice"; readonly values: ReadonlyArray<string> }
   | { readonly _tag: "Path"; readonly pathType: "file" | "directory" | "either" }
@@ -82,8 +82,8 @@ export interface ArgumentDescriptor {
  */
 export type ArgumentType =
   | { readonly _tag: "String" }
-  | { readonly _tag: "Integer" }
-  | { readonly _tag: "Float" }
+  | { readonly _tag: "Int" }
+  | { readonly _tag: "Finite" }
   | { readonly _tag: "Date" }
   | { readonly _tag: "Choice"; readonly values: ReadonlyArray<string> }
   | { readonly _tag: "Path"; readonly pathType: "file" | "directory" | "either" }