From 2784d3498160f8fbad35c4207e14967aafa561fb Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Fri, 21 Aug 2026 18:17:16 +0000 Subject: [PATCH 1/6] feat: export ErrorListener and ErrorCollector from yaml.dart Fixes # Extends loadYaml public API by exporting previously hidden types. --- pkgs/yaml/CHANGELOG.md | 4 +- pkgs/yaml/lib/yaml.dart | 1 + pkgs/yaml/pubspec.yaml | 2 +- pkgs/yaml/test/error_listener_test.dart | 72 +++++++++++++++++++++++++ pkgs/yaml/test/yaml_test.dart | 2 +- 5 files changed, 78 insertions(+), 3 deletions(-) create mode 100644 pkgs/yaml/test/error_listener_test.dart diff --git a/pkgs/yaml/CHANGELOG.md b/pkgs/yaml/CHANGELOG.md index 6b464da81d..837104d6b9 100644 --- a/pkgs/yaml/CHANGELOG.md +++ b/pkgs/yaml/CHANGELOG.md @@ -1,4 +1,6 @@ -## 3.1.4-wip +## 3.2.0-wip + +* Export `ErrorListener` and `ErrorCollector` from `package:yaml/yaml.dart`. * Improve recovery for list entries without `-` prefix. When recovering, provide a more helpful error message suggesting the missing prefix. * Fix a bug where block strings terminated by `EOF` were not given an implicit diff --git a/pkgs/yaml/lib/yaml.dart b/pkgs/yaml/lib/yaml.dart index 26cc9b86f5..dc1f14ad55 100644 --- a/pkgs/yaml/lib/yaml.dart +++ b/pkgs/yaml/lib/yaml.dart @@ -12,6 +12,7 @@ import 'src/yaml_document.dart'; import 'src/yaml_exception.dart'; import 'src/yaml_node.dart'; +export 'src/error_listener.dart'; export 'src/style.dart'; export 'src/utils.dart' show YamlWarningCallback, yamlWarningCallback; export 'src/yaml_document.dart'; diff --git a/pkgs/yaml/pubspec.yaml b/pkgs/yaml/pubspec.yaml index 8b75bc5681..746ceb2921 100644 --- a/pkgs/yaml/pubspec.yaml +++ b/pkgs/yaml/pubspec.yaml @@ -1,5 +1,5 @@ name: yaml -version: 3.1.4-wip +version: 3.2.0-wip description: A parser for YAML, a human-friendly data serialization standard repository: https://github.com/dart-lang/tools/tree/main/pkgs/yaml issue_tracker: https://github.com/dart-lang/tools/labels/package%3Ayaml diff --git a/pkgs/yaml/test/error_listener_test.dart b/pkgs/yaml/test/error_listener_test.dart new file mode 100644 index 0000000000..19c21dab5d --- /dev/null +++ b/pkgs/yaml/test/error_listener_test.dart @@ -0,0 +1,72 @@ +// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file +// for details. 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:test/test.dart'; +import 'package:yaml/yaml.dart'; + +class _CustomErrorListener implements ErrorListener { + final List messages = []; + + @override + void onError(YamlException error) { + messages.add(error.message); + } +} + +void main() { + const invalidYamlWithMissingPrefix = ''' +linter: + rules: + - annotate_overrides + alway +'''; + + test('ErrorCollector collects errors during recovery parsing', () { + final collector = ErrorCollector(); + final result = loadYaml( + invalidYamlWithMissingPrefix, + recover: true, + errorListener: collector, + ); + + expect( + result, + equals({ + 'linter': { + 'rules': ['annotate_overrides', 'alway'], + }, + }), + ); + expect(collector.errors, hasLength(1)); + expect( + collector.errors.first.message, + contains("Expected ':'"), + ); + }); + + test( + 'custom ErrorListener implementation receives errors during recovery ' + 'parsing', () { + final listener = _CustomErrorListener(); + final result = loadYaml( + invalidYamlWithMissingPrefix, + recover: true, + errorListener: listener, + ); + + expect( + result, + equals({ + 'linter': { + 'rules': ['annotate_overrides', 'alway'], + }, + }), + ); + expect(listener.messages, hasLength(1)); + expect( + listener.messages.first, + contains("Expected ':'"), + ); + }); +} diff --git a/pkgs/yaml/test/yaml_test.dart b/pkgs/yaml/test/yaml_test.dart index 72f985bef6..57a19a20f6 100644 --- a/pkgs/yaml/test/yaml_test.dart +++ b/pkgs/yaml/test/yaml_test.dart @@ -8,7 +8,7 @@ // ignore_for_file: avoid_dynamic_calls import 'package:test/test.dart'; -import 'package:yaml/src/error_listener.dart'; + import 'package:yaml/yaml.dart'; import 'utils.dart'; From 80cf4ddf4b1a25a8992f1146a3a64dc1f14357bf Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Fri, 21 Aug 2026 18:27:21 +0000 Subject: [PATCH 2/6] style: remove blank line between package imports in yaml_test.dart --- pkgs/yaml/test/yaml_test.dart | 1 - 1 file changed, 1 deletion(-) diff --git a/pkgs/yaml/test/yaml_test.dart b/pkgs/yaml/test/yaml_test.dart index 57a19a20f6..e2b5264895 100644 --- a/pkgs/yaml/test/yaml_test.dart +++ b/pkgs/yaml/test/yaml_test.dart @@ -8,7 +8,6 @@ // ignore_for_file: avoid_dynamic_calls import 'package:test/test.dart'; - import 'package:yaml/yaml.dart'; import 'utils.dart'; From 6e02416ed46bd838584be845a717e534597b2a0a Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Tue, 25 Aug 2026 04:35:50 +0000 Subject: [PATCH 3/6] feat(yaml): annotate internal constructors with @internal --- pkgs/yaml/CHANGELOG.md | 2 ++ pkgs/yaml/lib/src/yaml_document.dart | 2 ++ pkgs/yaml/lib/src/yaml_node.dart | 5 +++++ pkgs/yaml/pubspec.yaml | 1 + 4 files changed, 10 insertions(+) diff --git a/pkgs/yaml/CHANGELOG.md b/pkgs/yaml/CHANGELOG.md index 837104d6b9..6486b946dd 100644 --- a/pkgs/yaml/CHANGELOG.md +++ b/pkgs/yaml/CHANGELOG.md @@ -1,6 +1,8 @@ ## 3.2.0-wip * Export `ErrorListener` and `ErrorCollector` from `package:yaml/yaml.dart`. +* Mark internal constructors in `YamlDocument`, `YamlMap`, `YamlList`, and + `YamlScalar` with `@internal`. * Improve recovery for list entries without `-` prefix. When recovering, provide a more helpful error message suggesting the missing prefix. * Fix a bug where block strings terminated by `EOF` were not given an implicit diff --git a/pkgs/yaml/lib/src/yaml_document.dart b/pkgs/yaml/lib/src/yaml_document.dart index da6aa1ec34..d7b6f5b1f2 100644 --- a/pkgs/yaml/lib/src/yaml_document.dart +++ b/pkgs/yaml/lib/src/yaml_document.dart @@ -7,6 +7,7 @@ import 'dart:collection'; +import 'package:meta/meta.dart'; import 'package:source_span/source_span.dart'; import 'yaml_node.dart'; @@ -33,6 +34,7 @@ class YamlDocument { final bool endImplicit; /// Users of the library should not use this constructor. + @internal YamlDocument.internal(this.contents, this.span, this.versionDirective, List tagDirectives, {this.startImplicit = false, this.endImplicit = false}) diff --git a/pkgs/yaml/lib/src/yaml_node.dart b/pkgs/yaml/lib/src/yaml_node.dart index bd17b6cb99..dce94c28e9 100644 --- a/pkgs/yaml/lib/src/yaml_node.dart +++ b/pkgs/yaml/lib/src/yaml_node.dart @@ -8,6 +8,7 @@ import 'dart:collection' as collection; import 'package:collection/collection.dart'; +import 'package:meta/meta.dart'; import 'package:source_span/source_span.dart'; import 'event.dart'; @@ -86,6 +87,7 @@ class YamlMap extends YamlNode with collection.MapMixin, UnmodifiableMapMixin { YamlMapWrapper(dartMap, sourceUrl, style: style); /// Users of the library should not use this constructor. + @internal YamlMap.internal(Map nodes, super.span, this.style) : nodes = UnmodifiableMapView(nodes), super._(); @@ -136,6 +138,7 @@ class YamlList extends YamlNode with collection.ListMixin { YamlListWrapper(dartList, sourceUrl, style: style); /// Users of the library should not use this constructor. + @internal YamlList.internal(List nodes, super.span, this.style) : nodes = UnmodifiableListView(nodes), super._(); @@ -170,11 +173,13 @@ class YamlScalar extends YamlNode { } /// Users of the library should not use this constructor. + @internal YamlScalar.internal(this.value, ScalarEvent scalar) : style = scalar.style, super._(scalar.span); /// Users of the library should not use this constructor. + @internal YamlScalar.internalWithSpan(this.value, SourceSpan span) : style = ScalarStyle.ANY, super._(span); diff --git a/pkgs/yaml/pubspec.yaml b/pkgs/yaml/pubspec.yaml index 746ceb2921..992a8e78cb 100644 --- a/pkgs/yaml/pubspec.yaml +++ b/pkgs/yaml/pubspec.yaml @@ -13,6 +13,7 @@ environment: dependencies: collection: ^1.15.0 + meta: ^1.9.0 source_span: ^1.8.0 string_scanner: ^1.2.0 From d818bcb14b0a0ae3d14280380f6099cad831b691 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Fri, 28 Aug 2026 19:43:36 +0000 Subject: [PATCH 4/6] fix(yaml): add nodoc to internal constructor and deprecate subclassing - Annotate YamlDocument with @Deprecated.subclass to discourage subclassing. - Add @nodoc to YamlDocument.internal constructor to hide it from documentation. --- pkgs/yaml/lib/src/yaml_document.dart | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkgs/yaml/lib/src/yaml_document.dart b/pkgs/yaml/lib/src/yaml_document.dart index d7b6f5b1f2..50dce09fa1 100644 --- a/pkgs/yaml/lib/src/yaml_document.dart +++ b/pkgs/yaml/lib/src/yaml_document.dart @@ -13,6 +13,7 @@ import 'package:source_span/source_span.dart'; import 'yaml_node.dart'; /// A YAML document, complete with metadata. +@Deprecated.subclass('Users of the library should not subclass this type.') class YamlDocument { /// The contents of the document. final YamlNode contents; @@ -34,6 +35,8 @@ class YamlDocument { final bool endImplicit; /// Users of the library should not use this constructor. + /// + /// @nodoc @internal YamlDocument.internal(this.contents, this.span, this.versionDirective, List tagDirectives, From 40384a89d1c8ecf9997b603cede7f17125cc1c43 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Fri, 28 Aug 2026 19:53:04 +0000 Subject: [PATCH 5/6] fix: revert unintentional formatting changes to non-yaml packages from merge --- pkgs/cli_util/test/cli_util_test.dart | 20 +- .../lib/extension_discovery.dart | 72 ++-- .../test/symlink_escape_test.dart | 4 +- .../test/test_descriptor.dart | 14 +- pkgs/html/test/differential_test.dart | 37 +- .../test/src/interface/common_test.dart | 45 +- pkgs/unified_analytics/lib/src/analytics.dart | 5 +- .../test/unified_analytics_test.dart | 261 ++++++------ pkgs/yaml_edit/lib/src/list_mutations.dart | 62 +-- pkgs/yaml_edit/lib/src/map_mutations.dart | 42 +- pkgs/yaml_edit/lib/src/utils.dart | 11 +- pkgs/yaml_edit/test/append_test.dart | 126 ++---- pkgs/yaml_edit/test/update_test.dart | 390 +++++++----------- 13 files changed, 458 insertions(+), 631 deletions(-) diff --git a/pkgs/cli_util/test/cli_util_test.dart b/pkgs/cli_util/test/cli_util_test.dart index f32cc3bb6a..2627c87907 100644 --- a/pkgs/cli_util/test/cli_util_test.dart +++ b/pkgs/cli_util/test/cli_util_test.dart @@ -56,8 +56,9 @@ void main() { final mockSdk = Directory.systemTemp.createTempSync('mock_sdk'); try { Directory(p.join(mockSdk.path, 'lib')).createSync(); - File(p.join(mockSdk.path, 'lib', 'libraries.json')) - .writeAsStringSync('{}'); + File( + p.join(mockSdk.path, 'lib', 'libraries.json'), + ).writeAsStringSync('{}'); File(p.join(mockSdk.path, 'version')).writeAsStringSync('3.8.0'); runZoned( @@ -99,8 +100,9 @@ void main() { p.join(mockFlutter.path, 'bin', 'cache', 'dart-sdk'), )..createSync(recursive: true); Directory(p.join(mockDartSdk.path, 'lib')).createSync(); - File(p.join(mockDartSdk.path, 'lib', 'libraries.json')) - .writeAsStringSync('{}'); + File( + p.join(mockDartSdk.path, 'lib', 'libraries.json'), + ).writeAsStringSync('{}'); File(p.join(mockDartSdk.path, 'version')).writeAsStringSync('3.8.0'); File(p.join(mockFlutterBin.path, 'dart')).createSync(); @@ -132,8 +134,9 @@ void main() { final mockSdk = Directory(p.join(tempDir.path, 'dart-sdk')) ..createSync(); Directory(p.join(mockSdk.path, 'lib')).createSync(); - File(p.join(mockSdk.path, 'lib', 'libraries.json')) - .writeAsStringSync('{}'); + File( + p.join(mockSdk.path, 'lib', 'libraries.json'), + ).writeAsStringSync('{}'); File(p.join(mockSdk.path, 'version')).writeAsStringSync('3.8.0'); final binDir = Directory(p.join(mockSdk.path, 'bin'))..createSync(); File(p.join(binDir.path, 'dart')).createSync(); @@ -166,8 +169,9 @@ void main() { p.join(mockFlutter.path, 'bin', 'cache', 'dart-sdk'), )..createSync(recursive: true); Directory(p.join(mockDartSdk.path, 'lib')).createSync(); - File(p.join(mockDartSdk.path, 'lib', 'libraries.json')) - .writeAsStringSync('{}'); + File( + p.join(mockDartSdk.path, 'lib', 'libraries.json'), + ).writeAsStringSync('{}'); File(p.join(mockDartSdk.path, 'version')).writeAsStringSync('3.8.0'); runZoned( diff --git a/pkgs/extension_discovery/lib/extension_discovery.dart b/pkgs/extension_discovery/lib/extension_discovery.dart index c24f6320bc..2c581764c2 100644 --- a/pkgs/extension_discovery/lib/extension_discovery.dart +++ b/pkgs/extension_discovery/lib/extension_discovery.dart @@ -179,11 +179,9 @@ Future> _findExtensions({ required Uri packageConfigUri, }) async { final packageConfigFile = File.fromUri(packageConfigUri); - final registryFile = File.fromUri( - packageConfigFile.parent.uri.resolve( - 'extension_discovery/$targetPackage.json', - ), - ); + final registryFile = File.fromUri(packageConfigFile.parent.uri.resolve( + 'extension_discovery/$targetPackage.json', + )); Registry? registry; final registryStat = registryFile.statSync(); @@ -256,37 +254,37 @@ Future> _findExtensions({ // Load packages from package_config.json final packages = await loadPackageConfig(packageConfigFile); registryUpdated = true; - registry = (await Future.wait( - packages.map((p) async { - try { - final rootUri = packageConfigUri.resolveUri(p.rootUri); - final configFile = File.fromUri(rootUri.resolve(configFileName)); - final configStat = configFile.statSync(); - if (configStat.isFileOrLink && - _isWithinPackageBoundary(rootUri, configFile)) { - return ( - package: p.name, - rootUri: p.rootUri, - packageUri: p.packageUri, - config: parseYamlFromConfigFile(await configFile.readAsString()), - ); - } - } on FormatException { - // pass - } on IOException { - // pass - } - if (!p.rootUri.hasAbsolutePath) { + registry = (await Future.wait(packages.map((p) async { + try { + final rootUri = packageConfigUri.resolveUri(p.rootUri); + final configFile = File.fromUri(rootUri.resolve(configFileName)); + final configStat = configFile.statSync(); + if (configStat.isFileOrLink && + _isWithinPackageBoundary(rootUri, configFile)) { return ( package: p.name, rootUri: p.rootUri, packageUri: p.packageUri, - config: null, + config: parseYamlFromConfigFile(await configFile.readAsString()), ); } - return null; - }), - )).whereType().toList(growable: false); + } on FormatException { + // pass + } on IOException { + // pass + } + if (!p.rootUri.hasAbsolutePath) { + return ( + package: p.name, + rootUri: p.rootUri, + packageUri: p.packageUri, + config: null, + ); + } + return null; + }))) + .whereType() + .toList(growable: false); } // Save registry @@ -297,14 +295,12 @@ Future> _findExtensions({ return UnmodifiableListView( registry .where((e) => e.config != null) - .map( - (e) => Extension._( - package: e.package, - rootUri: packageConfigUri.resolveUri(e.rootUri), - packageUri: e.packageUri, - config: e.config!, - ), - ) + .map((e) => Extension._( + package: e.package, + rootUri: packageConfigUri.resolveUri(e.rootUri), + packageUri: e.packageUri, + config: e.config!, + )) .toList(growable: false), ); } diff --git a/pkgs/extension_discovery/test/symlink_escape_test.dart b/pkgs/extension_discovery/test/symlink_escape_test.dart index e56b0af59d..5bcc7dd4b4 100644 --- a/pkgs/extension_discovery/test/symlink_escape_test.dart +++ b/pkgs/extension_discovery/test/symlink_escape_test.dart @@ -32,8 +32,8 @@ void main() { }), d.dir('extension', [ d.dir('devtools', [ - d.json('config.yaml', {'secret': 'fake initial safe file'}), - ]), + d.json('config.yaml', {'secret': 'fake initial safe file'}) + ]) ]), ]).create(); diff --git a/pkgs/extension_discovery/test/test_descriptor.dart b/pkgs/extension_discovery/test/test_descriptor.dart index b2b2faa4bf..599696f17d 100644 --- a/pkgs/extension_discovery/test/test_descriptor.dart +++ b/pkgs/extension_discovery/test/test_descriptor.dart @@ -23,10 +23,9 @@ class _LinkDescriptor extends d.Descriptor { _LinkDescriptor(super.name, this._target); - String _path(String? parent) => - Uri.directory(parent ?? d.sandbox) - .resolve(name) - .toFilePath(windows: Platform.isWindows); + String _path(String? parent) => Uri.directory(parent ?? d.sandbox) + .resolve(name) + .toFilePath(windows: Platform.isWindows); @override String describe() => 'link $name to $_target'; @@ -77,11 +76,8 @@ Future dart([ print(result.stderr); print(result.stdout); } - expect( - result.exitCode, - 0, - reason: 'failed executing "dart ${arguments.join(' ')}"', - ); + expect(result.exitCode, 0, + reason: 'failed executing "dart ${arguments.join(' ')}"'); return result.stdout as String; } diff --git a/pkgs/html/test/differential_test.dart b/pkgs/html/test/differential_test.dart index 860881537d..32dddc877f 100644 --- a/pkgs/html/test/differential_test.dart +++ b/pkgs/html/test/differential_test.dart @@ -30,16 +30,29 @@ final _testCases = [ ), ( name: 'adoption agency algorithm nested formatters limit', - html: '

', + html: + '

', + ), + ( + name: 'noscript contents style dropped', + html: '