Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added a description and link to documentation in the devtools_options.yaml file. #7052

Merged
merged 11 commits into from
Jan 19, 2024
Merged

Added a description and link to documentation in the devtools_options.yaml file. #7052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
bfa46cd
Add explanatory comment to `devtools_options.yaml` file.
kenzieschmoll Jan 17, 2024
5e35068
changelog and version bump
kenzieschmoll Jan 17, 2024
f8245c7
rnotes
kenzieschmoll Jan 17, 2024
9890a4b
fix notes
kenzieschmoll Jan 17, 2024
d53fd65
fix
kenzieschmoll Jan 17, 2024
70066e6
release notes
kenzieschmoll Jan 17, 2024
62da6f4
changelog
kenzieschmoll Jan 17, 2024
3eb7361
fix test
kenzieschmoll Jan 17, 2024
8965128
Merge branch 'master' into devoptions
kenzieschmoll Jan 18, 2024
fe193f1
Update extension_enablement.dart
kenzieschmoll Jan 18, 2024
a2268a5
Update extension_enablement_test.dart
kenzieschmoll Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions packages/devtools_shared/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 4 additions & 2 deletions packages/devtools_shared/lib/src/extensions/extension_enablement.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
''';

Expand Down
6 changes: 6 additions & 0 deletions packages/devtools_shared/test/extensions/extension_enablement_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
''',
);
Expand All @@ -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''',
);
Expand All @@ -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''',
Expand Down