XS⚠️ ◾ Validating all frontmatter for issues

.github/workflows/validate-frontmatter-all.yml

@@ -0,0 +1,49 @@
+name: Validate-Frontmatter-in-All-Rules
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  validate-all-frontmatter:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+
+      - name: Find all Markdown files in rules
+        run: |
+          find rules -type f -name '*.md' > all_rules_files.txt
+          echo "Found Markdown files:"
+          cat all_rules_files.txt
+
+      - name: Install dependencies
+        run: |
+          cd scripts/frontmatter-validator
+          npm install
+
+      - name: Validate Frontmatter in Rule Files
+        id: validate_frontmatter
+        run: |
+          node scripts/frontmatter-validator/frontmatter-validator.js --file all_rules_files.txt > validation_results.txt
+
+      - name: Create Job Summary
+        if: always()
+        run: |
+          echo "## Frontmatter Validation Issues" >> $GITHUB_STEP_SUMMARY
+          if [ -s validation_results.txt ]; then
+            cat validation_results.txt >> $GITHUB_STEP_SUMMARY
+          else
+            echo "No validation issues detected." >> $GITHUB_STEP_SUMMARY
+          fi
+

scripts/frontmatter-validator/frontmatter-validator.js

@@ -1,14 +1,16 @@
-const fs = require('fs');
-const ajv = require('ajv');
-const yaml = require('js-yaml');
-const addFormats = require('ajv-formats');
-const ajvErrors = require('ajv-errors');
+const fs = require("fs");
+const ajv = require("ajv");
+const yaml = require("js-yaml");
+const addFormats = require("ajv-formats");
+const ajvErrors = require("ajv-errors");
+
+let allErrors = [];
 
 const schemas = {
-  rule: loadSchema('./schema/rule-schema.json'),
-  category: loadSchema('./schema/category-schema.json'),
-  top_category: loadSchema('./schema/top-category-schema.json'),
-}
+  rule: loadSchema("schema/rule-schema.json"),
+  category: loadSchema("schema/category-schema.json"),
+  top_category: loadSchema("schema/top-category-schema.json"),
+};
 
 const validator = initializeValidator();
 
@@ -25,53 +27,60 @@ function initializeValidator() {
 }
 
 function loadSchema(schemaPath) {
-  return JSON.parse(fs.readFileSync(schemaPath, 'utf8'));
+  const args = process.argv.slice(2);
+  let fullPath = `scripts/frontmatter-validator/${schemaPath}`;
+  fullPath = args.includes("--file")
+    ? `scripts/frontmatter-validator/${schemaPath}`
+    : schemaPath;
+
+  // todo fix for non file input
+  const json = JSON.parse(fs.readFileSync(fullPath, "utf8"));
+  return json;
 }
 
 function matchSchema(filePath) {
-  if (filePath.endsWith('rule.md')) {
-    return validator.getSchema('rule');
-  } else if (filePath.indexOf('/categories') !== -1 && !filePath.endsWith('index.md')) {
-    return validator.getSchema('category');
-  } else if (filePath.indexOf('/categories') !== -1 && filePath.endsWith('index.md')) {
-    return validator.getSchema('top_category');
+  if (filePath.endsWith("rule.md")) {
+    return validator.getSchema("rule");
+  } else if (
+    filePath.indexOf("/categories") !== -1 &&
+    !filePath.endsWith("index.md")
+  ) {
+    return validator.getSchema("category");
+  } else if (
+    filePath.indexOf("/categories") !== -1 &&
+    filePath.endsWith("index.md")
+  ) {
+    return validator.getSchema("top_category");
   }
 }
 
 function validateFrontmatter(filePath) {
-  if (filePath.indexOf('.github') !== -1) {
-    return
-  }
-
-  if (!fs.existsSync(filePath)) {
-    console.error(`File ${filePath} does not exist.`);
-    return
+  if (!fs.existsSync(filePath) || filePath.indexOf(".github") !== -1) {
+    return; // Skip if file does not exist or is in .github directory
   }
 
-  const fileContents = fs.readFileSync(filePath, 'utf8');
+  const fileContents = fs.readFileSync(filePath, "utf8");
   const frontmatter = parseFrontmatter(filePath, fileContents);
-
   const validate = matchSchema(filePath);
   const isValid = validate(frontmatter);
 
   if (!isValid && validate.errors) {
-    const errorList = validate.errors.filter(error => {
-      return error.keyword === 'errorMessage' || error.keyword === 'required'
-    })
-
-    if (errorList.length >= 1) {
-      console.log(`Invalid Frontmatter detected in ${filePath.replaceAll('../', '')}, please fix the following issues:`);
-      errorList.forEach((error, index) => {
-        console.log(`${index + 1}. ${error.message}`);
-      })
-      process.exit(1);
+    let fileErrors = validate.errors
+      .filter(
+        (error) =>
+          error.keyword === "errorMessage" || error.keyword === "required"
+      )
+      .map((error) => error.message);
+
+    if (fileErrors.length > 0) {
+      allErrors.push({ filePath, fileErrors });
     }
   }
 }
 
 function parseFrontmatter(filePath, fileContents) {
-  if (!fileContents) return {}
-  
+  if (!fileContents) return {};
+
   try {
     const frontmatterMatch = /^---([\s\S]*?)---/.exec(fileContents);
     const frontmatterString = frontmatterMatch[1];
@@ -80,26 +89,58 @@ function parseFrontmatter(filePath, fileContents) {
     });
     return frontmatter;
   } catch (error) {
-    console.log(`Invalid Frontmatter detected in ${filePath.replaceAll('../', '')}: missing '---'`);
-    process.exit(1);
+    allErrors.push({
+      filePath,
+      fileErrors: ["missing '---'"],
+    });
   }
 }
 
-function main() {
-  const eventType = process.env.GITHUB_EVENT_NAME;
+function validateFiles(fileListPath) {
+  const fileContents = fs.readFileSync(fileListPath, "utf8");
+  const filePaths = fileContents.trim().split("\n");
 
-  if (eventType === 'pull_request') {
-    const filesChanged  = process.argv[2];
+  filePaths.forEach((file) => {
+    if (file.endsWith(".md")) {
+      validateFrontmatter(file);
+    }
+  });
+}
 
+function main() {
+  const args = process.argv.slice(2);
+
+  if (args.includes("--file")) {
+    const fileListIndex = args.indexOf("--file") + 1;
+    const fileListPath = args[fileListIndex];
+    validateFiles(fileListPath);
+  } else {
+    const filesChanged = args[0];
     if (filesChanged) {
-      const folders = filesChanged
-        .split(',')
-        .filter((file) => file.endsWith('.md'))
+      const filePaths = filesChanged
+        .split(",")
+        .filter((file) => file.endsWith(".md"))
         .map((file) => `../../${file}`);
-
-      folders.forEach((file) => validateFrontmatter(file));
+      filePaths.forEach(validateFrontmatter);
     }
   }
+
+  if (allErrors.length === 0) {
+    console.log("No frontmatter validation errors found.");
+    return;
+  }
+
+
+  allErrors.forEach(({ filePath, fileErrors }) => {
+    console.log(`## Rule: [${filePath}](https://github.com/SSWConsulting/SSW.Rules.Content/tree/main/${filePath})\n`);
+    console.log("Issues:");
+    fileErrors.forEach((issue) => console.log(`- **${issue}**`));
+    console.log("\n");
+    console.log("\n");
+  });
+  process.exit(1);
+
+  process.exit(1);
 }
 
 main();