commit | 91747f7dd9bdf2457f081d3cf035de5672dd4a02 | [log] [tgz] |
---|---|---|
author | Devon Carew <devoncarew@gmail.com> | Thu Mar 02 09:30:12 2023 -0800 |
committer | GitHub <noreply@github.com> | Thu Mar 02 09:30:12 2023 -0800 |
tree | 0fe7c7371c5647eb3990dbf4b59f4890c1b638f3 | |
parent | 525f2a84a92c197eeac95405e4c5dccf097c7189 [diff] |
Update README.md (#79)
A package to help in building Dart command-line apps.
package:cli_util
provides:
getSdkPath()
)applicationConfigHome()
)cli_logging.dart
)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()); }
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(); }
Please file feature requests and bugs at the issue tracker.