runCommand method

  1. @override
Future<int?> runCommand(
  1. ArgResults topLevelResults
)
override

Runs the command specified by topLevelResults.

This is notionally a protected method. It may be overridden or called from subclasses, but it shouldn't be called externally.

It's useful to override this to handle global flags and/or wrap the entire command in a block. For example, you might handle the --verbose flag here to enable verbose logging before running the command.

This returns the return value of Command.run.

Implementation

@override
Future<int?> runCommand(ArgResults topLevelResults) async {
  if (topLevelResults.command?.name == 'completion') {
    await super.runCommand(topLevelResults);
    return ExitCode.success.code;
  }

  _logger
    ..detail('Argument information:')
    ..detail('  Top level options:');

  for (final option in topLevelResults.options) {
    if (topLevelResults.wasParsed(option)) {
      _logger.detail('  - $option: ${topLevelResults[option]}');
    }
  }

  if (topLevelResults.command != null) {
    final commandResult = topLevelResults.command!;
    _logger
      ..detail('  Command: ${commandResult.name}')
      ..detail('    Command options:');
    for (final option in commandResult.options) {
      if (commandResult.wasParsed(option)) {
        _logger.detail('    - $option: ${commandResult[option]}');
      }
    }

    if (commandResult.command != null) {
      final subCommandResult = commandResult.command!;
      _logger.detail('    Command sub command: ${subCommandResult.name}');
    }
  }

  final exitCode = await super.runCommand(topLevelResults);
  return exitCode;
}