Function getHelpInternal

packages/cli/src/internal/options.ts:722–818

(self: Instruction)

}

const getHelpInternal = (self: Instruction): HelpDoc.HelpDoc => {
  switch (self._tag) {
    case "Empty": {
      return InternalHelpDoc.empty
    }
    case "Single": {
      return InternalHelpDoc.descriptionList(Arr.of([
        InternalHelpDoc.getSpan(InternalUsage.getHelp(getUsageInternal(self))),
        InternalHelpDoc.sequence(
          InternalHelpDoc.p(InternalPrimitive.getHelp(self.primitiveType)),
          self.description
        )
      ]))
    }
    case "KeyValueMap": {
      // Single options always have an identifier, so we can safely `getOrThrow`
      const identifier = Option.getOrThrow(
        getIdentifierInternal(self.argumentOption as Instruction)
      )
      return InternalHelpDoc.mapDescriptionList(
        getHelpInternal(self.argumentOption as Instruction),
        (span, oldBlock) => {
          const header = InternalHelpDoc.p("This setting is a property argument which:")
          const single = `${identifier} key1=value key2=value2`
          const multiple = `${identifier} key1=value ${identifier} key2=value2`
          const description = InternalHelpDoc.enumeration([
            InternalHelpDoc.p(`May be specified a single time:  '${single}'`),
            InternalHelpDoc.p(`May be specified multiple times: '${multiple}'`)
          ])
          const newBlock = pipe(
            oldBlock,
            InternalHelpDoc.sequence(header),
            InternalHelpDoc.sequence(description)
          )
          return [span, newBlock]
        }
      )
    }
    case "Map": {
      return getHelpInternal(self.options as Instruction)
    }
    case "Both":
    case "OrElse": {
      return InternalHelpDoc.sequence(
        getHelpInternal(self.left as Instruction),
        getHelpInternal(self.right as Instruction)
      )
    }
    case "Variadic": {
      const help = getHelpInternal(self.argumentOption as Instruction)
      return InternalHelpDoc.mapDescriptionList(help, (oldSpan, oldBlock) => {
        const min = getMinSizeInternal(self as Instruction)
        const max = getMaxSizeInternal(self as Instruction)
        const newSpan = InternalSpan.text(
          Option.isSome(self.max) ? ` ${min} - ${max}` : min === 0 ? "..." : ` ${min}+`
        )
        const newBlock = InternalHelpDoc.p(
          Option.isSome(self.max)