Google Git
Sign in
dart / cli_util / refs/tags/v0.4.1
commit1fd87c1c2c65b61587c56de7cf3368481c0bd5bf[log] [tgz]
authorDevon Carew <devoncarew@gmail.com>Fri Dec 15 10:15:05 2023 -0800
committerGitHub <noreply@github.com>Fri Dec 15 10:15:05 2023 -0800
tree83acaec3db1d459ea968a45ddc25d71f8d15f177
parent500dffab6e00332c4c0b814359f06c8a9c3a5573 [diff]
require dart 3.0; rev to 0.4.1 in prep for publishing (#93)

require dart 3.0; rev to 0.4.1 in prep for publishing
5 files changed
tree: 83acaec3db1d459ea968a45ddc25d71f8d15f177
  1. .github/
  2. example/
  3. lib/
  4. test/
  5. .gitignore
  6. analysis_options.yaml
  7. AUTHORS
  8. CHANGELOG.md
  9. CONTRIBUTING.md
  10. LICENSE
  11. pubspec.yaml
  12. README.md
README.md

Dart CI Pub package publisher

A package to help in building Dart command-line apps.

What's this?

package:cli_util provides:

  • utilities to find the Dart SDK directory (getSdkPath())
  • utilities to find the settings directory for a tool (applicationConfigHome())
  • utilities to aid in showing rich CLI output and progress information (cli_logging.dart)

Locating the Dart SDK

import 'dart:io';

import 'package:cli_util/cli_util.dart';
import 'package:path/path.dart' as path;

main(args) {
  // Get sdk dir from cli_util.
  var sdkPath = getSdkPath();
  
  // Do stuff... For example, print version string
  var versionFile = File(path.join(sdkPath, 'version'));
  print(versionFile.readAsStringSync());
}

Displaying output and progress

package:cli_util can also be used to help CLI tools display output and progress. It has a logging mechanism which can help differentiate between regular tool output and error messages, and can facilitate having a more verbose (-v) mode for output.

In addition, it can display an indeterminate progress spinner for longer running tasks, and optionally display the elapsed time when finished:

import 'package:cli_util/cli_logging.dart';

void main(List<String> args) async {
  var verbose = args.contains('-v');
  var logger = verbose ? Logger.verbose() : Logger.standard();

  logger.stdout('Hello world!');
  logger.trace('message 1');
  await Future.delayed(Duration(milliseconds: 200));
  logger.trace('message 2');
  logger.trace('message 3');

  var progress = logger.progress('doing some work');
  await Future.delayed(Duration(seconds: 2));
  progress.finish(showTiming: true);

  logger.stdout('All ${logger.ansi.emphasized('done')}.');
  logger.flush();
}

Features and bugs

Please file feature requests and bugs at the issue tracker.