From 11012bc10910db1dd7ed3215f39d6f5fb283a8d0 Mon Sep 17 00:00:00 2001
From: Jonathan Pryor <jonpryor@vt.edu>
Date: Tue, 6 Sep 2022 14:21:49 -0400
Subject: [PATCH] [xaprepare] CGManifest.json conforms to JSON schema

Context: https://www.jsonschemavalidator.net/
Context: https://github.com/JamieMagee/verify-cgmanifest
Context: https://json.schemastore.org/component-detection-manifest.json
Context: https://github.com/xamarin/AndroidX/pull/608

There is a [JSON Schema][0] for `CGManifest.json`.

Update `xaprepare` so that `CGManifest.json` conforms to the JSON
schema.  This involves three sets of changes:

  * Add a `$schema` property.

  * Add a `version` property; I can't find any actual documentation
    for this schema, but the [sample manifest][1] uses `"version": 1`,
    so use the same version.

  * "camelCase" all the JSON property names.  From the
    [JamieMagee/verify-cgmanifest README.md][2]:

    > Component Detection will accept object properties in PascalCase,
    > but JSON schema does not have a case-insensitive mode.
    > Camel case is the most common way to write object properties in
    > JSON.

With these changes, our generated
`bin/Build$(Configuration)/CGManifest.json` reports no errors when
using <https://www.jsonschemavalidator.net>.

[0]: https://json.schemastore.org/component-detection-manifest.json
[1]: https://github.com/JamieMagee/verify-cgmanifest/blob/2adfb450cd1f2170c3df120036f4a531285167ef/cgmanifest.sample.json
[2]: https://github.com/JamieMagee/verify-cgmanifest/blob/2adfb450cd1f2170c3df120036f4a531285167ef/README.md
---
 .../Steps/Step_GenerateCGManifest.cs          | 22 ++++++++++---------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/build-tools/xaprepare/xaprepare/Steps/Step_GenerateCGManifest.cs b/build-tools/xaprepare/xaprepare/Steps/Step_GenerateCGManifest.cs
index f4bca36c1a5..d98224cdb49 100644
--- a/build-tools/xaprepare/xaprepare/Steps/Step_GenerateCGManifest.cs
+++ b/build-tools/xaprepare/xaprepare/Steps/Step_GenerateCGManifest.cs
@@ -67,7 +67,9 @@ protected override async Task<bool> Execute (Context context)
 			using var json  = File.CreateText (jsonPath);
 
 			json.WriteLine ("{");
-			json.WriteLine ("    \"Registrations\": [");
+			json.WriteLine ("    \"$schema\": \"https://json.schemastore.org/component-detection-manifest.json\",");
+			json.WriteLine ("    \"version\": 1,");
+			json.WriteLine ("    \"registrations\": [");
 
 			var properties = new Dictionary<string, string> ();
 
@@ -100,8 +102,8 @@ void WriteComponent (TextWriter json, CGManifestEntry entry, Dictionary<string,
 			entry.FillComponentProperties (properties);
 
 			json.WriteLine ($"        {{");
-			json.WriteLine ($"            \"Component\": {{");
-			json.WriteLine ($"                \"Type\": \"{entry.Type.ToLowerInvariant ()}\",");
+			json.WriteLine ($"            \"component\": {{");
+			json.WriteLine ($"                \"type\": \"{entry.Type.ToLowerInvariant ()}\",");
 			json.WriteLine ($"                \"{entry.Type}\": {{");
 			bool firstProp = true;
 			foreach (var key in properties.Keys.OrderBy (p => p, StringComparer.OrdinalIgnoreCase)) {
@@ -116,7 +118,7 @@ void WriteComponent (TextWriter json, CGManifestEntry entry, Dictionary<string,
 			json.WriteLine ();
 			json.WriteLine ($"                }}");
 			json.WriteLine ($"            }},");
-			json.WriteLine ($"            \"DevelopmentDependency\":{dev}");
+			json.WriteLine ($"            \"developmentDependency\":{dev}");
 			json.Write     ($"        }}");
 		}
 	}
@@ -145,7 +147,7 @@ public  override    string      Name {
 			}
 		}
 
-		public  override    string      Type    => "Git";
+		public  override    string      Type    => "git";
 
 		public  string      RepositoryUrl   {get; private set;} = String.Empty;
 		public  string      CommitHash      {get; private set;} = String.Empty;
@@ -157,8 +159,8 @@ public  override    string      Name {
 
 		public override void FillComponentProperties (Dictionary<string, string> properties)
 		{
-			properties ["RepositoryUrl"]    = RepositoryUrl;
-			properties ["CommitHash"]       = CommitHash;
+			properties ["repositoryUrl"]    = RepositoryUrl;
+			properties ["commitHash"]       = CommitHash;
 		}
 
 		const string Submodule = "submodule.external/";
@@ -256,7 +258,7 @@ sealed class MSBuildPackageReferenceInfo : CGManifestEntry {
 		string name;
 
 		public  override    string      Name    => name;
-		public  override    string      Type    => "Nuget";
+		public  override    string      Type    => "nuget";
 
 		public  string      Version {get; private set;}
 
@@ -268,8 +270,8 @@ sealed class MSBuildPackageReferenceInfo : CGManifestEntry {
 
 		public override void FillComponentProperties (Dictionary<string, string> properties)
 		{
-			properties ["Name"]     = Name;
-			properties ["Version"]  = Version;
+			properties ["name"]     = Name;
+			properties ["version"]  = Version;
 		}
 
 		static  readonly    XNamespace      MSBuildXmlns    = XNamespace.Get ("http://schemas.microsoft.com/developer/msbuild/2003");