analyzer: move io utils out of analyzer/lib, into linter/tool

Change-Id: Iacbb37db605f831a11277d1933db0a8d2274a195
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/445103
Reviewed-by: Konstantin Shcheglov <scheglov@google.com>
Commit-Queue: Konstantin Shcheglov <scheglov@google.com>
Auto-Submit: Samuel Rawlins <srawlins@google.com>

pkg/linter/lib/src/utils.dart

@@ -3,7 +3,6 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/dart/ast/token.dart';
-import 'package:analyzer/src/lint/io.dart'; // ignore: implementation_imports
 
 // A camel case string here is defined as:
 // * An arbitrary number of optional leading `_`s or `$`s,
@@ -88,12 +87,6 @@ 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);
-}
-
 bool _isCamelCase(String name) => _camelCasePattern.hasMatch(name);
 
 /// Whether this [name] is a legal Dart identifier.

pkg/linter/test/all.dart

@@ -2,14 +2,11 @@
 // 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';
-
 import 'ascii_utils_test.dart' as ascii_utils;
 import 'doc_test.dart' as doc;
 import 'formatter_test.dart' as formatter;
 import 'integration_test.dart' as integration;
 import 'lint_code_test.dart' as lint_code;
-import 'mocks.dart';
 import 'pubspec_test.dart' as pubspec;
 import 'rules/all.dart' as rules;
 import 'scope_util_test.dart' as scope_util;
@@ -25,9 +22,6 @@ import 'verify_reflective_test_suites_test.dart'
     as verify_reflective_test_suites;
 
 void main() {
-  // Redirect output.
-  outSink = MockIOSink();
-
   ascii_utils.main();
   doc.main();
   formatter.main();

pkg/linter/test/doc_test.dart

@@ -2,14 +2,14 @@
 // 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:linter/src/rules.dart';
 import 'package:test/test.dart';
 
 import '../tool/machine.dart';
-import 'util/test_utils.dart';
 
 void main() {
   group('doc generation', () {
-    setUp(setUpSharedTestEnvironment);
+    setUp(registerLintRules);
     test('fixStatus (sanity)', () {
       var fixStatusMap = readFixStatusMap();
       // Doc generation reads the fix status map to associate fix status

pkg/linter/test/util/test_utils.dart

@@ -1,20 +0,0 @@
-// Copyright (c) 2017, the Dart project authors. Please see the AUTHORS file
-// 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';
-import 'package:linter/src/rules.dart';
-import 'package:test/test.dart';
-
-import '../mocks.dart';
-
-void setUpSharedTestEnvironment() {
-  // Redirect output.
-  outSink = MockIOSink();
-  registerLintRules();
-}
-
-void testEach<T>(Iterable<T> values, bool Function(T s) f, Matcher m) {
-  for (var s in values) {
-    test('"$s"', () => expect(f(s), m));
-  }
-}

pkg/linter/test/utils_test.dart

@@ -5,8 +5,6 @@
 import 'package:linter/src/utils.dart';
 import 'package:test/test.dart';
 
-import 'util/test_utils.dart';
-
 void main() {
   group('isDartFileName', () {
     testEach(['foo.dart'], isDartFileName, isTrue);
@@ -165,3 +163,9 @@ void main() {
     testEach(bad, isUpperCase, isFalse);
   });
 }
+
+void testEach<T>(Iterable<T> values, bool Function(T s) f, Matcher m) {
+  for (var s in values) {
+    test('"$s"', () => expect(f(s), m));
+  }
+}

pkg/linter/test/validate_rule_description_format_test.dart

@@ -3,13 +3,12 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/src/lint/registry.dart';
+import 'package:linter/src/rules.dart';
 import 'package:test/test.dart';
 
-import 'util/test_utils.dart';
-
 void main() {
   group('rule doc format', () {
-    setUpSharedTestEnvironment();
+    registerLintRules();
     var rules = Registry.ruleRegistry.rules;
 
     test('(setup)', () {

pkg/linter/tool/benchmark.dart

@@ -10,7 +10,6 @@ import 'package:analyzer/analysis_rule/analysis_rule.dart';
 import 'package:analyzer/diagnostic/diagnostic.dart';
 import 'package:analyzer/src/lint/analysis_rule_timers.dart';
 import 'package:analyzer/src/lint/config.dart';
-import 'package:analyzer/src/lint/io.dart';
 import 'package:analyzer/src/lint/registry.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:args/args.dart';
@@ -21,6 +20,7 @@ import 'package:yaml/yaml.dart';
 
 import 'lint_sets.dart';
 import 'test_linter.dart';
+import 'util/io.dart';
 
 /// Benchmarks lint rules.
 Future<void> main(List<String> args) async {

pkg/linter/tool/checks/check_all_yaml.dart

@@ -4,7 +4,6 @@
 
 import 'dart:io';
 
-import 'package:analyzer/src/lint/io.dart';
 import 'package:analyzer/src/lint/registry.dart';
 import 'package:linter/src/rules.dart';
 import 'package:yaml/yaml.dart';
@@ -27,7 +26,7 @@ void main() {
 /// there are errors, and `null` otherwise.
 String? checkAllYaml() {
   var allYamlPath = pathRelativeToPackageRoot(['example', 'all.yaml']);
-  var src = readFile(allYamlPath);
+  var src = File(allYamlPath).readAsStringSync();
 
   var options = _getOptionsFromString(src);
   var linterSection = options['linter'] as YamlMap?;

pkg/linter/tool/lint_sets.dart

@@ -6,9 +6,10 @@ import 'dart:async';
 
 import 'package:analyzer/src/lint/config.dart';
 import 'package:http/http.dart' as http;
-import 'package:linter/src/utils.dart';
 import 'package:yaml/yaml.dart';
 
+import 'util/io.dart';
+
 Future<List<String>> get dartCoreLints =>
     _fetchRulesFromGitHub('/dart-lang/core/main/pkgs/lints/lib/core.yaml');
 

pkg/linter/tool/machine.dart

@@ -10,11 +10,11 @@ import 'package:analyzer/src/lint/registry.dart';
 import 'package:args/args.dart';
 import 'package:collection/collection.dart';
 import 'package:linter/src/rules.dart';
-import 'package:linter/src/utils.dart';
 import 'package:pub_semver/pub_semver.dart';
 import 'package:yaml/yaml.dart';
 
 import 'messages_info.dart';
+import 'util/io.dart';
 import 'util/path_utils.dart';
 
 /// Generates a list of built-in lint rules in JSON suitable for

pkg/linter/tool/messages_info.dart

@@ -2,8 +2,9 @@
 // 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:analyzer/analysis_rule/rule_state.dart';
-import 'package:analyzer/src/lint/io.dart';
 import 'package:collection/collection.dart';
 import 'package:pub_semver/pub_semver.dart';
 import 'package:yaml/yaml.dart';
@@ -39,7 +40,7 @@ const _stateNames = {
 };
 
 final Map<String, RuleInfo> messagesRuleInfo = () {
-  var messagesYaml = loadYamlNode(readFile(_messagesYamlPath));
+  var messagesYaml = loadYamlNode(File(_messagesYamlPath).readAsStringSync());
   if (messagesYaml is! YamlMap) {
     throw StateError("The '$_messagesFileName' file is not a YAML map.");
   }

pkg/linter/tool/test_linter.dart

@@ -14,11 +14,12 @@ import 'package:analyzer/instrumentation/instrumentation.dart';
 import 'package:analyzer/source/file_source.dart';
 import 'package:analyzer/src/dart/analysis/analysis_context_collection.dart';
 import 'package:analyzer/src/generated/engine.dart' show AnalysisEngine;
-import 'package:analyzer/src/lint/io.dart';
 import 'package:analyzer/src/lint/pub.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:path/path.dart' as path;
 
+import 'util/io.dart';
+
 class TestLinter implements DiagnosticListener {
   final errors = <Diagnostic>[];
 

pkg/linter/tool/util/io.dart

@@ -1,4 +1,4 @@
-// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file
+// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
 // 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.
 
@@ -10,5 +10,8 @@ StringSink errorSink = stderr;
 /// A shared sink for standard out reporting.
 StringSink outSink = stdout;
 
-/// Synchronously read the contents of the file at the given [path] as a string.
-String readFile(String path) => File(path).readAsStringSync();
+/// Write the given [object] to the console.
+/// Uses the shared [outSink] for redirecting in tests.
+void printToConsole(Object? object) {
+  outSink.writeln(object);
+}