Add a devtools extensions example for using DTD (flutter#7752)

kenzieschmoll · May 14, 2024 · 39a924c · 39a924c
1 parent 7a5758f
commit 39a924c
Show file tree

Hide file tree

Showing 12 changed files with 423 additions and 54 deletions.
diff --git a/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md b/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md
@@ -59,6 +59,9 @@ TODO: Remove this section if there are not any general updates.
 tests. - [#7717](https://github.com/flutter/devtools/pull/7717)
 * Fix an issue with detecting extensions for nested Dart or Flutter
 projects. - [#7742](https://github.com/flutter/devtools/pull/7742)
+* Add an example to `package:devtools_extensions` that shows how to
+interact with the Dart Tooling Daemon from a DevTools
+extension. - [#7752](https://github.com/flutter/devtools/pull/7752)
 
 ## Full commit history
 

diff --git a/packages/devtools_extensions/CHANGELOG.md b/packages/devtools_extensions/CHANGELOG.md
@@ -8,6 +8,7 @@
 * Add an example of a standalone extension.
 * Add examples of Dart and Flutter tests that can be ran and connected to
 available DevTools extensions.
+* Add an example of interacting with the Dart Tooling Daemon from a DevTools extension.
 
 ## 0.1.1
 * Update the simulated environment help dialogs with information about the

diff --git a/packages/devtools_extensions/example/app_that_uses_foo/test/flutter_test_1.dart b/packages/devtools_extensions/example/app_that_uses_foo/test/flutter_test_1.dart
@@ -19,7 +19,6 @@ import 'package:foo/foo.dart';
 //
 // flutter test test/ --start-paused
 
-
 void main() {
   testWidgets('Builds $MyAppThatUsesFoo', (tester) async {
     await tester.pumpWidget(const MyAppThatUsesFoo());

diff --git a/...ample/packages_with_extensions/foo/packages/foo_devtools_extension/lib/src/common/ui.dart b/...ample/packages_with_extensions/foo/packages/foo_devtools_extension/lib/src/common/ui.dart
@@ -0,0 +1,41 @@
+// Copyright 2024 The Chromium Authors. 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:flutter/material.dart';
+
+/// Header widget for each example section.
+class SectionHeader extends StatelessWidget {
+  const SectionHeader({
+    required this.number,
+    required this.title,
+    this.requirements,
+    super.key,
+  });
+
+  final int number;
+  final String title;
+  final String? requirements;
+
+  @override
+  Widget build(BuildContext context) {
+    final theme = Theme.of(context);
+    return Column(
+      mainAxisSize: MainAxisSize.min,
+      crossAxisAlignment: CrossAxisAlignment.start,
+      children: [
+        Text(
+          '$number. $title',
+          style: theme.textTheme.titleMedium,
+        ),
+        if (requirements != null)
+          Text(
+            requirements!,
+            style: theme.textTheme.titleSmall!.copyWith(
+              color: theme.colorScheme.tertiary,
+            ),
+          ),
+      ],
+    );
+  }
+}
diff --git a/...nsion/lib/src/devtools_event_example.dart → ...ture_examples/devtools_event_example.dart b/...nsion/lib/src/devtools_event_example.dart → ...ture_examples/devtools_event_example.dart
@@ -2,7 +2,6 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import 'package:devtools_app_shared/ui.dart';
 import 'package:devtools_extensions/api.dart';
 import 'package:devtools_extensions/devtools_extensions.dart';
 import 'package:flutter/material.dart';
@@ -45,17 +44,6 @@ class _ListeningForDevToolsEventExampleState
 
   @override
   Widget build(BuildContext context) {
-    return Column(
-      mainAxisSize: MainAxisSize.min,
-      crossAxisAlignment: CrossAxisAlignment.start,
-      children: [
-        Text(
-          '3. Example of listening for a DevTools event',
-          style: Theme.of(context).textTheme.titleMedium,
-        ),
-        const PaddedDivider.thin(),
-        Text('Received an unknown event from DevTools: $message'),
-      ],
-    );
+    return Text('Received an unknown event from DevTools: $message');
   }
 }
diff --git a/...b/src/devtools_extension_api_example.dart → ...mples/devtools_extension_api_example.dart b/...b/src/devtools_extension_api_example.dart → ...mples/devtools_extension_api_example.dart
@@ -2,7 +2,6 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-import 'package:devtools_app_shared/ui.dart';
 import 'package:devtools_extensions/api.dart';
 import 'package:devtools_extensions/devtools_extensions.dart';
 import 'package:flutter/material.dart';
@@ -26,11 +25,6 @@ class CallingDevToolsExtensionsAPIsExample extends StatelessWidget {
       mainAxisSize: MainAxisSize.min,
       crossAxisAlignment: CrossAxisAlignment.start,
       children: [
-        Text(
-          '4. Example of calling DevTools extension APIs',
-          style: Theme.of(context).textTheme.titleMedium,
-        ),
-        const PaddedDivider.thin(),
         ElevatedButton(
           onPressed: () => extensionManager.postMessageToDevTools(
             DevToolsExtensionEvent(