Tojson pubspec parser

pkgs/pubspec_parse/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.5.1
+
+- Added `toJson` method to `Pubspec` to serialize the object back to a `Map`.
+
 ## 1.5.0
 
 - Added fields to `Pubspec`: `executables`, `resolution`, `workspace`.

pkgs/pubspec_parse/lib/src/dependency.dart

@@ -90,7 +90,9 @@ Dependency? _fromJson(Object? data, String name) {
   return null;
 }
 
-sealed class Dependency {}
+sealed class Dependency {
+  Map<String, dynamic> toJson();
+}
 
 @JsonSerializable()
 class SdkDependency extends Dependency {
@@ -110,6 +112,12 @@ class SdkDependency extends Dependency {
 
   @override
   String toString() => 'SdkDependency: $sdk';
+
+  @override
+  Map<String, dynamic> toJson() => {
+        'sdk': sdk,
+        'version': version.toString(),
+      };
 }
 
 @JsonSerializable()
@@ -145,6 +153,15 @@ class GitDependency extends Dependency {
 
   @override
   String toString() => 'GitDependency: url@$url';
+
+  @override
+  Map<String, dynamic> toJson() => {
+        'git': {
+          'url': url.toString(),
+          if (ref != null) 'ref': ref,
+          if (path != null) 'path': path,
+        },
+      };
 }
 
 Uri? parseGitUriOrNull(String? value) =>
@@ -204,6 +221,9 @@ class PathDependency extends Dependency {
 
   @override
   String toString() => 'PathDependency: path@$path';
+
+  @override
+  Map<String, dynamic> toJson() => {'path': path};
 }
 
 @JsonSerializable(disallowUnrecognizedKeys: true)
@@ -228,6 +248,12 @@ class HostedDependency extends Dependency {
 
   @override
   String toString() => 'HostedDependency: $version';
+
+  @override
+  Map<String, dynamic> toJson() => {
+        'version': version.toString(),
+        if (hosted != null) 'hosted': hosted!.toJson(),
+      };
 }
 
 @JsonSerializable(disallowUnrecognizedKeys: true)
@@ -271,7 +297,15 @@ class HostedDetails {
 
   @override
   int get hashCode => Object.hash(name, url);
+
+  Map<String, dynamic> toJson() => {
+        if (declaredName != null) 'name': declaredName,
+        'url': url.toString(),
+      };
 }
 
 VersionConstraint _constraintFromString(String? input) =>
     input == null ? VersionConstraint.any : VersionConstraint.parse(input);
+
+Map<String, dynamic> serializeDeps(Map<String, Dependency> input) =>
+    input.map((k, v) => MapEntry(k, v.toJson()));

pkgs/pubspec_parse/lib/src/pubspec.dart

@@ -11,13 +11,13 @@ import 'screenshot.dart';
 
 part 'pubspec.g.dart';
 
-@JsonSerializable()
+@JsonSerializable(createToJson: true)
 class Pubspec {
   // TODO: executables
 
   final String name;
 
-  @JsonKey(fromJson: _versionFromString)
+  @JsonKey(fromJson: _versionFromString, toJson: _versionToString)
   final Version? version;
 
   final String? description;
@@ -51,7 +51,7 @@ class Pubspec {
   final List<String>? ignoredAdvisories;
 
   /// Optional field for specifying included screenshot files.
-  @JsonKey(fromJson: parseScreenshots)
+  @JsonKey(fromJson: parseScreenshots, toJson: serializeScreenshots)
   final List<Screenshot>? screenshots;
 
   /// If there is exactly 1 value in [authors], returns it.
@@ -73,16 +73,16 @@ class Pubspec {
   final List<String> authors;
   final String? documentation;
 
-  @JsonKey(fromJson: _environmentMap)
+  @JsonKey(fromJson: _environmentMap, toJson: _serializeEnvironment)
   final Map<String, VersionConstraint?> environment;
 
-  @JsonKey(fromJson: parseDeps)
+  @JsonKey(fromJson: parseDeps, toJson: serializeDeps)
   final Map<String, Dependency> dependencies;
 
-  @JsonKey(fromJson: parseDeps)
+  @JsonKey(fromJson: parseDeps, toJson: serializeDeps)
   final Map<String, Dependency> devDependencies;
 
-  @JsonKey(fromJson: parseDeps)
+  @JsonKey(fromJson: parseDeps, toJson: serializeDeps)
   final Map<String, Dependency> dependencyOverrides;
 
   /// Optional configuration specific to [Flutter](https://flutter.io/)
@@ -94,7 +94,7 @@ class Pubspec {
   final Map<String, dynamic>? flutter;
 
   /// Optional field to specify executables
-  @JsonKey(fromJson: _executablesMap)
+  @JsonKey(fromJson: _executablesMap, toJson: _serializeExecutables)
   final Map<String, String?> executables;
 
   /// If this package is a Pub Workspace, this field lists the sub-packages.
@@ -177,6 +177,9 @@ class Pubspec {
     return _$PubspecFromJson(json);
   }
 
+  // Returns a JSON-serializable map for this instance.
+  Map<String, dynamic> toJson() => _$PubspecToJson(this);
+
   /// Parses source [yaml] into [Pubspec].
   ///
   /// When [lenient] is set, top-level property-parsing or type cast errors are
@@ -256,3 +259,15 @@ Map<String, String?> _executablesMap(Map? source) =>
       }
     }) ??
     {};
+
+Map<String, String?> _serializeEnvironment(
+  Map<String, VersionConstraint?> map,
+) =>
+    map.map(
+      (key, value) => MapEntry(key, value?.toString()),
+    );
+
+String? _versionToString(Version? version) => version?.toString();
+
+Map<String, String?> _serializeExecutables(Map<String, String?>? map) =>
+    map?.map(MapEntry.new) ?? {};

pkgs/pubspec_parse/lib/src/screenshot.dart

@@ -63,3 +63,11 @@ List<Screenshot> parseScreenshots(List? input) {
   }
   return res;
 }
+
+List<Map<String, String>> serializeScreenshots(List<Screenshot>? input) =>
+    input
+        ?.map(
+          (e) => <String, String>{'description': e.description, 'path': e.path},
+        )
+        .toList() ??
+    [];

pkgs/pubspec_parse/pubspec.yaml

@@ -1,5 +1,5 @@
 name: pubspec_parse
-version: 1.5.0
+version: 1.5.1
 description: >-
   Simple package for parsing pubspec.yaml files with a type-safe API and rich
   error reporting.