ensure console prints go through our shared outSink (#4407)

analysis_options.yaml

@@ -22,6 +22,7 @@ linter:
 #    - avoid_implementing_value_types
 #    - avoid_js_rounded_ints # under review (see #1068)
     - avoid_positional_boolean_parameters
+    - avoid_print
 #    - avoid_private_typedef_functions # under review (see #1068)
     - avoid_redundant_argument_values
 #    - avoid_renaming_method_parameters # under review (see #1068)

lib/src/util/score_utils.dart

@@ -5,6 +5,8 @@
 import 'package:analyzer/src/lint/config.dart'; // ignore: implementation_imports
 import 'package:http/http.dart' as http;
 
+import '../utils.dart';
+
 Future<List<String>> _readCoreLints() async => _fetchLints(
     'https://raw.githubusercontent.com/dart-lang/lints/main/lib/core.yaml');
 
@@ -46,7 +48,7 @@ Future<List<String>> get flutterRules async =>
 Future<List<String>> fetchRules(Uri optionsUrl) async {
   var config = await _fetchConfig(optionsUrl);
   if (config == null) {
-    print('no config found for: $optionsUrl (SKIPPED)');
+    printToConsole('no config found for: $optionsUrl (SKIPPED)');
     return <String>[];
   }
   var rules = <String>[];
@@ -60,7 +62,7 @@ Future<List<String>> fetchRules(Uri optionsUrl) async {
 }
 
 Future<LintConfig?> _fetchConfig(Uri url) async {
-  print('loading $url...');
+  printToConsole('loading $url...');
   var req = await http.get(url);
   return processAnalysisOptionsFile(req.body);
 }

lib/src/utils.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 'package:analyzer/src/lint/io.dart'; // ignore: implementation_imports
+
 import 'ast.dart';
 import 'util/ascii_utils.dart';
 
@@ -92,6 +94,12 @@ bool isValidPackageName(String id) =>
     isIdentifier(id) &&
     !isReservedWord(id);
 
+/// Write the given [object] to the console.
+/// Uses the shared [outSink] for redirecting in tests.
+void printToConsole(Object? object) {
+  outSink.writeln(object);
+}
+
 class CamelCaseString {
   static final _camelCaseMatcher = RegExp(r'[A-Z][a-z]*');
 

test/integration_test.dart

@@ -9,6 +9,7 @@ import 'package:analyzer/src/lint/state.dart';
 import 'package:linter/src/analyzer.dart';
 import 'package:linter/src/cli.dart' as cli;
 import 'package:linter/src/rules.dart';
+import 'package:linter/src/utils.dart';
 import 'package:test/test.dart';
 import 'package:yaml/yaml.dart';
 
@@ -133,7 +134,7 @@ void coreTests() {
 
         for (var l in configuredLints) {
           if (!registered.contains(l)) {
-            print(l);
+            printToConsole(l);
           }
         }
 

test/rule_test.dart

@@ -23,6 +23,7 @@ import 'package:linter/src/rules/implementation_imports.dart';
 import 'package:linter/src/rules/package_prefixed_library_names.dart';
 import 'package:linter/src/test_utilities/annotation.dart';
 import 'package:linter/src/test_utilities/test_resource_provider.dart';
+import 'package:linter/src/utils.dart';
 import 'package:linter/src/version.dart';
 import 'package:path/path.dart' as p;
 import 'package:test/test.dart';
@@ -325,7 +326,7 @@ void _validateExpectedLints(File file, Iterable<AnalysisErrorInfo> errorInfos,
       var features = optionsImpl.contextFeatures;
 
       FileSpelunker(file.absolute.path, featureSet: features).spelunk();
-      print('');
+      printToConsole('');
       // Lints.
       ResultReporter(errorInfos).write();
     }

tool/bot/rule_doc_check.dart

@@ -5,22 +5,23 @@
 import 'dart:convert';
 
 import 'package:http/http.dart' as http;
+import 'package:linter/src/utils.dart';
 import 'package:test/test.dart';
 
 import '../crawl.dart';
 
 void main() async {
-  print('Getting latest linter package info from pub...');
+  printToConsole('Getting latest linter package info from pub...');
 
   var packageInfo =
       jsonDecode(await getBody('https://pub.dev/api/packages/linter'));
   var latestVersion = packageInfo['latest']['pubspec']['version'];
-  print('Found: $latestVersion.');
+  printToConsole('Found: $latestVersion.');
   if (latestVersion is String) {
     var minor = latestVersion.split('.').last;
     var latestRules = await fetchRulesForVersion('0.1.$minor');
-    print('Checking to ensure rules have published docs...');
-    print('');
+    printToConsole('Checking to ensure rules have published docs...');
+    printToConsole('');
 
     group('validate url:', () {
       for (var rule in latestRules) {

tool/bot/version_check.dart

@@ -6,27 +6,29 @@ import 'dart:convert';
 import 'dart:io';
 
 import 'package:http/http.dart' as http;
+import 'package:linter/src/utils.dart';
 
 void main() async {
-  print('Getting latest linter package info from pub...');
+  printToConsole('Getting latest linter package info from pub...');
   var packageInfo =
       jsonDecode(await getBody('https://pub.dev/api/packages/linter'));
   var latestVersion = packageInfo['latest']['pubspec']['version'];
-  print('Found: $latestVersion.');
-  print('Checking for a git release tag corresponding to $latestVersion...');
+  printToConsole('Found: $latestVersion.');
+  printToConsole(
+      'Checking for a git release tag corresponding to $latestVersion...');
 
   var client = http.Client();
   var req = await client.get(Uri.parse(
       'https://github.com/dart-lang/linter/releases/tag/$latestVersion'));
 
   if (req.statusCode == 404) {
-    print(
+    printToConsole(
         'No tagged release for $latestVersion found; this will cause problems when included in SDK DEPS.');
-    print(
+    printToConsole(
         'Be sure a $latestVersion release is tagged in https://github.com/dart-lang/linter/releases and re-run.');
     exit(1);
   } else {
-    print('Tag found 👍.');
+    printToConsole('Tag found 👍.');
   }
 }
 

tool/canonical/gh_labels.dart

@@ -7,6 +7,7 @@ import 'dart:convert';
 import 'package:args/args.dart';
 import 'package:github/github.dart';
 import 'package:http/http.dart' as http;
+import 'package:linter/src/utils.dart';
 
 import '../github.dart';
 
@@ -42,7 +43,7 @@ Future<void> main(List<String> args) async {
         var sets = rule.value;
         for (var set in sets) {
           if (!issue.labels.any((label) => label.name.startsWith('set-'))) {
-            print('${issue.htmlUrl} => set-$set');
+            printToConsole('${issue.htmlUrl} => set-$set');
           }
         }
       }
@@ -54,7 +55,7 @@ void printUsage(ArgParser parser, [String? error]) {
   var message = error ??
       'Query lint rules for containing rule sets and relevant GH issues.';
 
-  print('''$message
+  printToConsole('''$message
 Usage: query.dart rule_name
 ${parser.usage}
 ''');

tool/canonical/scorecard.dart

@@ -15,6 +15,7 @@ import 'package:github/github.dart';
 import 'package:http/http.dart' as http;
 import 'package:linter/src/analyzer.dart';
 import 'package:linter/src/rules.dart';
+import 'package:linter/src/utils.dart';
 
 import '../parse.dart';
 
@@ -33,7 +34,7 @@ void main() async {
     return s1.name.compareTo(s2.name) + base;
   }
 
-  print(scorecard.asMarkdown(details, sorter: sorter));
+  printToConsole(scorecard.asMarkdown(details, sorter: sorter));
 
   // var footer = buildFooter(scorecard, details);
   // print(footer);
@@ -458,7 +459,7 @@ class _LintNameCollector extends GeneralizingAstVisitor<void> {
   void addLint(String name) {
     lintNames.add(name);
     if (!registeredLintNames.contains(name)) {
-      print('WARNING: unrecognized lint in fixes: $name');
+      printToConsole('WARNING: unrecognized lint in fixes: $name');
     }
   }
 }

tool/crawl.dart

@@ -11,6 +11,7 @@ import 'package:http/http.dart' as http;
 import 'package:linter/src/analyzer.dart';
 import 'package:linter/src/rules.dart';
 import 'package:linter/src/util/score_utils.dart' as score_utils;
+import 'package:linter/src/utils.dart';
 import 'package:pub_semver/pub_semver.dart';
 import 'package:yaml/yaml.dart';
 
@@ -205,17 +206,18 @@ Future<List<String>> _fetchRepoTags(String org, String repo,
   var github = GitHub(auth: auth);
   var slug = RepositorySlug(org, repo);
 
-  print('list repository tags: $slug');
-  print('authentication:  ${auth != null ? "(token)" : "(anonymous)"}');
+  printToConsole('list repository tags: $slug');
+  printToConsole(
+      'authentication:  ${auth != null ? "(token)" : "(anonymous)"}');
 
   var tags = await github.repositories
       .listTags(slug)
       .map((t) => t.name)
       .toList()
       .catchError((e) {
-    print('exception caught fetching $repo tags');
-    print(e);
-    print('(using cached $repo values)');
+    printToConsole('exception caught fetching $repo tags');
+    printToConsole(e);
+    printToConsole('(using cached $repo values)');
     return Future.value(<String>[]);
   });
 

tool/doc.dart

@@ -13,6 +13,7 @@ import 'package:github/github.dart';
 import 'package:http/http.dart' as http;
 import 'package:linter/src/analyzer.dart';
 import 'package:linter/src/rules.dart';
+import 'package:linter/src/utils.dart';
 import 'package:markdown/markdown.dart';
 import 'package:yaml/yaml.dart';
 
@@ -129,7 +130,7 @@ Future<void> fetchBadgeInfo() async {
 
 Future<LintConfig?> fetchConfig(String url) async {
   var client = http.Client();
-  print('loading $url...');
+  printToConsole('loading $url...');
   var req = await client.get(Uri.parse(url));
   return processAnalysisOptionsFile(req.body);
 }
@@ -139,7 +140,7 @@ Future<Map<String, String>> fetchFixStatusMap() async {
   var url =
       'https://raw.githubusercontent.com/dart-lang/sdk/main/pkg/analysis_server/lib/src/services/correction/error_fix_status.yaml';
   var client = http.Client();
-  print('loading $url...');
+  printToConsole('loading $url...');
   var req = await client.get(Uri.parse(url));
   var yaml = loadYamlNode(req.body) as YamlMap;
   for (var entry in yaml.entries) {
@@ -168,7 +169,7 @@ Future<void> generateDocs(String? dir,
     }
 
     if (!d.existsSync()) {
-      print("Directory '${d.path}' does not exist");
+      printToConsole("Directory '${d.path}' does not exist");
       return;
     }
 
@@ -318,10 +319,10 @@ class HtmlIndexer {
     var generated = _generate();
     if (filePath != null) {
       var outPath = '$filePath/index.html';
-      print('Writing to $outPath');
+      printToConsole('Writing to $outPath');
       File(outPath).writeAsStringSync(generated);
     } else {
-      print(generated);
+      printToConsole(generated);
     }
   }
 
@@ -398,10 +399,10 @@ class MachineSummaryGenerator {
         fixStatusMap: fixStatusMap, sinceInfo: sinceInfo);
     if (filePath != null) {
       var outPath = '$filePath/machine/rules.json';
-      print('Writing to $outPath');
+      printToConsole('Writing to $outPath');
       File(outPath).writeAsStringSync(generated);
     } else {
-      print(generated);
+      printToConsole(generated);
     }
   }
 }
@@ -483,7 +484,7 @@ class MarkdownIndexer {
     }
 
     if (filePath == null) {
-      print(buffer);
+      printToConsole(buffer);
     } else {
       File('$filePath/index.md').writeAsStringSync(buffer.toString());
     }
@@ -499,10 +500,10 @@ class OptionsSample {
     var generated = _generate();
     if (filePath != null) {
       var outPath = '$filePath/options/options.html';
-      print('Writing to $outPath');
+      printToConsole('Writing to $outPath');
       File(outPath).writeAsStringSync(generated);
     } else {
-      print(generated);
+      printToConsole(generated);
     }
   }
 
@@ -669,10 +670,10 @@ class RuleHtmlGenerator extends RuleGenerator {
     var generated = _generate();
     if (filePath != null) {
       var outPath = '$filePath/$name.html';
-      print('Writing to $outPath');
+      printToConsole('Writing to $outPath');
       File(outPath).writeAsStringSync(generated);
     } else {
-      print(generated);
+      printToConsole(generated);
     }
   }
 
@@ -788,7 +789,7 @@ class RuleMarkdownGenerator extends RuleGenerator {
     buffer.write(usageMarkdown);
 
     if (filePath == null) {
-      print(buffer);
+      printToConsole(buffer);
     } else {
       File('$filePath/$name.md').writeAsStringSync(buffer.toString());
     }

tool/gh/get_labels.dart

@@ -4,6 +4,7 @@
 
 import 'package:args/args.dart';
 import 'package:github/github.dart';
+import 'package:linter/src/utils.dart';
 
 import '../github.dart';
 
@@ -39,13 +40,13 @@ Future<void> main(List<String> args) async {
   var auth = token is String ? Authentication.withToken(token) : null;
   var labels = await getLabels(owner: owner, name: name, auth: auth);
   for (var label in labels) {
-    print(label.name);
+    printToConsole(label.name);
   }
 }
 
 void printUsage(ArgParser parser, [String? error]) {
   var message = error ?? 'Get labels for a given GitHub repo.';
-  print('''$message
+  printToConsole('''$message
 Usage: get_labels.dart rule_name
 ${parser.usage}
 ''');