firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make the encoding of a YamlNode to a String more explicit. (#161270)

Browse Source 
It wasn't clear to me (or @bkonyi, in our
[discussion](https://discord.com/channels/608014603317936148/1326246134238285929))
why `yaml_edit` was being used, and now it is!
This commit is contained in:
Matan Lurey 2025-01-08 13:14:29 -08:00 committed by GitHub
parent 1e9202e1ee
commit 46341c6670
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
packages/flutter_tools/lib/src/base/yaml.dart Normal file
View File

@ -0,0 +1,13 @@
// Copyright 2014 The Flutter 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:yaml/yaml.dart';
import 'package:yaml_edit/yaml_edit.dart' show YamlEditor;
/// Converts a [YamlNode] to a valid YAML-formatted [String].
String encodeYamlAsString(YamlNode contents) {
final YamlEditor editor = YamlEditor('');
editor.update(const <String>[], contents);
return editor.toString();
}

6
packages/flutter_tools/lib/src/project.dart
View File

@ -5,7 +5,6 @@
import 'package:meta/meta.dart';
import 'package:xml/xml.dart';
import 'package:yaml/yaml.dart';
import 'package:yaml_edit/yaml_edit.dart';
import '../src/convert.dart';
import 'android/android_builder.dart';
@ -16,6 +15,7 @@ import 'base/file_system.dart';
import 'base/logger.dart';
import 'base/utils.dart';
import 'base/version.dart';
import 'base/yaml.dart';
import 'bundle.dart' as bundle;
import 'cmake_project.dart';
import 'dart/package_map.dart';
@ -317,9 +317,7 @@ class FlutterProject {
/// sets [manifest] to the [updated] manifest.
void replacePubspec(FlutterManifest updated) {
final YamlMap updatedPubspecContents = updated.toYaml();
final YamlEditor editor = YamlEditor('');
editor.update(const <String>[], updatedPubspecContents);
pubspecFile.writeAsStringSync(editor.toString());
pubspecFile.writeAsStringSync(encodeYamlAsString(updatedPubspecContents));
_manifest = updated;
}

6
packages/flutter_tools/test/general.shard/flutter_manifest_test.dart
View File

@ -7,9 +7,9 @@ import 'package:file/memory.dart';
import 'package:flutter_tools/src/base/deferred_component.dart';
import 'package:flutter_tools/src/base/file_system.dart';
import 'package:flutter_tools/src/base/logger.dart';
import 'package:flutter_tools/src/base/yaml.dart';
import 'package:flutter_tools/src/cache.dart';
import 'package:flutter_tools/src/flutter_manifest.dart';
import 'package:yaml_edit/yaml_edit.dart';
import '../src/common.dart';
@ -1512,9 +1512,7 @@ flutter:
],
);
final YamlEditor editor = YamlEditor('');
editor.update(const <String>[], updatedManifest.toYaml());
expect(editor.toString(), '''
expect(encodeYamlAsString(updatedManifest.toYaml()), '''
name: test
dependencies:
flutter: