Added a description and link to documentation in the `devtools_option…

…s.yaml` file. (#7052)
flutter · Jan 19, 2024 · 34495f8 · 34495f8
1 parent 154dda9
commit 34495f8
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md b/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md
@@ -11,7 +11,7 @@ To learn more about DevTools, check out the
 ## General updates
 
 * Improved overall usability by making the DevTools UI more dense. This
-significantly improves the user experience when using DevTools embedded
+significantly improves the user experience when using DevTools embedded in
 an IDE. (#7030)[https://github.com/flutter/devtools/pull/7030]
 * Added support for filtering with regular expressions in the Logging, Network, and CPU profiler
 pages - (#7027)[https://github.com/flutter/devtools/pull/7027]
@@ -61,7 +61,8 @@ TODO: Remove this section if there are not any general updates.
 
 ## DevTools Extension updates
 
-* Fixed a couple bugs preventing Dart server apps from connecting to DevTools extensions. - [#6982](https://github.com/flutter/devtools/pull/6982), [#6993](https://github.com/flutter/devtools/pull/6993)
+* Added a description and link to documentation to the `devtools_options.yaml` file
+that is created in a user's project. - [#7052](https://github.com/flutter/devtools/pull/7052)
 
 ## Full commit history
 

diff --git a/packages/devtools_shared/CHANGELOG.md b/packages/devtools_shared/CHANGELOG.md
@@ -1,5 +1,7 @@
 # 6.0.4
 * Add `apiGetDtdUri` to the server api.
+* Add a description and link to documentation to the `devtools_options.yaml` file that
+is created in a user's project.
 
 # 6.0.3
 * `CompareMixin` is now generic, implementing `Comparable<T>` instead of

diff --git a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart
@@ -14,10 +14,12 @@ import 'extension_model.dart';
 /// Manages the `devtools_options.yaml` file and allows read / write access.
 class DevToolsOptions {
   static const optionsFileName = 'devtools_options.yaml';
-
   static const _extensionsKey = 'extensions';
-
+  static const _descriptionKey = 'description';
+  static const _documentationKey = 'documentation';
   static const _defaultOptions = '''
+$_descriptionKey: This file stores settings for Dart & Flutter DevTools.
+$_documentationKey: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states
 $_extensionsKey:
 ''';
 

diff --git a/packages/devtools_shared/test/extensions/extension_enablement_test.dart b/packages/devtools_shared/test/extensions/extension_enablement_test.dart
@@ -44,6 +44,8 @@ void main() {
       expect(
         file.readAsStringSync(),
         '''
+description: This file stores settings for Dart & Flutter DevTools.
+documentation: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states
 extensions:
 ''',
       );
@@ -59,6 +61,8 @@ extensions:
       expect(
         file.readAsStringSync(),
         '''
+description: This file stores settings for Dart & Flutter DevTools.
+documentation: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states
 extensions:
   - foo: true''',
       );
@@ -79,6 +83,8 @@ extensions:
       expect(
         file.readAsStringSync(),
         '''
+description: This file stores settings for Dart & Flutter DevTools.
+documentation: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states
 extensions:
   - foo: true
   - bar: false''',