Migrate DevTools to use pub workspaces (#8549)

flutter · Nov 27, 2024 · e1ead3d · e1ead3d
1 parent db3597d
commit e1ead3d
Show file tree

Hide file tree

Showing 49 changed files with 199 additions and 189 deletions.
diff --git a/packages/.vscode/extensions.json → .vscode/extensions.json b/packages/.vscode/extensions.json → .vscode/extensions.json
diff --git a/packages/.vscode/launch.json → .vscode/launch.json b/packages/.vscode/launch.json → .vscode/launch.json
@@ -6,21 +6,21 @@
     "configurations": [
         {
             "name": "opened test or devtools",
-            "cwd": "devtools_app",
+            "cwd": "packages/devtools_app",
             "request": "launch",
             "type": "dart",
         },
         {
             "name": "devtools",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/lib/main.dart",
+            "program": "packages/devtools_app/lib/main.dart",
         },
         {
             "name": "devtools + experiments",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/lib/main.dart",
+            "program": "packages/devtools_app/lib/main.dart",
             "args": [
                 "--dart-define",
                 "memory_disconnect_experience=true",
@@ -32,21 +32,21 @@
             "name": "devtools + profile",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/lib/main.dart",
+            "program": "packages/devtools_app/lib/main.dart",
             "flutterMode": "profile",
         },
         {
             "name": "devtools + release",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/lib/main.dart",
+            "program": "packages/devtools_app/lib/main.dart",
             "flutterMode": "release",
         },
         {
             "name": "devtools + profile + experiments",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/lib/main.dart",
+            "program": "packages/devtools_app/lib/main.dart",
             "flutterMode": "profile",
             "args": [
                 "--dart-define=enable_experiments=true"
@@ -56,50 +56,50 @@
             "name": "devtools + release",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/lib/main.dart",
+            "program": "packages/devtools_app/lib/main.dart",
             "flutterMode": "release",
         },
         {
             "name": "memory/default",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/test/test_infra/scenes/memory/default.stager_app.g.dart",
+            "program": "packages/devtools_app/test/test_infra/scenes/memory/default.stager_app.g.dart",
         },
         {
             "name": "memory/diff_snapshot",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/test/test_infra/scenes/memory/diff_snapshot.stager_app.g.dart",
+            "program": "packages/devtools_app/test/test_infra/scenes/memory/diff_snapshot.stager_app.g.dart",
         },
         {
             "name": "performance/default",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/test/test_infra/scenes/performance/default.stager_app.g.dart",
+            "program": "packages/devtools_app/test/test_infra/scenes/performance/default.stager_app.g.dart",
         },
         {
             "name": "profiler/default",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/test/test_infra/scenes/cpu_profiler/default.stager_app.g.dart",
+            "program": "packages/devtools_app/test/test_infra/scenes/cpu_profiler/default.stager_app.g.dart",
         },
         {
             "name": "fixtures/flutter_app",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/test/test_infra/fixtures/flutter_app/lib/main.dart",
+            "program": "packages/devtools_app/test/test_infra/fixtures/flutter_app/lib/main.dart",
         },
         {
             "name": "fixtures/memory_app",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/test/test_infra/fixtures/memory_app/lib/main.dart",
+            "program": "packages/devtools_app/test/test_infra/fixtures/memory_app/lib/main.dart",
         },
         {
             "name": "standalone_ui/editor_sidebar",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_app/test/test_infra/scenes/standalone_ui/editor_sidebar.stager_app.g.dart",
+            "program": "packages/devtools_app/test/test_infra/scenes/standalone_ui/editor_sidebar.stager_app.g.dart",
             "preLaunchTask": "Start DTD on Port 8500",
         },
         {
@@ -116,7 +116,7 @@
             "name": "devtools_extensions: foo + sim",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_extensions/example/packages_with_extensions/foo/packages/foo_devtools_extension/lib/main.dart",
+            "program": "packages/devtools_extensions/example/packages_with_extensions/foo/packages/foo_devtools_extension/lib/main.dart",
             "args": [
                 "--dart-define=use_simulated_environment=true"
             ],
@@ -125,7 +125,7 @@
             "name": "devtools_extensions: dart_foo + sim",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_extensions/example/packages_with_extensions/dart_foo/packages/dart_foo_devtools_extension/lib/main.dart",
+            "program": "packages/devtools_extensions/example/packages_with_extensions/dart_foo/packages/dart_foo_devtools_extension/lib/main.dart",
             "args": [
                 "--dart-define=use_simulated_environment=true"
             ],
@@ -134,13 +134,13 @@
             "name": "devtools_extensions: app_that_uses_foo",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_extensions/example/app_that_uses_foo/lib/main.dart",
+            "program": "packages/devtools_extensions/example/app_that_uses_foo/lib/main.dart",
         },
         {
             "name": "devtools_extensions: app_that_uses_foo - bin",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_extensions/example/app_that_uses_foo/bin/script.dart",
+            "program": "packages/devtools_extensions/example/app_that_uses_foo/bin/script.dart",
         },
         {
             "name": "attach",
@@ -151,7 +151,7 @@
             "name": "foo_devtools_extension example + simulated environment",
             "request": "launch",
             "type": "dart",
-            "program": "devtools_extensions/example/foo/packages/foo_devtools_extension/lib/main.dart",
+            "program": "packages/devtools_extensions/example/foo/packages/foo_devtools_extension/lib/main.dart",
             "args": [
                 "--dart-define=use_simulated_environment=true"
             ],

diff --git a/packages/.vscode/settings.json → .vscode/settings.json b/packages/.vscode/settings.json → .vscode/settings.json
diff --git a/packages/.vscode/tasks.json → .vscode/tasks.json b/packages/.vscode/tasks.json → .vscode/tasks.json
diff --git a/packages/analysis_options.yaml → analysis_options.yaml b/packages/analysis_options.yaml → analysis_options.yaml
@@ -12,9 +12,9 @@ analyzer:
     # treat missing required parameters as a warning (not a hint)
     missing_required_param: warning
   exclude:
-    - build/**
+    - '**/build/**'
     - '**.freezed.dart'
-    - flutter-sdk/
+    - tool/flutter-sdk/
 
 linter:
   rules:
@@ -85,7 +85,6 @@ linter:
     # - one_member_abstracts # too many false positives
     # - only_throw_errors # https://github.com/flutter/flutter/issues/5792
     - overridden_fields
-    - package_api_docs
     - package_names
     - package_prefixed_library_names
     # - parameter_assignments # we do this commonly

diff --git a/case_study/code_size/optimized/code_size_images/lib/animals.dart b/case_study/code_size/optimized/code_size_images/lib/animals.dart
@@ -1,6 +1,8 @@
 import 'package:flutter/material.dart';
 
 class Animals extends StatelessWidget {
+  const Animals({super.key});
+
   @override
   Widget build(BuildContext context) {
     return ListView(

diff --git a/case_study/code_size/optimized/code_size_images/lib/main.dart b/case_study/code_size/optimized/code_size_images/lib/main.dart
@@ -3,10 +3,12 @@ import 'package:flutter/material.dart';
 import 'animals.dart';
 
 void main() {
-  runApp(MyApp());
+  runApp(const MyApp());
 }
 
 class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
   // This widget is the root of your application.
   @override
   Widget build(BuildContext context) {
@@ -22,7 +24,7 @@ class MyApp extends StatelessWidget {
 }
 
 class MyHomePage extends StatefulWidget {
-  const MyHomePage({Key? key}) : super(key: key);
+  const MyHomePage({super.key});
 
   @override
   State<MyHomePage> createState() => _MyHomePageState();
@@ -35,7 +37,7 @@ class _MyHomePageState extends State<MyHomePage> {
       appBar: AppBar(
         title: const Text('Code Size Demo'),
       ),
-      body: Center(
+      body: const Center(
         child: Animals(),
       ),
     );

diff --git a/case_study/code_size/optimized/code_size_images/test/widget_test.dart b/case_study/code_size/optimized/code_size_images/test/widget_test.dart
@@ -12,7 +12,7 @@ import 'package:flutter_test/flutter_test.dart';
 void main() {
   testWidgets('Counter increments smoke test', (WidgetTester tester) async {
     // Build our app and trigger a frame.
-    await tester.pumpWidget(MyApp());
+    await tester.pumpWidget(const MyApp());
 
     // Verify that our counter starts at 0.
     expect(find.text('0'), findsOneWidget);

diff --git a/case_study/code_size/optimized/code_size_package/lib/main.dart b/case_study/code_size/optimized/code_size_package/lib/main.dart
@@ -5,10 +5,12 @@ import 'package:flutter/material.dart';
 import 'package:steel_crypt/steel_crypt.dart' as encrypt;
 
 void main() {
-  runApp(MyApp());
+  runApp(const MyApp());
 }
 
 class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
@@ -22,7 +24,7 @@ class MyApp extends StatelessWidget {
 }
 
 class MyHomePage extends StatefulWidget {
-  const MyHomePage({Key? key, required this.title}) : super(key: key);
+  const MyHomePage({super.key, required this.title});
 
   final String title;
 

diff --git a/case_study/code_size/optimized/code_size_package/test/widget_test.dart b/case_study/code_size/optimized/code_size_package/test/widget_test.dart
@@ -12,7 +12,7 @@ import 'package:flutter_test/flutter_test.dart';
 void main() {
   testWidgets('Counter increments smoke test', (WidgetTester tester) async {
     // Build our app and trigger a frame.
-    await tester.pumpWidget(MyApp());
+    await tester.pumpWidget(const MyApp());
 
     // Verify that our counter starts at 0.
     expect(find.text('0'), findsOneWidget);

diff --git a/case_study/code_size/unoptimized/code_size_images/lib/animals.dart b/case_study/code_size/unoptimized/code_size_images/lib/animals.dart
@@ -1,6 +1,8 @@
 import 'package:flutter/material.dart';
 
 class Animals extends StatelessWidget {
+  const Animals({super.key});
+
   @override
   Widget build(BuildContext context) {
     return ListView(

diff --git a/case_study/code_size/unoptimized/code_size_images/lib/main.dart b/case_study/code_size/unoptimized/code_size_images/lib/main.dart
@@ -3,10 +3,12 @@ import 'package:flutter/material.dart';
 import 'animals.dart';
 
 void main() {
-  runApp(MyApp());
+  runApp(const MyApp());
 }
 
 class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
   // This widget is the root of your application.
   @override
   Widget build(BuildContext context) {
@@ -22,7 +24,7 @@ class MyApp extends StatelessWidget {
 }
 
 class MyHomePage extends StatefulWidget {
-  const MyHomePage({Key? key}) : super(key: key);
+  const MyHomePage({super.key});
 
   @override
   State<MyHomePage> createState() => _MyHomePageState();
@@ -35,7 +37,7 @@ class _MyHomePageState extends State<MyHomePage> {
       appBar: AppBar(
         title: const Text('Code Size Demo'),
       ),
-      body: Center(
+      body: const Center(
         child: Animals(),
       ),
     );

diff --git a/case_study/code_size/unoptimized/code_size_images/test/widget_test.dart b/case_study/code_size/unoptimized/code_size_images/test/widget_test.dart
@@ -12,7 +12,7 @@ import 'package:flutter_test/flutter_test.dart';
 void main() {
   testWidgets('Counter increments smoke test', (WidgetTester tester) async {
     // Build our app and trigger a frame.
-    await tester.pumpWidget(MyApp());
+    await tester.pumpWidget(const MyApp());
 
     // Verify that our counter starts at 0.
     expect(find.text('0'), findsOneWidget);

diff --git a/case_study/code_size/unoptimized/code_size_package/lib/main.dart b/case_study/code_size/unoptimized/code_size_package/lib/main.dart
@@ -2,10 +2,12 @@ import 'package:encrypt/encrypt.dart' as encrypt;
 import 'package:flutter/material.dart';
 
 void main() {
-  runApp(MyApp());
+  runApp(const MyApp());
 }
 
 class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
@@ -19,7 +21,7 @@ class MyApp extends StatelessWidget {
 }
 
 class MyHomePage extends StatefulWidget {
-  const MyHomePage({Key? key, required this.title}) : super(key: key);
+  const MyHomePage({super.key, required this.title});
 
   final String title;
 

diff --git a/case_study/code_size/unoptimized/code_size_package/test/widget_test.dart b/case_study/code_size/unoptimized/code_size_package/test/widget_test.dart
@@ -12,7 +12,7 @@ import 'package:flutter_test/flutter_test.dart';
 void main() {
   testWidgets('Counter increments smoke test', (WidgetTester tester) async {
     // Build our app and trigger a frame.
-    await tester.pumpWidget(MyApp());
+    await tester.pumpWidget(const MyApp());
 
     // Verify that our counter starts at 0.
     expect(find.text('0'), findsOneWidget);

diff --git a/case_study/memory_leaks/memory_leak_app/lib/about.dart b/case_study/memory_leaks/memory_leak_app/lib/about.dart
@@ -7,13 +7,16 @@ import 'package:flutter/material.dart';
 import 'common.dart';
 
 class About extends StatefulWidget {
+  // ignore: prefer_const_constructors_in_immutables, intentional example code.
+  About({super.key});
+
   @override
   State<About> createState() => AboutState();
 }
 
 class AboutState extends State<About> {
-  static const String heading = '$aboutMenu\n\n';
-  static const String helpText = '''
+  static const heading = '$aboutMenu\n\n';
+  static const helpText = '''
 This application makes Restful HTTP GET
 requests to three different Restful servers.
 Selecting a request e.g., Weather will
@@ -23,13 +26,13 @@ page to select another Restful request.
 
 The menu, on the main page, has options:
 ''';
-  static const String logOption = '\n    $logMenu';
-  static const String aboutOption = '\n    $aboutMenu';
+  static const logOption = '\n    $logMenu';
+  static const aboutOption = '\n    $aboutMenu';
 
-  static const String logDescr = ' display all messages.';
-  static const String aboutDescr = ' display this page.';
+  static const logDescr = ' display all messages.';
+  static const aboutDescr = ' display this page.';
 
-  final TextStyle defaultStyle = const TextStyle(
+  final defaultStyle = const TextStyle(
     fontSize: 20,
     color: Colors.blueGrey,
   );

diff --git a/case_study/memory_leaks/memory_leak_app/lib/main.dart b/case_study/memory_leaks/memory_leak_app/lib/main.dart
@@ -16,7 +16,7 @@ void main() {
   Logging.logging.add('Starting...');
 
   runApp(
-    MaterialApp(
+    const MaterialApp(
       // Title
       title: appName,
       // Home
@@ -26,6 +26,8 @@ void main() {
 }
 
 class MyHome extends StatefulWidget {
+  const MyHome({super.key});
+
   @override
   State<MyHome> createState() => MyHomeState();
 }
@@ -101,6 +103,7 @@ class MyHomeState extends State<MyHome> with SingleTickerProviderStateMixin {
         );
         break;
       default:
+        // ignore: avoid_print, fine for example app.
         print('ERROR: Unhandled Menu.');
     }
   }