test(lib/data): schemas for changelog and source urls (#32151)

Co-authored-by: Michael Kriese <[email protected]>

lib/data/changelog-urls.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "../../tools/schemas/changelog-urls-schema.json",
   "npm": {
     "babel-preset-react-app": "https://github.com/facebook/create-react-app/releases",
     "firebase": "https://firebase.google.com/support/release-notes/js",

lib/data/source-urls.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "../../tools/schemas/source-urls-schema.json",
   "orb": {
     "cypress-io/cypress": "https://github.com/cypress-io/circleci-orb",
     "hutson/library-release-workflows": "https://github.com/hyper-expanse/library-release-workflows"

lib/modules/datasource/metadata-manual.ts

@@ -1,13 +1,15 @@
-import changelogUrls from '../../data/changelog-urls.json';
-import sourceUrls from '../../data/source-urls.json';
+import changelogUrlsJson from '../../data/changelog-urls.json';
+import sourceUrlsJson from '../../data/source-urls.json';
 
+const { $schema: changelogSchema, ...changelogUrls } = changelogUrlsJson;
 // Only necessary when the changelog data cannot be found in the package's source repository
 export const manualChangelogUrls: Record<
   string,
   Record<string, string>
 > = changelogUrls;
 
-// Only necessary if the datasource is unable to locate the source URL itself
+const { $schema: sourceUrlSchema, ...sourceUrls } = sourceUrlsJson;
+// Only necessary when the changelog data cannot be found in the package's source repository
 export const manualSourceUrls: Record<
   string,
   Record<string, string>

test/validate-schemas.spec.ts

@@ -18,15 +18,15 @@ describe('validate-schemas', () => {
     );
 
     for (const schemaFile of schemaFiles) {
-      const correspondingDatFileName = schemaFile.replace('-schema', '');
+      const correspondingDataFileName = schemaFile.replace('-schema', '');
       const schemaName = `${schemaFile
         .replace('.json', '')
         .split('-')
         .map(capitalize)
         .join('')}` as keyof typeof Schemas;
       schemasAndJsonFiles.push({
         schemaName,
-        dataFileName: correspondingDatFileName,
+        dataFileName: correspondingDataFileName,
       });
     }
 

tools/schemas/changelog-urls-schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "patternProperties": {
+    "^[a-zA-Z-]+$": {
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9. -/:@]+$": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

tools/schemas/schema.ts

@@ -52,3 +52,15 @@ export const ReplacementsSchema = z
     all: AllSchema,
   })
   .catchall(RuleSetSchema);
+
+export const ChangelogUrlsSchema = z
+  .object({
+    $schema: z.string(),
+  })
+  .catchall(z.record(z.string(), z.string().url()));
+
+export const SourceUrlsSchema = z
+  .object({
+    $schema: z.string(),
+  })
+  .catchall(z.record(z.string(), z.string().url()));

tools/schemas/source-urls-schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "patternProperties": {
+    "^[a-zA-Z-]+$": {
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9. -/:@]+$": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}