( single: Param.Single<typeof Param.flagKind, unknown>, metadata: ReturnType<typeof Param.getParamMetadata> )
| 236 | * Converts a single flag param into a FlagDoc for help display. |
| 237 | */ |
| 238 | export const toFlagDoc = ( |
| 239 | single: Param.Single<typeof Param.flagKind, unknown>, |
| 240 | metadata: ReturnType<typeof Param.getParamMetadata> |
| 241 | ): FlagDoc => { |
| 242 | const formattedAliases = single.aliases.map((alias) => alias.length === 1 ? `-${alias}` : `--${alias}`) |
| 243 | return { |
| 244 | name: single.name, |
| 245 | aliases: formattedAliases, |
| 246 | type: single.typeName ?? Primitive.getTypeName(single.primitiveType), |
| 247 | description: appendChoiceKeys(single.description, Primitive.getChoiceKeys(single.primitiveType)), |
| 248 | required: single.primitiveType._tag !== "Boolean" && !metadata.isOptional |
| 249 | } |
| 250 | } |
| 251 | |
| 252 | const appendChoiceKeys = ( |
| 253 | description: Option.Option<string>, |
no test coverage detected