Function buildArgumentListItems

scripts/docs/src/generate-cli-docs.ts:337–372

(args: readonly Argument[])

}

function buildArgumentListItems(args: readonly Argument[]): ListItem[] {
  return args.map((arg) => {
    const children: PhrasingContent[] = [
      createInlineCode(formatArgumentLabel(arg)),
    ];

    if (arg.description) {
      children.push({ type: "text", value: ` — ${arg.description}` });
    }

    const details: string[] = [];

    if (arg.defaultValueDescription) {
      details.push(`default: ${arg.defaultValueDescription}`);
    } else if (arg.defaultValue !== undefined) {
      details.push(`default: ${formatValue(arg.defaultValue)}`);
    }

    if (arg.argChoices && arg.argChoices.length > 0) {
      details.push(`choices: ${arg.argChoices.join(", ")}`);
    }

    if (!arg.required) {
      details.push("optional");
    }

    if (details.length > 0) {
      children.push({
        type: "text",
        value: ` (${details.join("; ")})`,
      });
    }

    return createListItem(children);
  });
}

type BuildCommandSectionOptions = {
  command: Command;