Function getZshCompletions

packages/cli/src/internal/args.ts:1073–1111

(
  self: Instruction,
  state: ZshCompletionState = { multiple: false, optional: false }
)

}

export const getZshCompletions = (
  self: Instruction,
  state: ZshCompletionState = { multiple: false, optional: false }
): Array<string> => {
  switch (self._tag) {
    case "Empty": {
      return Arr.empty()
    }
    case "Single": {
      const multiple = state.multiple ? "*" : ""
      const optional = state.optional ? "::" : ":"
      const shortDescription = getShortDescription(self)
      const description = shortDescription.length > 0 ? ` -- ${shortDescription}` : ""
      const possibleValues = InternalPrimitive.getZshCompletions(
        self.primitiveType as InternalPrimitive.Instruction
      )
      return possibleValues.length === 0
        ? Arr.empty()
        : Arr.of(`${multiple}${optional}${self.name}${description}${possibleValues}`)
    }
    case "Map": {
      return getZshCompletions(self.args as Instruction, state)
    }
    case "Both": {
      const left = getZshCompletions(self.left as Instruction, state)
      const right = getZshCompletions(self.right as Instruction, state)
      return Arr.appendAll(left, right)
    }
    case "Variadic": {
      return Option.isSome(self.max) && self.max.value > 1
        ? getZshCompletions(self.args as Instruction, { ...state, multiple: true })
        : getZshCompletions(self.args as Instruction, state)
    }
    case "WithDefault":
    case "WithFallbackConfig": {
      return getZshCompletions(self.args as Instruction, { ...state, optional: true })
    }
  }
}