getHelp method

String? getHelp(
  1. String name
)

Get help text for a single command.

Implementation

String? getHelp(String name) {
  final reg = get(name);
  if (reg == null) return null;

  final buf = StringBuffer();
  buf.writeln('/${reg.name} — ${reg.command.description}');

  if (reg.allAliases.isNotEmpty) {
    buf.writeln('  Aliases: ${reg.allAliases.map((a) => "/$a").join(", ")}');
  }
  if (reg.command.argumentHint != null) {
    buf.writeln('  Usage: /${reg.name} ${reg.command.argumentHint}');
  }

  buf.writeln('  Category: ${reg.category.name}');
  buf.writeln('  Type: ${reg.command.type.name}');

  if (reg.requiresAuth) buf.writeln('  Requires authentication');
  if (reg.requiresGit) buf.writeln('  Requires git repository');

  return buf.toString();
}