MCPcopy Create free account
hub / github.com/Effect-TS/effect / toFlagDoc

Function toFlagDoc

packages/effect/src/unstable/cli/internal/command.ts:238–250  ·  view source on GitHub ↗
(
  single: Param.Single<typeof Param.flagKind, unknown>,
  metadata: ReturnType<typeof Param.getParamMetadata>
)

Source from the content-addressed store, hash-verified

236 * Converts a single flag param into a FlagDoc for help display.
237 */
238export 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
252const appendChoiceKeys = (
253 description: Option.Option<string>,

Callers 3

getHelpForCommandPathFunction · 0.90
buildHelpDocFunction · 0.85

Calls 2

appendChoiceKeysFunction · 0.85
mapMethod · 0.45

Tested by

no test coverage detected