Function details

tools/generate-command-docs.js:212–237

(command, args)

}

function details(command, args) {
  if (args.length === 0) {
    return 'Not applicable.';
  }

  return args
    .map(
      (arg) => `### \`${arg.name}\`

${arg.describe || 'No description available.'}

${
  !arg.alts || arg.alts.length === 0 ? '' : `- Aliases: \`${arg.alts.map((m) => `--${m}`).join('`, `')}\`${nl}`
}- Type: \`${arg.type}\`${arg.values ? nl + `- Choices: \`${arg.values.join('`, `')}\`` : ''}
- Default: \`${arg.default}\`${arg.required ? nl + '- **Caution: This flag is required!**' : ''}${
  Array.isArray(arg.examples) && arg.examples.length > 0
    ? `

Examples:

${arg.examples.map((example) => shell(`${getCall(command)} ${example}`)).join(nl + nl)}`
    : ''
}`,
    )
    .join(nl + nl);
}

function generateValidator(validator) {
  return `### \`${validator.name}\`