6a61e53ba1a9f200becaaa7210ac0d7ec3e8aef9 - cli_util

commit	6a61e53ba1a9f200becaaa7210ac0d7ec3e8aef9	[log] [tgz]
author	Moritz <mosum@google.com>	Thu Oct 31 14:25:59 2024 +0100
committer	GitHub <noreply@github.com>	Thu Oct 31 14:25:59 2024 +0100
tree	668d8d0887168fc0d3591eb4310394e4bbc3cf7b
parent	c36b3941e38092d6d6f87ac27d9e88f153d3ac38 [diff]

tree: 668d8d0887168fc0d3591eb4310394e4bbc3cf7b

README.md

[!IMPORTANT]
This repo has moved to https://github.com/dart-lang/tools/tree/main/pkgs/cli_util

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

What's this?

package:cli_util provides:

utilities to find the Dart SDK directory (sdkPath)
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 directory from cli_util.
  var sdkDir = sdkPath;
  
  // Do stuff... For example, print version string
  var versionFile = File(path.join(sdkDir, '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.