From bfa46cd6aa5534ad0307b9da2ba5333ffc9496d8 Mon Sep 17 00:00:00 2001 From: Kenzie Schmoll Date: Wed, 17 Jan 2024 09:57:51 -0800 Subject: [PATCH 01/10] Add explanatory comment to `devtools_options.yaml` file. --- .../lib/src/extensions/extension_enablement.dart | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart index a3b69bb9bcd..18b1375eecc 100644 --- a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart +++ b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart @@ -18,6 +18,15 @@ class DevToolsOptions { static const _extensionsKey = 'extensions'; static const _defaultOptions = ''' +# This file stores per-project (or optionally, per user) settings for Dart & +# Flutter DevTools (e.g. DevTools extension enabled states, etc.). +# +# If this file is checked into source control, the options here will be applied +# for anyone who pulls your source code and contributes to your project. If this +# file is omitted from source control (e.g. adding an entry to your `.gitignore` +# file), then the `devtools_options.yaml` file will be configured per user, +# since each user or contributor to your project will be able to have their own +# copy of the file. $_extensionsKey: '''; From 5e35068e468f5a06fc24dc9e163d6c66a089dfe1 Mon Sep 17 00:00:00 2001 From: Kenzie Schmoll Date: Wed, 17 Jan 2024 09:59:13 -0800 Subject: [PATCH 02/10] changelog and version bump --- packages/devtools_shared/CHANGELOG.md | 3 +++ packages/devtools_shared/pubspec.yaml | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/devtools_shared/CHANGELOG.md b/packages/devtools_shared/CHANGELOG.md index 73316ed3633..de33ef4c728 100644 --- a/packages/devtools_shared/CHANGELOG.md +++ b/packages/devtools_shared/CHANGELOG.md @@ -1,3 +1,6 @@ +# 6.0.4-wip +* Add explanatory comment to `devtools_options.yaml` file by default. + # 6.0.3 * `CompareMixin` is now generic, implementing `Comparable` instead of `Comparable`, and it's operators each therefore accept a `T` diff --git a/packages/devtools_shared/pubspec.yaml b/packages/devtools_shared/pubspec.yaml index 54ff6616b81..616d6209a07 100644 --- a/packages/devtools_shared/pubspec.yaml +++ b/packages/devtools_shared/pubspec.yaml @@ -1,7 +1,7 @@ name: devtools_shared description: Package of shared Dart structures between devtools_app, dds, and other tools. -version: 6.0.3 +version: 6.0.4-wip repository: https://github.com/flutter/devtools/tree/master/packages/devtools_shared From f8245c7c778a1091e5d63c7e2c3eb44557e08b09 Mon Sep 17 00:00:00 2001 From: Kenzie Schmoll Date: Wed, 17 Jan 2024 10:29:09 -0800 Subject: [PATCH 03/10] rnotes --- packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md b/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md index fd3001adc8e..74c391390fb 100644 --- a/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md +++ b/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md @@ -60,7 +60,7 @@ 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 an explanatory comment to the `devtools_options.yaml` file on its initial creation. - [#7052](https://github.com/flutter/devtools/pull/7052) ## Full commit history From 9890a4b6dc04d3c845676fb1b7a7e14582ece382 Mon Sep 17 00:00:00 2001 From: Kenzie Schmoll Date: Wed, 17 Jan 2024 10:29:23 -0800 Subject: [PATCH 04/10] fix notes --- packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md b/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md index 74c391390fb..d862b369be6 100644 --- 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] From d53fd657504691e72b6253c669fe04854262e483 Mon Sep 17 00:00:00 2001 From: Kenzie Schmoll Date: Wed, 17 Jan 2024 11:54:55 -0800 Subject: [PATCH 05/10] fix --- .../lib/src/extensions/extension_enablement.dart | 15 ++++----------- .../extensions/extension_enablement_test.dart | 6 ++++++ 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart index 18b1375eecc..6a844a5aca1 100644 --- a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart +++ b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart @@ -14,19 +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 = ''' -# This file stores per-project (or optionally, per user) settings for Dart & -# Flutter DevTools (e.g. DevTools extension enabled states, etc.). -# -# If this file is checked into source control, the options here will be applied -# for anyone who pulls your source code and contributes to your project. If this -# file is omitted from source control (e.g. adding an entry to your `.gitignore` -# file), then the `devtools_options.yaml` file will be configured per user, -# since each user or contributor to your project will be able to have their own -# copy of the file. +$_descriptionKey: This file stores settings for Dart & Flutter DevTools. +$_documentationKey: https://docs.flutter.dev/tools/devtools/extensions#devtools_options.yaml. $_extensionsKey: '''; diff --git a/packages/devtools_shared/test/extensions/extension_enablement_test.dart b/packages/devtools_shared/test/extensions/extension_enablement_test.dart index c370ce1690a..05a905ae5e4 100644 --- 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#devtools_options.yaml. 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#devtools_options.yaml. 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#devtools_options.yaml. extensions: - foo: true - bar: false''', From 70066e6d986387ed20f4eb9576ff8ee5647fb54c Mon Sep 17 00:00:00 2001 From: Kenzie Schmoll Date: Wed, 17 Jan 2024 11:56:43 -0800 Subject: [PATCH 06/10] release notes --- packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md b/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md index d862b369be6..9586127369c 100644 --- a/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md +++ b/packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md @@ -60,7 +60,8 @@ TODO: Remove this section if there are not any general updates. ## DevTools Extension updates -* Added an explanatory comment to the `devtools_options.yaml` file on its initial creation. - [#7052](https://github.com/flutter/devtools/pull/7052) +* 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 From 62da6f4b7edf552a07353c60e93a88ffbe6bc823 Mon Sep 17 00:00:00 2001 From: Kenzie Schmoll Date: Wed, 17 Jan 2024 11:58:01 -0800 Subject: [PATCH 07/10] changelog --- packages/devtools_shared/CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/devtools_shared/CHANGELOG.md b/packages/devtools_shared/CHANGELOG.md index de33ef4c728..7b624483d9d 100644 --- a/packages/devtools_shared/CHANGELOG.md +++ b/packages/devtools_shared/CHANGELOG.md @@ -1,5 +1,6 @@ # 6.0.4-wip -* Add explanatory comment to `devtools_options.yaml` file by default. +* 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` instead of From 3eb7361c7d960032992cef12cf0e596f31bdca4c Mon Sep 17 00:00:00 2001 From: Kenzie Schmoll Date: Wed, 17 Jan 2024 11:59:15 -0800 Subject: [PATCH 08/10] fix test --- .../lib/src/extensions/extension_enablement.dart | 2 +- .../test/extensions/extension_enablement_test.dart | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart index 6a844a5aca1..aa2bc7764de 100644 --- a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart +++ b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart @@ -19,7 +19,7 @@ class DevToolsOptions { static const _documentationKey = 'documentation'; static const _defaultOptions = ''' $_descriptionKey: This file stores settings for Dart & Flutter DevTools. -$_documentationKey: https://docs.flutter.dev/tools/devtools/extensions#devtools_options.yaml. +$_documentationKey: https://docs.flutter.dev/tools/devtools/extensions#devtools_optionsyaml. $_extensionsKey: '''; diff --git a/packages/devtools_shared/test/extensions/extension_enablement_test.dart b/packages/devtools_shared/test/extensions/extension_enablement_test.dart index 05a905ae5e4..c31b90b6079 100644 --- a/packages/devtools_shared/test/extensions/extension_enablement_test.dart +++ b/packages/devtools_shared/test/extensions/extension_enablement_test.dart @@ -45,7 +45,7 @@ void main() { file.readAsStringSync(), ''' description: This file stores settings for Dart & Flutter DevTools. -documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_options.yaml. +documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_optionsyaml. extensions: ''', ); @@ -62,7 +62,7 @@ extensions: file.readAsStringSync(), ''' description: This file stores settings for Dart & Flutter DevTools. -documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_options.yaml. +documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_optionsyaml. extensions: - foo: true''', ); @@ -84,7 +84,7 @@ extensions: file.readAsStringSync(), ''' description: This file stores settings for Dart & Flutter DevTools. -documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_options.yaml. +documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_optionsyaml. extensions: - foo: true - bar: false''', From fe193f11069bd4c24ba5609a96e2efea8a260a1d Mon Sep 17 00:00:00 2001 From: Kenzie Davisson <43759233+kenzieschmoll@users.noreply.github.com> Date: Thu, 18 Jan 2024 15:30:11 -0800 Subject: [PATCH 09/10] Update extension_enablement.dart --- .../lib/src/extensions/extension_enablement.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart index aa2bc7764de..721f78137b6 100644 --- a/packages/devtools_shared/lib/src/extensions/extension_enablement.dart +++ b/packages/devtools_shared/lib/src/extensions/extension_enablement.dart @@ -19,7 +19,7 @@ class DevToolsOptions { static const _documentationKey = 'documentation'; static const _defaultOptions = ''' $_descriptionKey: This file stores settings for Dart & Flutter DevTools. -$_documentationKey: https://docs.flutter.dev/tools/devtools/extensions#devtools_optionsyaml. +$_documentationKey: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states $_extensionsKey: '''; From a2268a5b8894324067007e626505aa683d6f4b4b Mon Sep 17 00:00:00 2001 From: Kenzie Davisson <43759233+kenzieschmoll@users.noreply.github.com> Date: Thu, 18 Jan 2024 15:30:34 -0800 Subject: [PATCH 10/10] Update extension_enablement_test.dart --- .../test/extensions/extension_enablement_test.dart | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/devtools_shared/test/extensions/extension_enablement_test.dart b/packages/devtools_shared/test/extensions/extension_enablement_test.dart index c31b90b6079..41305aa23b3 100644 --- a/packages/devtools_shared/test/extensions/extension_enablement_test.dart +++ b/packages/devtools_shared/test/extensions/extension_enablement_test.dart @@ -45,7 +45,7 @@ void main() { file.readAsStringSync(), ''' description: This file stores settings for Dart & Flutter DevTools. -documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_optionsyaml. +documentation: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states extensions: ''', ); @@ -62,7 +62,7 @@ extensions: file.readAsStringSync(), ''' description: This file stores settings for Dart & Flutter DevTools. -documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_optionsyaml. +documentation: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states extensions: - foo: true''', ); @@ -84,7 +84,7 @@ extensions: file.readAsStringSync(), ''' description: This file stores settings for Dart & Flutter DevTools. -documentation: https://docs.flutter.dev/tools/devtools/extensions#devtools_optionsyaml. +documentation: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states extensions: - foo: true - bar: false''',