runCli function

Future<int> runCli(
  1. List<String> arguments, {
  2. StringSink? out,
  3. StringSink? err,
  4. String? workingDirectory,
  5. String? sdkPath,
})

Runs the command line; returns the exit code.

Reports go to out (or --output), errors and help to err.

Implementation

Future<int> runCli(
  List<String> arguments, {
  StringSink? out,
  StringSink? err,
  String? workingDirectory,
  String? sdkPath,
}) async {
  final stdoutSink = out ?? stdout;
  final stderrSink = err ?? stderr;
  final parser = _parser();

  ArgResults args;
  try {
    args = parser.parse(arguments);
  } on FormatException catch (e) {
    stderrSink
      ..writeln('tarpit: ${e.message}')
      ..writeln()
      ..writeln(_usage(parser));
    return exitUsage;
  }

  if (args.flag('help')) {
    stdoutSink.writeln(_usage(parser));
    return exitClean;
  }
  if (args.flag('version')) {
    stdoutSink.writeln('tarpit $packageVersion');
    return exitClean;
  }
  if (args.flag('rules')) {
    stdoutSink.write(rulesReport());
    return exitClean;
  }

  final checker = Checker(workingDirectory: workingDirectory, sdkPath: sdkPath);
  var paths = args.rest;
  if (paths.isEmpty) {
    final defaultDir = Directory(p.join(checker.workingDirectory, 'test'));
    paths = [if (defaultDir.existsSync()) 'test' else '.'];
  }

  CheckResult result;
  try {
    result = await checker.check(paths);
  } on CheckerInputException catch (e) {
    stderrSink.writeln('tarpit: $e');
    return exitUsage;
  }

  final report = switch (args.option('format')) {
    'json' => jsonReport(result),
    'sarif' => sarifReport(result),
    _ => textReport(result),
  };
  final output = args.option('output');
  if (output == null) {
    stdoutSink.write(report);
  } else {
    try {
      File(p.join(checker.workingDirectory, output)).writeAsStringSync(report);
    } on FileSystemException catch (e) {
      stderrSink.writeln('tarpit: cannot write $output: ${e.message}');
      return exitUsage;
    }
  }

  final threshold = Severity.parse(args.option('fail-on')!);
  return result.failsAt(threshold) ? exitFindings : exitClean;
}