commit | c05f47ed1c09067afa06bc164fa024280c696d30 | [log] [tgz] |
---|---|---|
author | Phil Quitslund <pq@users.noreply.github.com> | Wed May 17 10:41:15 2017 -0700 |
committer | GitHub <noreply@github.com> | Wed May 17 10:41:15 2017 -0700 |
tree | 73a74da24b6bd97f9b75539a2539ca7f5e5e5cb6 | |
parent | dfb626f260a1bf35ea5c90e1d659a2309e3739d0 [diff] | |
parent | 55354bc95198365c343bc768ab3099a6574ef76f [diff] |
Merge pull request #17 from dart-lang/pq-patch-1-1 Add pub package badge.
A library to help in building Dart command-line apps.
In particular, cli_util
provides a simple, standardized way to get the current SDK directory. Useful, especially, when building client applications that interact with the Dart SDK (such as the analyzer).
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. String sdkPath = getSdkPath(); // Do stuff... For example, print version string File versionFile = new File(path.join(sdkPath, 'version')); print(versionFile.readAsStringSync()); }
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'; main(List<String> args) async { bool verbose = args.contains('-v'); Logger logger = verbose ? new Logger.verbose() : new Logger.standard(); logger.stdout('Hello world!'); logger.trace('message 1'); await new Future.delayed(new Duration(milliseconds: 200)); logger.trace('message 2'); logger.trace('message 3'); Progress progress = logger.progress('doing some work'); await new Future.delayed(new Duration(seconds: 2)); progress.finish(showTiming: true); logger.stdout('All ${logger.ansi.emphasized('done')}.'); logger.flush(); }
Please file feature requests and bugs at the issue tracker.