[pub_formats] Generate package_graph.json API (#2457)

Author: dcharkes

pkgs/hooks/tool/normalize.dart

@@ -225,36 +225,47 @@ dynamic sortJson(dynamic data, String filePath) {
   return data;
 }
 
+int _compareTwoItems(dynamic a, dynamic b) {
+  if (a is Map && b is Map) {
+    return compareMaps(a, b);
+  }
+  if (a is String && b is String) {
+    return a.compareTo(b);
+  }
+  if (a is List && b is List) {
+    return compareLists(a, b);
+  }
+  if (a is int && b is int) {
+    return a.compareTo(b);
+  }
+  throw UnimplementedError('Not implemented to compare $a and $b.');
+}
+
 int compareMaps(Map<dynamic, dynamic> a, Map<dynamic, dynamic> b) {
   final aKeys = a.keys.toList();
   final bKeys = b.keys.toList();
   for (var i = 0; i < aKeys.length && i < bKeys.length; i++) {
-    final comparison = aKeys[i].toString().compareTo(bKeys[i].toString());
-    if (comparison != 0) {
-      return comparison;
+    final keyComparison = _compareTwoItems(aKeys[i], bKeys[i]);
+    if (keyComparison != 0) {
+      return keyComparison;
     }
     final aValue = a[aKeys[i]];
     final bValue = b[bKeys[i]];
-    if (aValue is String && bValue is String) {
-      final valueComparison = aValue.compareTo(bValue);
-      if (valueComparison != 0) {
-        return valueComparison;
-      } else {
-        continue;
-      }
+    final valueComparison = _compareTwoItems(aValue, bValue);
+    if (valueComparison != 0) {
+      return valueComparison;
     }
-    if (aValue is Map && bValue is Map) {
-      final valueComparison = compareMaps(aValue, bValue);
-      if (valueComparison != 0) {
-        return valueComparison;
-      } else {
-        continue;
-      }
-    }
-    if (aValue == bValue) {
-      continue;
-    }
-    throw UnimplementedError('Not implemented to compare $aValue and $bValue.');
   }
   return 0;
 }
+
+int compareLists(List<dynamic> a, List<dynamic> b) {
+  for (var i = 0; i < a.length && i < b.length; i++) {
+    final comparison = _compareTwoItems(a[i], b[i]);
+    if (comparison != 0) {
+      return comparison;
+    }
+  }
+  // If all common elements are equal, the shorter list comes first.
+  return a.length.compareTo(b.length);
+}

pkgs/json_syntax_generator/lib/src/parser/schema_analyzer.dart

@@ -440,7 +440,7 @@ class SchemaAnalyzer {
         final itemType = items.type;
         switch (itemType) {
           case SchemaType.string:
-            if (items.patterns.isNotEmpty) {
+            if (items.generateUri) {
               dartType = ListDartType(
                 itemType: const UriDartType(isNullable: false),
                 isNullable: !required,

pkgs/pub_formats/doc/schema/package_graph.schema.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PackageGraphFile",
+  "title": "Package Graph JSON Schema",
+  "description": "Schema for a Dart package_graph.json file. Note that this is reverse engineered and not the source of truth.",
+  "definitions": {
+    "GraphPackage": {
+      "type": "object",
+      "properties": {
+        "dependencies": {
+          "description": "A list of package names this package directly depends on.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/packageName"
+          }
+        },
+        "devDependencies": {
+          "description": "A list of package names this package directly depends on for development.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/packageName"
+          }
+        },
+        "name": {
+          "$ref": "#/definitions/packageName"
+        },
+        "version": {
+          "description": "The semantic version of the package.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "dependencies",
+        "name",
+        "version"
+      ],
+      "additionalProperties": false
+    },
+    "PackageGraphFile": {
+      "type": "object",
+      "properties": {
+        "configVersion": {
+          "description": "Version of the package graph configuration.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "packages": {
+          "description": "Details of each package in the graph.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/GraphPackage"
+          }
+        },
+        "roots": {
+          "description": "A list of root package names in the graph.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/packageName"
+          }
+        }
+      },
+      "required": [
+        "packages",
+        "roots"
+      ],
+      "additionalProperties": false
+    },
+    "packageName": {
+      "description": "The name of the package. Must be a valid Dart identifier.",
+      "type": "string",
+      "pattern": "^[a-zA-Z_]\\w*$"
+    }
+  }
+}

pkgs/pub_formats/doc/schema/pubspec.schema.json

@@ -194,9 +194,7 @@
           "type": "string"
         },
         "name": {
-          "description": "The name of the package. Must be a valid Dart identifier.",
-          "type": "string",
-          "pattern": "^[a-zA-Z_]\\w*$"
+          "$ref": "#/definitions/packageName"
         },
         "publish_to": {
           "type": "string"
@@ -234,6 +232,11 @@
           "$ref": "#/definitions/DependencySource"
         }
       ]
+    },
+    "packageName": {
+      "description": "The name of the package. Must be a valid Dart identifier.",
+      "type": "string",
+      "pattern": "^[a-zA-Z_]\\w*$"
     }
   }
 }

pkgs/pub_formats/doc/schema/pubspec_lock.schema.json

@@ -63,9 +63,7 @@
       "type": "object",
       "properties": {
         "name": {
-          "description": "Name of the package.",
-          "type": "string",
-          "pattern": "^[a-zA-Z_]\\w*$"
+          "$ref": "#/definitions/packageName"
         },
         "sha256": {
           "description": "SHA256 checksum of the package.",
@@ -196,6 +194,11 @@
         "dart"
       ],
       "additionalProperties": false
+    },
+    "packageName": {
+      "description": "The name of the package. Must be a valid Dart identifier.",
+      "type": "string",
+      "pattern": "^[a-zA-Z_]\\w*$"
     }
   }
 }

pkgs/pub_formats/lib/pubspec_formats.dart

@@ -8,5 +8,6 @@
 /// SDK, so when doing breaking changes please roll ASAP to the Dart SDK.
 library;
 
-export 'src/pubspec_syntax.g.dart' hide JsonObjectSyntax;
+export 'src/package_graph_syntax.g.dart' hide JsonObjectSyntax;
 export 'src/pubspec_lock_syntax.g.dart' hide JsonObjectSyntax;
+export 'src/pubspec_syntax.g.dart' hide JsonObjectSyntax;