showHelp method

Future<bool> showHelp()

Shows the usage help in the console.

Implementation

Future<bool> showHelp() async {
  print('\nUsage: bones_ui test [options] [files or directories...]\n');

  print('Options:');
  print('-h, --help                            Show this usage information.');
  print(
      '    --show-ui                         Run the tests showing the UI in the browser.');

  print('');
  print('    --enable-deferred-libraries       Enables deferred libraries.');
  print(
      '    --disable-deferred-libraries      Disables deferred libraries. (default due issue test#2088)');

  print('\nOptions from `dart test`:');
  print('-t, --tags                            Select a tag: -t basic');
  print('-x, --exclude-tags                    Exclude a tag: -x slow');
  print(
      '-n, --name                            A substring of the name of the test to run.');
  print(
      '    --pause-after-load                Pauses the browser for debugging before running the tests.');
  print(
      '    --debug                           Run the Chrome tests in debug mode.');

  print(
      '    --timeout                         The default test timeout. For example: 15s, 2x, none, 60s (default)');
  print(
      '    --ignore-timeouts                 Ignore all timeouts (useful if debugging)');
  print(
      '    --run-skipped                     Run skipped tests instead of skipping them.');
  print(
      "    --no-retry                        Don't rerun tests that have retry set.");

  print(
      '    --coverage=<directory>            Gather coverage and output it to the specified directory.');
  print(
      '    --reporter=<option>               Set how to print test results.');
  print(
      '    --file-reporter                   Enable an additional reporter writing test results to a file.');

  print(
      '    --js-trace                        Emit raw JavaScript stack traces for browser tests.');
  print(
      '    --dart2js-args                    Pass arguments to `dart2js` compiler.');

  print(
      '\n** See `dart test --help` or https://dart.dev/tools/dart-test for more details.');

  print('');

  return true;
}