commit 6deb457048deb435009b36a4cd2d86003d107cf4
author Nate Bosch <nbosch1@gmail.com> Mon Apr 20 11:30:03 2020 -0700
committer GitHub <noreply@github.com> Mon Apr 20 11:30:03 2020 -0700
tree b77b1e4808da131b4d90d241abd4af114510b4f3
parent 6e2ce2e4add80c4e15c8346a976cbf760d707f6a

Use line length to wrap usage (#2457)

Specify the `usageLineLength` in our command and command runner. Use the
terminal width or default to 80 if it is unknown.

Remove manually placed newlines in a help string with a space so that
it can wrap based on terminal width. For a width of 80 the wrapping
matches the manual newlines.

lib/src/command.dart

diff --git a/lib/src/command.dart b/lib/src/command.dart
index d6f2439..1752efb 100644
--- a/lib/src/command.dart
+++ b/lib/src/command.dart
@@ -2,6 +2,8 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import 'dart:io';
+
 import 'package:args/args.dart';
 import 'package:args/command_runner.dart';
 
@@ -21,6 +23,8 @@
   'upgrade': ['update'],
 };
 
+final lineLength = stdout.hasTerminal ? stdout.terminalColumns : 80;
+
 /// The base class for commands for the pub executable.
 ///
 /// A command may either be a "leaf" command or it may be a parent for a set
@@ -53,8 +57,8 @@
   // Lazily initialize the parser because the superclass constructor requires
   // it but we want to initialize it based on [allowTrailingOptions].
   @override
-  ArgParser get argParser =>
-      _argParser ??= ArgParser(allowTrailingOptions: allowTrailingOptions);
+  ArgParser get argParser => _argParser ??= ArgParser(
+      allowTrailingOptions: allowTrailingOptions, usageLineLength: lineLength);
 
   ArgParser _argParser;
 

lib/src/command/outdated.dart

diff --git a/lib/src/command/outdated.dart b/lib/src/command/outdated.dart
index 4109860..82b59aa 100644
--- a/lib/src/command/outdated.dart
+++ b/lib/src/command/outdated.dart
@@ -33,7 +33,7 @@
   OutdatedCommand() {
     argParser.addFlag('color',
         help: 'Whether to color the output.\n'
-            'Defaults to color when connected to a\n'
+            'Defaults to color when connected to a '
             'terminal, and no-color otherwise.');
 
     argParser.addFlag(
@@ -67,7 +67,7 @@
 
     argParser.addFlag('up-to-date',
         defaultsTo: false,
-        help: 'Include dependencies that are already at the\n'
+        help: 'Include dependencies that are already at the '
             'latest version.');
   }
 

lib/src/command_runner.dart

diff --git a/lib/src/command_runner.dart b/lib/src/command_runner.dart
index 0c3d5f8..f6b0f1d 100644
--- a/lib/src/command_runner.dart
+++ b/lib/src/command_runner.dart
@@ -10,7 +10,7 @@
 import 'package:http/http.dart' as http;
 import 'package:path/path.dart' as p;
 
-import 'command.dart' show pubCommandAliases;
+import 'command.dart' show pubCommandAliases, lineLength;
 import 'command/build.dart';
 import 'command/cache.dart';
 import 'command/deps.dart';
@@ -79,7 +79,9 @@
   String get usageFooter =>
       'See https://dart.dev/tools/pub/cmd for detailed documentation.';
 
-  PubCommandRunner() : super('pub', 'Pub is a package manager for Dart.') {
+  PubCommandRunner()
+      : super('pub', 'Pub is a package manager for Dart.',
+            usageLineLength: lineLength) {
     argParser.addFlag('version', negatable: false, help: 'Print pub version.');
     argParser.addFlag('trace',
         help: 'Print debugging information when an error occurs.');