feat: new script and ci for JSON Schema validation

.github/workflows/if-nodejs-pr-testing.yml

@@ -76,3 +76,6 @@ jobs:
       - if: steps.packagejson.outputs.exists == 'true'
         name: Run release assets generation to make sure PR does not break it
         run: npm run generate:assets --if-present
+      - if: steps.packagejson.outputs.exists == 'true'
+        name: Run JSON Schema Validator
+        run: npm run validate-schemas

package.json

@@ -12,7 +12,8 @@
     "bundle": "cd tools/bundler && npm i && npm run bundle",
     "startNewVersion": "newVersion=$npm_config_new_version node scripts/add-new-version.js",
     "lint": "echo 'No linter integrated yet'",
-    "bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION"
+    "bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION",
+    "validate-schemas": "node scripts/validate-schemas.js"
   },
   "repository": {
     "type": "git",
@@ -37,7 +38,8 @@
   },
   "homepage": "https://github.com/asyncapi/spec-json-schemas#readme",
   "devDependencies": {
-    "ajv": "^8.11.2",
+    "ajv": "^8.12.0",
+    "ajv-draft-04": "^1.0.0",
     "mocha": "^10.0.0",
     "nyc": "^15.1.0"
   },

scripts/validate-schemas.js

@@ -0,0 +1,89 @@
+const fs = require('fs');
+const path = require('path');
+
+const AjvDraft04 = require('ajv-draft-04');
+const ajvDraft04 = new AjvDraft04();
+
+const Ajv = require('ajv');
+const ajv = new Ajv();
+
+function validation (excludedFiles){
+
+  // Specify the path to the 'schemas' directory
+  const directoryPath = './schemas';
+
+  try{
+
+    const files = fs.readdirSync(directoryPath);
+
+    // Filter files
+    const filteredFiles = files.filter(file =>  !excludedFiles.includes(file) && path.extname(file).toLowerCase() === '.json');
+
+
+    // Collect errors in an array
+    const validationErrors = [];
+
+    // Iterate through the filtered files
+    filteredFiles.forEach(file => {
+        // Construct the full path to the JSON schema file
+        const filePath = path.join(directoryPath, file);
+
+
+        try {
+            // Read and parse the JSON schema
+            const fileContent = fs.readFileSync(filePath, 'utf8');
+            const obj = JSON.parse(fileContent);
+
+            let validate;
+            if (obj.$schema === 'http://json-schema.org/draft-04/schema') {
+                // Validate the schema
+                validate = ajvDraft04.validateSchema(obj);
+                if(validate){
+                    console.log(`\n${file}: JSON Schema is valid!`);
+                }   
+            } else {
+                // Validate the schema
+                validate = ajv.validateSchema(obj);
+                if(validate){
+                    console.log(`\n${file}: JSON Schema is valid!`);
+                }
+            }
+
+            // Check if the schema is not valid and collect errors
+            if (!validate) {
+                validationErrors.push({
+                    file,
+                    errors: obj.$schema === 'http://json-schema.org/draft-04/schema'
+                    ? ajvDraft04.errors
+                    : ajv.errors
+                });
+            }
+        } catch (error) {
+            validationErrors.push({
+            file,
+            errors: [{ message: `\nError reading or parsing JSON Schema: ${error.message}` }]
+            });
+        }
+        });
+
+            // Print errors after processing all files
+        validationErrors.forEach(({ file, errors }) => {
+            console.error(`\n${file}: JSON Schema is not valid:`, errors);
+        });
+
+        // Exit with an error code if there are validation errors
+        if (validationErrors.length > 0) {
+            process.exit(1);
+        }
+
+    } catch (error) {
+        console.error('\nError during validation:', error.message);
+    }
+}
+
+
+const excludedFiles=['2.0.0-rc1.json', '2.0.0-rc1-without-$id.json']; // added temporarily to avoid validation failure due to these two files. The schemas version are incorrect in these and needs to be fixed.
+
+validation(excludedFiles);
+
+console.log('\nValidation completed successfully.');