Use package_root.dart for all analyzer_utilities-based codegen.

stereotype441 · Commit Queue · commit c30dd253a3f0 · 2025-07-02T17:42:14.000-07:00
All code generation logic that uses the analyzer_utilities package's `GeneratedContent` class hierarchy is modified to use `package:analyzer_testing/package_root.dart` to locate the `pkg` directory in the root of the SDK repo. This paves the way for some follow-up work in which I intend to modify the `GeneratedContent` class hierarchy so that it tracks the locations of all code generation targets relative to the `pkg` directory rather than the individual package directories. That in turn should make it easier for code generation logic to be shared between error messages belonging to `pkg/analyzer`, `pkg/front_end`, and `pkg/_fe_analyzer_shared`. Change-Id: Iee59e977e844261f46fb62ed4e222db79db45a25 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/438061 Auto-Submit: Paul Berry <paulberry@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Samuel Rawlins <srawlins@google.com>
diff --git a/pkg/analysis_server/integration_test/coverage_test.dart b/pkg/analysis_server/integration_test/coverage_test.dart
@@ -5,30 +5,21 @@
 import 'dart:io';
 
 import 'package:analyzer_plugin/src/utilities/string_utilities.dart';
+import 'package:analyzer_testing/package_root.dart' as pkg_root;
 import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 
-import '../tool/spec/api.dart';
 import '../tool/spec/from_html.dart';
 
 /// Define tests to fail if there's no mention in the coverage file.
 void main() {
-  Api api;
-  File coverageFile;
-  String pathPrefix;
-
   // parse the API file
-  if (FileSystemEntity.isFileSync(
-    path.join('tool', 'spec', 'spec_input.html'),
-  )) {
-    api = readApi('.');
-    pathPrefix = '.';
-  } else {
-    api = readApi(path.join('pkg', 'analysis_server'));
-    pathPrefix = path.join('pkg', 'analysis_server');
-  }
+  var pathPrefix = path.join(pkg_root.packageRoot, 'analysis_server');
+  var api = readApi(pathPrefix);
 
-  coverageFile = File(path.join(pathPrefix, 'integration_test', 'coverage.md'));
+  var coverageFile = File(
+    path.join(pathPrefix, 'integration_test', 'coverage.md'),
+  );
   var lines = coverageFile.readAsLinesSync();
 
   // ## server domain
diff --git a/pkg/analysis_server/tool/spec/check_all_test.dart b/pkg/analysis_server/tool/spec/check_all_test.dart
@@ -2,8 +2,7 @@
 // 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_testing/package_root.dart' as pkg_root;
 import 'package:analyzer_utilities/tools.dart';
 import 'package:path/path.dart';
 
@@ -12,10 +11,7 @@ import 'generate_all.dart';
 /// Check that all targets have been code generated.  If they haven't tell the
 /// user to run generate_all.dart.
 Future<void> main() async {
-  var script = Platform.script.toFilePath(windows: Platform.isWindows);
-  var components = split(script);
-  var index = components.indexOf('analysis_server');
-  var pkgPath = joinAll(components.sublist(0, index + 1));
+  var pkgPath = normalize(join(pkg_root.packageRoot, 'analysis_server'));
   await GeneratedContent.checkAll(
     pkgPath,
     join(pkgPath, 'tool', 'spec', 'generate_all.dart'),
diff --git a/pkg/analysis_server/tool/spec/generate_all.dart b/pkg/analysis_server/tool/spec/generate_all.dart
@@ -2,8 +2,7 @@
 // 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_testing/package_root.dart' as pkg_root;
 import 'package:analyzer_utilities/tools.dart';
 import 'package:path/path.dart';
 
@@ -19,8 +18,7 @@ import 'to_html.dart' as to_html;
 
 /// Generate all targets.
 Future<void> main() async {
-  var script = Platform.script.toFilePath(windows: Platform.isWindows);
-  var pkgPath = normalize(join(dirname(script), '..', '..'));
+  var pkgPath = normalize(join(pkg_root.packageRoot, 'analysis_server'));
   await GeneratedContent.generateAll(pkgPath, allTargets);
 }
 
diff --git a/pkg/analyzer/tool/experiments/experiments_test.dart b/pkg/analyzer/tool/experiments/experiments_test.dart
@@ -2,8 +2,7 @@
 // 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" show Platform;
-
+import 'package:analyzer_testing/package_root.dart' as pkg_root;
 import 'package:analyzer_utilities/tools.dart';
 import 'package:path/path.dart';
 
@@ -12,10 +11,7 @@ import 'generate.dart';
 /// Check that all targets have been code generated.  If they haven't tell the
 /// user to run `generate.dart`.
 void main() async {
-  String script = Platform.script.toFilePath(windows: Platform.isWindows);
-  List<String> components = split(script);
-  int index = components.indexOf('analyzer');
-  String pkgPath = joinAll(components.sublist(0, index + 1));
+  String pkgPath = normalize(join(pkg_root.packageRoot, 'analyzer'));
   await GeneratedContent.checkAll(
     pkgPath,
     join(pkgPath, 'tool', 'experiments', 'generate.dart'),
diff --git a/pkg/analyzer/tool/generate_files b/pkg/analyzer/tool/generate_files
@@ -43,4 +43,4 @@ VM_OPTIONS+=("--enable-asserts")
 
 cd "${SCRIPT_DIR}"
 "${DART}" "${VM_OPTIONS[@]}" "messages/generate.dart"
-"${DART}" "${VM_OPTIONS[@]}" "summary/generate.dart" "${ROOT_DIR}/pkg/analyzer/lib/src/summary/idl.dart"
+"${DART}" "${VM_OPTIONS[@]}" "summary/generate.dart"
diff --git a/pkg/analyzer/tool/summary/check_test.dart b/pkg/analyzer/tool/summary/check_test.dart
@@ -19,6 +19,5 @@ void main() async {
     idlFolderPath,
     'pkg/analyzer/tool/summary/generate.dart',
     getAllTargets(idlPath),
-    args: [idlPath],
   );
 }
diff --git a/pkg/analyzer/tool/summary/generate.dart b/pkg/analyzer/tool/summary/generate.dart
@@ -23,22 +23,19 @@ import 'dart:convert';
 import 'dart:io';
 
 import 'package:_fe_analyzer_shared/src/scanner/scanner.dart';
+import 'package:analyzer_testing/package_root.dart' as pkg_root;
 import 'package:analyzer_utilities/tools.dart';
+import 'package:path/path.dart';
 
 import 'idl_model.dart' as idl_model;
 import 'mini_ast.dart';
 
-void main(List<String> args) async {
-  if (args.length != 1) {
-    print('Error: IDL path is required');
-    print('usage: dart generate.dart path/to/idl.dart');
-    return;
-  }
-  String idlPath = args[0];
-  await GeneratedContent.generateAll(
-    File(idlPath).parent.path,
-    getAllTargets(idlPath),
+void main() async {
+  var idlFolderPath = normalize(
+    join(pkg_root.packageRoot, 'analyzer', 'lib', 'src', 'summary'),
   );
+  var idlPath = normalize(join(idlFolderPath, 'idl.dart'));
+  await GeneratedContent.generateAll(idlFolderPath, getAllTargets(idlPath));
 }
 
 List<GeneratedContent> getAllTargets(String idlPath) {
diff --git a/pkg/analyzer_plugin/tool/spec/check_all_test.dart b/pkg/analyzer_plugin/tool/spec/check_all_test.dart
@@ -2,8 +2,7 @@
 // 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_testing/package_root.dart' as pkg_root;
 import 'package:analyzer_utilities/tools.dart';
 import 'package:path/path.dart';
 
@@ -12,10 +11,7 @@ import 'generate_all.dart';
 /// Check that all targets have been code generated. If they haven't tell the
 /// user to run generate_all.dart.
 Future<void> main() async {
-  var script = Platform.script.toFilePath(windows: Platform.isWindows);
-  var components = split(script);
-  var index = components.indexOf('analyzer_plugin');
-  var pkgPath = joinAll(components.sublist(0, index + 1));
+  var pkgPath = normalize(join(pkg_root.packageRoot, 'analyzer_plugin'));
   await GeneratedContent.checkAll(
       pkgPath, join(pkgPath, 'tool', 'spec', 'generate_all.dart'), allTargets);
 }
diff --git a/pkg/analyzer_plugin/tool/spec/generate_all.dart b/pkg/analyzer_plugin/tool/spec/generate_all.dart
@@ -2,8 +2,7 @@
 // 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_testing/package_root.dart' as pkg_root;
 import 'package:analyzer_utilities/tools.dart';
 import 'package:path/path.dart';
 
@@ -16,8 +15,7 @@ import 'to_html.dart' as to_html;
 
 /// Generate all targets.
 Future<void> main() async {
-  var script = Platform.script.toFilePath(windows: Platform.isWindows);
-  var pkgPath = normalize(join(dirname(script), '..', '..'));
+  var pkgPath = normalize(join(pkg_root.packageRoot, 'analyzer_plugin'));
   await GeneratedContent.generateAll(pkgPath, allTargets);
 }
 
diff --git a/pkg/analyzer_utilities/lib/tools.dart b/pkg/analyzer_utilities/lib/tools.dart
@@ -307,9 +307,8 @@ abstract class GeneratedContent {
   static Future<void> checkAll(
     String pkgPath,
     String generatorPath,
-    Iterable<GeneratedContent> targets, {
-    List<String> args = const [],
-  }) async {
+    Iterable<GeneratedContent> targets,
+  ) async {
     var generateNeeded = false;
     for (var target in targets) {
       var ok = await target.check(pkgPath);
@@ -325,7 +324,7 @@ abstract class GeneratedContent {
       print('Please regenerate using:');
       var executable = Platform.executable;
       var generateScript = normalize(joinAll(posix.split(generatorPath)));
-      print('  $executable $generateScript ${args.join(" ")}');
+      print('  $executable $generateScript');
       fail('Generated content needs to be regenerated');
     }
   }
diff --git a/pkg/linter/tool/generate_lints.dart b/pkg/linter/tool/generate_lints.dart
@@ -19,6 +19,10 @@ void main() async {
   ]);
 }
 
+const String generatedCodesPath = 'lib/src/lint_codes.g.dart';
+
+const String generatedNamesPath = 'lib/src/lint_names.g.dart';
+
 GeneratedFile get generatedCodesFile =>
     GeneratedFile(generatedCodesPath, (String pkgPath) async {
       var out = StringBuffer('''
@@ -96,9 +100,6 @@ class LinterLintCode extends LintCode {
       return out.toString();
     });
 
-String get generatedCodesPath =>
-    pathRelativeToPackageRoot(const ['lib', 'src', 'lint_codes.g.dart']);
-
 GeneratedFile get generatedNamesFile =>
     GeneratedFile(generatedNamesPath, (String pkgPath) async {
       var out = StringBuffer('''
@@ -127,6 +128,3 @@ abstract final class LintNames {
       out.writeln('}');
       return out.toString();
     });
-
-String get generatedNamesPath =>
-    pathRelativeToPackageRoot(const ['lib', 'src', 'lint_names.g.dart']);
diff --git a/pkg/linter/tool/util/path_utils.dart b/pkg/linter/tool/util/path_utils.dart
@@ -2,39 +2,15 @@
 // 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 'dart:isolate';
-
+import 'package:analyzer_testing/package_root.dart' as pkg_root;
 import 'package:path/path.dart' as path;
 
-String get linterPackageRoot => path.joinAll(_packageRoot);
-
-List<String> get _packageRoot {
-  // Locate the root of the package without using `Platform.script` as it fails
-  // when run through the `dart test`.
-  // https://github.com/dart-lang/test/issues/110
-  var packageLibUri = Isolate.resolvePackageUriSync(
-    Uri.parse('package:linter/'),
-  );
-
-  var parts = path.split(path.dirname(packageLibUri!.toFilePath()));
-  while (parts.last != 'linter') {
-    parts.removeLast();
-    if (parts.isEmpty) {
-      throw StateError(
-        "Script is not located inside a 'linter' directory? "
-        "'${Platform.script.path}'",
-      );
-    }
-  }
-  return parts;
-}
+final String linterPackageRoot = path.normalize(
+  path.join(pkg_root.packageRoot, 'linter'),
+);
 
 String pathRelativeToPackageRoot(Iterable<String> parts) =>
-    path.joinAll([..._packageRoot, ...parts]);
+    path.joinAll([linterPackageRoot, ...parts]);
 
-String pathRelativeToPkgDir(Iterable<String> parts) {
-  var pathParts = _packageRoot;
-  pathParts.replaceRange(pathParts.length - 1, pathParts.length, parts);
-  return path.joinAll(pathParts);
-}
+String pathRelativeToPkgDir(Iterable<String> parts) =>
+    path.joinAll([pkg_root.packageRoot, ...parts]);

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,5 @@ void main() async {`
`19`	`19`	`idlFolderPath,`
`20`	`20`	`'pkg/analyzer/tool/summary/generate.dart',`
`21`	`21`	`getAllTargets(idlPath),`
`22`		`- args: [idlPath],`
`23`	`22`	`);`
`24`	`23`	`}`