effect 4.0.0-beta.4 → 4.0.0-beta.41

package/src/unstable/cli/index.ts

@@ -24,11 +24,21 @@ export * as CliOutput from "./CliOutput.ts"
  */
 export * as Command from "./Command.ts"
 
+/**
+ * @since 4.0.0
+ */
+export * as Completions from "./Completions.ts"
+
 /**
  * @since 4.0.0
  */
 export * as Flag from "./Flag.ts"
 
+/**
+ * @since 4.0.0
+ */
+export * as GlobalFlag from "./GlobalFlag.ts"
+
 /**
  * @since 4.0.0
  */

package/src/unstable/cli/internal/command.ts

@@ -5,16 +5,18 @@
  * Internal implementation details for CLI commands.
  * Public API is in ../Command.ts
  */
+import * as Arr from "../../../Array.ts"
 import * as Effect from "../../../Effect.ts"
 import { YieldableProto } from "../../../internal/core.ts"
 import { pipeArguments } from "../../../Pipeable.ts"
 import * as Predicate from "../../../Predicate.ts"
 import * as ServiceMap from "../../../ServiceMap.ts"
 import * as CliError from "../CliError.ts"
-import type { ArgDoc, FlagDoc, HelpDoc, SubcommandDoc } from "../HelpDoc.ts"
+import type * as GlobalFlag from "../GlobalFlag.ts"
+import type { ArgDoc, ExampleDoc, FlagDoc, HelpDoc, SubcommandGroupDoc } from "../HelpDoc.ts"
 import * as Param from "../Param.ts"
 import * as Primitive from "../Primitive.ts"
-import { type ConfigInternal, reconstructTree } from "./config.ts"
+import { type ConfigInternal, emptyConfig, reconstructTree } from "./config.ts"
 
 /* ========================================================================== */
 /* Types                                                                      */
@@ -22,14 +24,25 @@ import { type ConfigInternal, reconstructTree } from "./config.ts"
 
 import type { Command, CommandContext, Environment, ParsedTokens } from "../Command.ts"
 
+interface SubcommandGroup {
+  readonly group: string | undefined
+  readonly commands: Arr.NonEmptyReadonlyArray<Command<any, unknown, any, unknown, unknown>>
+}
+
 /**
  * Internal implementation interface with all the machinery.
  * Use toImpl() to access from internal code.
  */
-export interface CommandInternal<Name extends string, Input, E, R> extends Command<Name, Input, E, R> {
+export interface CommandInternal<Name extends string, Input, E, R, ContextInput>
+  extends Command<Name, Input, ContextInput, E, R>
+{
   readonly config: ConfigInternal
-  readonly service: ServiceMap.Service<CommandContext<Name>, Input>
+  readonly contextConfig: ConfigInternal
+  readonly service: ServiceMap.Key<CommandContext<Name>, ContextInput>
+  readonly annotations: ServiceMap.ServiceMap<never>
+  readonly globalFlags: ReadonlyArray<GlobalFlag.GlobalFlag<any>>
   readonly parse: (input: ParsedTokens) => Effect.Effect<Input, CliError.CliError, Environment>
+  readonly parseContext: (input: ParsedTokens) => Effect.Effect<ContextInput, CliError.CliError, Environment>
   readonly handle: (
     input: Input,
     commandPath: ReadonlyArray<string>
@@ -51,9 +64,9 @@ export const TypeId = "~effect/cli/Command" as const
  * Casts a Command to its internal implementation.
  * For use by internal modules that need access to config, parse, handle, etc.
  */
-export const toImpl = <Name extends string, Input, E, R>(
-  self: Command<Name, Input, E, R>
-): CommandInternal<Name, Input, E, R> => self as CommandInternal<Name, Input, E, R>
+export const toImpl = <Name extends string, Input, E, R, ContextInput = {}>(
+  self: Command<Name, Input, ContextInput, E, R>
+): CommandInternal<Name, Input, E, R, ContextInput> => self as CommandInternal<Name, Input, E, R, ContextInput>
 
 /* ========================================================================== */
 /* Proto                                                                      */
@@ -64,7 +77,7 @@ export const Proto = {
   pipe() {
     return pipeArguments(this, arguments)
   },
-  asEffect(this: Command<any, any, any, any>) {
+  asEffect(this: Command<any, any, any, any, any>) {
     return toImpl(this).service.asEffect()
   }
 }
@@ -76,19 +89,32 @@ export const Proto = {
 /**
  * Internal command constructor. Only accepts already-parsed ConfigInternal.
  */
-export const makeCommand = <const Name extends string, Input, E, R>(options: {
+export const makeCommand = <const Name extends string, Input, E, R, ContextInput = {}>(options: {
   readonly name: Name
   readonly config: ConfigInternal
-  readonly service?: ServiceMap.Service<CommandContext<Name>, Input> | undefined
+  readonly contextConfig?: ConfigInternal | undefined
+  readonly service?: ServiceMap.Key<CommandContext<Name>, ContextInput> | undefined
+  readonly annotations?: ServiceMap.ServiceMap<never> | undefined
+  readonly globalFlags?: ReadonlyArray<GlobalFlag.GlobalFlag<any>> | undefined
   readonly description?: string | undefined
-  readonly subcommands?: ReadonlyArray<Command<any, unknown, unknown, unknown>> | undefined
+  readonly shortDescription?: string | undefined
+  readonly alias?: string | undefined
+  readonly examples?: ReadonlyArray<Command.Example> | undefined
+  readonly subcommands?: ReadonlyArray<SubcommandGroup> | undefined
   readonly parse?: ((input: ParsedTokens) => Effect.Effect<Input, CliError.CliError, Environment>) | undefined
+  readonly parseContext?:
+    | ((input: ParsedTokens) => Effect.Effect<ContextInput, CliError.CliError, Environment>)
+    | undefined
   readonly handle?:
     | ((input: Input, commandPath: ReadonlyArray<string>) => Effect.Effect<void, E, R | Environment>)
     | undefined
-}): Command<Name, Input, E, R> => {
-  const service = options.service ?? ServiceMap.Service<CommandContext<Name>, Input>(`${TypeId}/${options.name}`)
+}): Command<Name, Input, ContextInput, E, R> => {
   const config = options.config
+  const contextConfig = options.contextConfig ?? emptyConfig
+  const service = options.service ?? ServiceMap.Service<CommandContext<Name>, ContextInput>(`${TypeId}/${options.name}`)
+  const annotations = options.annotations ?? ServiceMap.empty()
+  const globalFlags = options.globalFlags ?? []
+  const subcommands = options.subcommands ?? []
 
   const handle = (
     input: Input,
@@ -96,13 +122,10 @@ export const makeCommand = <const Name extends string, Input, E, R>(options: {
   ): Effect.Effect<void, CliError.CliError | E, R | Environment> =>
     Predicate.isNotUndefined(options.handle)
       ? options.handle(input, commandPath)
-      : Effect.fail(new CliError.ShowHelp({ commandPath }))
+      : Effect.fail(new CliError.ShowHelp({ commandPath, errors: [] }))
 
-  const parse = options.parse ?? Effect.fnUntraced(function*(input: ParsedTokens) {
-    const parsedArgs: Param.ParsedArgs = { flags: input.flags, arguments: input.arguments }
-    const values = yield* parseParams(parsedArgs, config.orderedParams)
-    return reconstructTree(config.tree, values) as Input
-  })
+  const parse = options.parse ?? makeParser(config) as any
+  const parseContext = options.parseContext ?? makeParser(contextConfig) as any
 
   const buildHelpDoc = (commandPath: ReadonlyArray<string>): HelpDoc => {
     const args: Array<ArgDoc> = []
@@ -123,8 +146,7 @@ export const makeCommand = <const Name extends string, Input, E, R>(options: {
     }
 
     let usage = commandPath.length > 0 ? commandPath.join(" ") : options.name
-    const subcommands = options.subcommands ?? []
-    if (subcommands.length > 0) {
+    if (subcommands.some((group) => group.commands.length > 0)) {
       usage += " <subcommand>"
     }
     usage += " [flags]"
@@ -136,42 +158,59 @@ export const makeCommand = <const Name extends string, Input, E, R>(options: {
     for (const option of config.flags) {
       const singles = Param.extractSingleParams(option)
       for (const single of singles) {
-        const formattedAliases = single.aliases.map((alias) => alias.length === 1 ? `-${alias}` : `--${alias}`)
-        flags.push({
-          name: single.name,
-          aliases: formattedAliases,
-          type: single.typeName ?? Primitive.getTypeName(single.primitiveType),
-          description: single.description,
-          required: single.primitiveType._tag !== "Boolean"
-        })
+        flags.push(toFlagDoc(single))
       }
     }
 
-    const subcommandDocs: Array<SubcommandDoc> = subcommands.map((sub) => ({
-      name: sub.name,
-      description: sub.description ?? ""
-    }))
+    const subcommandDocs: Array<SubcommandGroupDoc> = []
+
+    for (const group of subcommands) {
+      subcommandDocs.push({
+        group: group.group,
+        commands: Arr.map(group.commands, (subcommand) => ({
+          name: subcommand.name,
+          alias: subcommand.alias,
+          shortDescription: subcommand.shortDescription,
+          description: subcommand.description ?? ""
+        }))
+      })
+    }
+
+    const examples: ReadonlyArray<ExampleDoc> = options.examples ?? []
 
     return {
       description: options.description ?? "",
       usage,
       flags,
+      annotations,
       ...(args.length > 0 && { args }),
-      ...(subcommandDocs.length > 0 && { subcommands: subcommandDocs })
+      ...(subcommandDocs.length > 0 && { subcommands: subcommandDocs }),
+      ...(examples.length > 0 && { examples })
     }
   }
 
   return Object.assign(Object.create(Proto), {
     [TypeId]: TypeId,
     name: options.name,
-    subcommands: options.subcommands ?? [],
+    examples: options.examples ?? [],
+    annotations,
+    globalFlags,
+    subcommands,
     config,
+    contextConfig,
     service,
     parse,
+    parseContext,
     handle,
     buildHelpDoc,
     ...(Predicate.isNotUndefined(options.description)
       ? { description: options.description }
+      : {}),
+    ...(Predicate.isNotUndefined(options.shortDescription)
+      ? { shortDescription: options.shortDescription }
+      : {}),
+    ...(Predicate.isNotUndefined(options.alias)
+      ? { alias: options.alias }
       : {})
   })
 }
@@ -180,6 +219,32 @@ export const makeCommand = <const Name extends string, Input, E, R>(options: {
 /* Helpers                                                                    */
 /* ========================================================================== */
 
+/**
+ * Converts a single flag param into a FlagDoc for help display.
+ */
+export const toFlagDoc = (single: Param.Single<typeof Param.flagKind, unknown>): FlagDoc => {
+  const formattedAliases = single.aliases.map((alias) => alias.length === 1 ? `-${alias}` : `--${alias}`)
+  return {
+    name: single.name,
+    aliases: formattedAliases,
+    type: single.typeName ?? Primitive.getTypeName(single.primitiveType),
+    description: single.description,
+    required: single.primitiveType._tag !== "Boolean"
+  }
+}
+
+/**
+ * Creates a parser for a given config. Used as the default for both `parse`
+ * and `parseContext`, and also by `withSharedFlags` to avoid constructing a
+ * full throwaway command.
+ */
+export const makeParser = (cfg: ConfigInternal) =>
+  Effect.fnUntraced(function*(input: ParsedTokens) {
+    const parsedArgs: Param.ParsedArgs = { flags: input.flags, arguments: input.arguments }
+    const values = yield* parseParams(parsedArgs, cfg.orderedParams)
+    return reconstructTree(cfg.tree, values)
+  })
+
 /**
  * Parses param values from parsed command arguments into their typed
  * representations.
@@ -207,15 +272,18 @@ const parseParams: (parsedArgs: Param.ParsedArgs, params: ReadonlyArray<Param.An
 /**
  * Checks for duplicate flag names between parent and child commands.
  */
-export const checkForDuplicateFlags = <Name extends string, Input>(
-  parent: Command<Name, Input, unknown, unknown>,
-  subcommands: ReadonlyArray<Command<any, unknown, unknown, unknown>>
+export const checkForDuplicateFlags = <Name extends string, Input, ContextInput>(
+  parent: Command<Name, Input, ContextInput, unknown, unknown>,
+  subcommands: ReadonlyArray<Command<any, unknown, any, unknown, unknown>>,
+  options?: {
+    readonly contextConfig?: ConfigInternal | undefined
+  } | undefined
 ): void => {
   const parentImpl = toImpl(parent)
   const parentOptionNames = new Set<string>()
 
-  const extractNames = (options: ReadonlyArray<Param.Any>): void => {
-    for (const option of options) {
+  const extractNames = (flags: ReadonlyArray<Param.Any>): void => {
+    for (const option of flags) {
       const singles = Param.extractSingleParams(option)
       for (const single of singles) {
         parentOptionNames.add(single.name)
@@ -223,7 +291,7 @@ export const checkForDuplicateFlags = <Name extends string, Input>(
     }
   }
 
-  extractNames(parentImpl.config.flags)
+  extractNames((options?.contextConfig ?? parentImpl.contextConfig).flags)
 
   for (const subcommand of subcommands) {
     const subImpl = toImpl(subcommand)
@@ -241,25 +309,3 @@ export const checkForDuplicateFlags = <Name extends string, Input>(
     }
   }
 }
-
-/**
- * Helper function to get help documentation for a specific command path.
- * Navigates through the command hierarchy to find the right command.
- */
-export const getHelpForCommandPath = <Name extends string, Input, E, R>(
-  command: Command<Name, Input, E, R>,
-  commandPath: ReadonlyArray<string>
-): HelpDoc => {
-  let currentCommand: Command.Any = command
-
-  // Navigate through the command path to find the target command
-  for (let i = 1; i < commandPath.length; i++) {
-    const subcommandName = commandPath[i]
-    const subcommand = currentCommand.subcommands.find((sub) => sub.name === subcommandName)
-    if (subcommand) {
-      currentCommand = subcommand
-    }
-  }
-
-  return toImpl(currentCommand).buildHelpDoc(commandPath)
-}

package/src/unstable/cli/internal/completions/CommandDescriptor.ts

@@ -4,6 +4,7 @@
  *
  * @internal
  */
+import * as Option from "../../../../Option.ts"
 import type { Command } from "../../Command.ts"
 import * as Param from "../../Param.ts"
 import * as Primitive from "../../Primitive.ts"
@@ -135,7 +136,7 @@ export const fromCommand = (cmd: Command.Any): CommandDescriptor => {
       flags.push({
         name: single.name,
         aliases: single.aliases,
-        description: single.description,
+        description: Option.getOrUndefined(single.description),
         type: toFlagType(single as Param.Single<"flag", unknown>)
       })
     }
@@ -149,7 +150,7 @@ export const fromCommand = (cmd: Command.Any): CommandDescriptor => {
       if (single.kind !== "argument") continue
       args.push({
         name: single.name,
-        description: single.description,
+        description: Option.getOrUndefined(single.description),
         required: !metadata.isOptional,
         variadic: metadata.isVariadic,
         type: toArgumentType(single as Param.Single<"argument", unknown>)
@@ -157,11 +158,16 @@ export const fromCommand = (cmd: Command.Any): CommandDescriptor => {
     }
   }
 
-  const subcommands: Array<CommandDescriptor> = cmd.subcommands.map(fromCommand)
+  const subcommands: Array<CommandDescriptor> = []
+  for (const group of cmd.subcommands) {
+    for (const subcommand of group.commands) {
+      subcommands.push(fromCommand(subcommand))
+    }
+  }
 
   return {
     name: cmd.name,
-    description: cmd.description,
+    description: cmd.shortDescription ?? cmd.description,
     flags,
     arguments: args,
     subcommands

package/src/unstable/cli/internal/config.ts

@@ -183,6 +183,55 @@ export const parseConfig = (config: Config): ConfigInternal => {
   }
 }
 
+/** @internal */
+export const emptyConfig: ConfigInternal = parseConfig({})
+
+const shiftNodeIndexes = (node: ConfigInternal.Node, offset: number): ConfigInternal.Node => {
+  switch (node._tag) {
+    case "Param":
+      return {
+        _tag: "Param",
+        index: node.index + offset
+      }
+    case "Array":
+      return {
+        _tag: "Array",
+        children: node.children.map((child) => shiftNodeIndexes(child, offset))
+      }
+    case "Nested":
+      return {
+        _tag: "Nested",
+        tree: shiftTreeIndexes(node.tree, offset)
+      }
+  }
+}
+
+const shiftTreeIndexes = (tree: ConfigInternal.Tree, offset: number): ConfigInternal.Tree => {
+  const output: ConfigInternal.Tree = {}
+  for (const key in tree) {
+    output[key] = shiftNodeIndexes(tree[key], offset)
+  }
+  return output
+}
+
+/** @internal */
+export const mergeConfig = (
+  left: ConfigInternal,
+  right: ConfigInternal
+): ConfigInternal => {
+  const offset = left.orderedParams.length
+  return {
+    [ConfigInternalTypeId]: ConfigInternalTypeId,
+    flags: [...left.flags, ...right.flags],
+    arguments: [...left.arguments, ...right.arguments],
+    orderedParams: [...left.orderedParams, ...right.orderedParams],
+    tree: {
+      ...left.tree,
+      ...shiftTreeIndexes(right.tree, offset)
+    }
+  }
+}
+
 /* ========================================================================== */
 /* Reconstruction                                                             */
 /* ========================================================================== */

package/src/unstable/cli/internal/help.ts

@@ -0,0 +1,171 @@
+/**
+ * Help Documentation
+ * ================
+ *
+ * Internal helpers for generating help documentation.
+ * Extracted from command.ts to avoid circular dependencies.
+ */
+import * as Effect from "../../../Effect.ts"
+import type { Command } from "../Command.ts"
+import type * as GlobalFlag from "../GlobalFlag.ts"
+import type { FlagDoc, HelpDoc } from "../HelpDoc.ts"
+import * as Param from "../Param.ts"
+import { toFlagDoc, toImpl } from "./command.ts"
+
+const dedupeGlobalFlags = (
+  flags: ReadonlyArray<GlobalFlag.GlobalFlag<any>>
+): ReadonlyArray<GlobalFlag.GlobalFlag<any>> => {
+  const seen = new Set<GlobalFlag.GlobalFlag<any>>()
+  const deduped: Array<GlobalFlag.GlobalFlag<any>> = []
+  for (const flag of flags) {
+    if (seen.has(flag)) {
+      continue
+    }
+    seen.add(flag)
+    deduped.push(flag)
+  }
+  return deduped
+}
+
+/**
+ * Returns the resolved command lineage for the provided path.
+ * Includes the root command as the first element.
+ */
+export const getCommandsForCommandPath = <Name extends string, Input, E, R, ContextInput>(
+  command: Command<Name, Input, ContextInput, E, R>,
+  commandPath: ReadonlyArray<string>
+): ReadonlyArray<Command.Any> => {
+  const commands: Array<Command.Any> = [command]
+  let currentCommand: Command.Any = command
+
+  for (let i = 1; i < commandPath.length; i++) {
+    const subcommandName = commandPath[i]
+    let subcommand: Command.Any | undefined = undefined
+
+    for (const group of currentCommand.subcommands) {
+      subcommand = group.commands.find((sub) => sub.name === subcommandName)
+      if (subcommand) {
+        break
+      }
+    }
+
+    if (!subcommand) {
+      break
+    }
+
+    commands.push(subcommand)
+    currentCommand = subcommand
+  }
+
+  return commands
+}
+
+/**
+ * Returns active global flags for a command path.
+ * Built-ins are prepended and declarations are collected root -> leaf.
+ */
+export const getGlobalFlagsForCommandPath = <Name extends string, Input, E, R, ContextInput>(
+  command: Command<Name, Input, ContextInput, E, R>,
+  commandPath: ReadonlyArray<string>,
+  builtIns: ReadonlyArray<GlobalFlag.GlobalFlag<any>>
+): ReadonlyArray<GlobalFlag.GlobalFlag<any>> => {
+  const commands = getCommandsForCommandPath(command, commandPath)
+  const declared = commands.flatMap((current) => toImpl(current).globalFlags)
+  return dedupeGlobalFlags([
+    ...builtIns,
+    ...declared
+  ])
+}
+
+const collectDeclaredGlobalFlags = (command: Command.Any): ReadonlyArray<GlobalFlag.GlobalFlag<any>> => {
+  const collected: Array<GlobalFlag.GlobalFlag<any>> = []
+
+  const visit = (current: Command.Any): void => {
+    const impl = toImpl(current)
+    for (const flag of impl.globalFlags) {
+      collected.push(flag)
+    }
+    for (const group of current.subcommands) {
+      for (const subcommand of group.commands) {
+        visit(subcommand)
+      }
+    }
+  }
+
+  visit(command)
+  return dedupeGlobalFlags(collected)
+}
+
+const getSharedFlagsForCommandPath = (
+  commands: ReadonlyArray<Command.Any>,
+  currentFlags: ReadonlyArray<FlagDoc>
+): ReadonlyArray<FlagDoc> => {
+  if (commands.length <= 1) {
+    return []
+  }
+
+  const seen = new Set(currentFlags.map((flag) => flag.name))
+  const sharedFlags: Array<FlagDoc> = []
+
+  for (const ancestor of commands.slice(0, -1)) {
+    const ancestorImpl = toImpl(ancestor)
+    for (const flag of ancestorImpl.contextConfig.flags) {
+      const singles = Param.extractSingleParams(flag)
+      for (const single of singles) {
+        if (seen.has(single.name)) {
+          continue
+        }
+        seen.add(single.name)
+        sharedFlags.push(toFlagDoc(single))
+      }
+    }
+  }
+
+  return sharedFlags
+}
+
+/**
+ * Returns all global flags declared in a command tree.
+ * Built-ins are prepended and command declarations are deduplicated by identity.
+ */
+export const getGlobalFlagsForCommandTree = <Name extends string, Input, E, R, ContextInput>(
+  command: Command<Name, Input, ContextInput, E, R>,
+  builtIns: ReadonlyArray<GlobalFlag.GlobalFlag<any>>
+): ReadonlyArray<GlobalFlag.GlobalFlag<any>> =>
+  dedupeGlobalFlags([
+    ...builtIns,
+    ...collectDeclaredGlobalFlags(command)
+  ])
+
+/**
+ * Helper function to get help documentation for a specific command path.
+ * Navigates through the command hierarchy to find the right command.
+ * Reads active global flags for the path and includes them in the help doc.
+ */
+export const getHelpForCommandPath = <Name extends string, Input, E, R, ContextInput>(
+  command: Command<Name, Input, ContextInput, E, R>,
+  commandPath: ReadonlyArray<string>,
+  builtIns: ReadonlyArray<GlobalFlag.GlobalFlag<any>>
+): Effect.Effect<HelpDoc, never, never> =>
+  Effect.gen(function*() {
+    const commands = getCommandsForCommandPath(command, commandPath)
+    const currentCommand = commands.length > 0 ? commands[commands.length - 1] : command
+
+    const baseDoc = toImpl(currentCommand).buildHelpDoc(commandPath)
+
+    const sharedFlags = getSharedFlagsForCommandPath(commands, baseDoc.flags)
+
+    const flags = getGlobalFlagsForCommandPath(command, commandPath, builtIns)
+    const globalFlagDocs: Array<FlagDoc> = []
+    for (const flag of flags) {
+      const singles = Param.extractSingleParams(flag.flag)
+      for (const single of singles) {
+        globalFlagDocs.push({
+          ...toFlagDoc(single),
+          required: false
+        })
+      }
+    }
+
+    return { ...baseDoc, flags: [...sharedFlags, ...baseDoc.flags], globalFlags: globalFlagDocs }
+  })