| commit | 16e8994eb66fb6ca971de1857167911f6cb52aea | [log] [tgz] |
|---|---|---|
| author | Phil Quitslund <pq@users.noreply.github.com> | Fri May 14 16:17:35 2021 -0700 |
| committer | GitHub <noreply@github.com> | Fri May 14 16:17:35 2021 -0700 |
| tree | 2be1394c53792700081a27a1e618e799ed8c997c | |
| parent | 8c504de5deb08fe32ecf51f9662bb37d8c708e57 [diff] |
enable recommended lints (#63)
A package 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 = 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 { bool verbose = args.contains('-v'); Logger 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'); Progress 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.