Merge pull request #146 from geeksblabla/feat/add-yaml-validation

Add YAML validation for survey files

Author: yjose

package.json

@@ -5,15 +5,16 @@
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",
-    "build": "astro check && astro build",
-    "check": "rimraf dist && astro check",
+    "build": "pnpm validate-survey && astro check && astro build",
+    "check": "rimraf dist && pnpm validate-survey && astro check",
     "preview": "astro preview",
     "astro": "astro",
     "test": "vitest",
     "test:ui": "vitest --ui",
     "test:ci": "vitest --coverage.enabled true",
     "lint": "prettier --write  \"**/*.{js,jsx,ts,tsx,md,mdx,astro}\" && eslint --fix \"src/**/*.{js,ts,jsx,tsx,astro}\"",
     "lint:ci": "eslint \"src/**/*.{js,ts,jsx,tsx,astro}\"",
+    "validate-survey": "tsx ./scripts/validate-survey.ts",
     "prepare": "husky",
     "export-results": " tsx --env-file=.env.local ./scripts/export-results.ts",
     "export-results:ci": " tsx  ./scripts/export-results.ts"
@@ -52,7 +53,8 @@
     "tailwindcss": "^3.4.4",
     "tailwindcss-animate": "^1.0.7",
     "typescript": "^5.4.5",
-    "xstate": "^5.24.0"
+    "xstate": "^5.24.0",
+    "zod": "^4.1.13"
   },
   "devDependencies": {
     "@rollup/plugin-yaml": "^4.1.2",

pnpm-lock.yaml

@@ -2,35 +2,59 @@
 
 import yaml from "js-yaml";
 import fs from "fs";
+import path from "path";
+import {
+  validateAllSurveyFiles,
+  formatValidationReport
+} from "../src/lib/validators/survey-validator";
+import type {
+  SurveyQuestion,
+  SurveyQuestionsYamlFile
+} from "../src/lib/validators/survey-schema";
+import { SURVEY_DIR } from "../src/lib/validators/constants";
 
 const generate = async () => {
+  console.log("Starting survey questions generation...\n");
+
+  // Phase 1: Validate all survey files
+  console.log("Phase 1: Validating all survey YAML files...");
+  const validationReport = validateAllSurveyFiles(SURVEY_DIR);
+
+  console.log(formatValidationReport(validationReport));
+
+  if (!validationReport.success) {
+    console.error(
+      "\n❌ Validation failed! Please fix the errors above before generating questions.json"
+    );
+    process.exit(1);
+  }
+
+  console.log("✓ All survey files validated successfully!\n");
+
+  // Phase 2: Generate questions.json
+  console.log("Phase 2: Generating questions.json...");
+
   const QS: Record<string, SurveyQuestion> = {};
-  // Get document, or throw exception on error
+
   try {
-    const profile = (await yaml.load(
-      fs.readFileSync("./survey/1-profile.yml", "utf8")
-    )) as SurveyQuestionsYamlFile;
-    const learning = (await yaml.load(
-      fs.readFileSync("./survey/2-learning-and-education.yml", "utf8")
-    )) as SurveyQuestionsYamlFile;
-    const work = (await yaml.load(
-      fs.readFileSync("./survey/3-work.yml", "utf8")
-    )) as SurveyQuestionsYamlFile;
-    const ai = (await yaml.load(
-      fs.readFileSync("./survey/4-ai.yml", "utf8")
-    )) as SurveyQuestionsYamlFile;
-    const tech = (await yaml.load(
-      fs.readFileSync("./survey/5-tech.yml", "utf8")
-    )) as SurveyQuestionsYamlFile;
-    const community = (await yaml.load(
-      fs.readFileSync("./survey/6-community.yml", "utf8")
-    )) as SurveyQuestionsYamlFile;
-    const data = [profile, learning, work, tech, ai, community];
+    const files = fs
+      .readdirSync(SURVEY_DIR)
+      .filter((file) => file.endsWith(".yml"))
+      .sort();
+
+    const data: SurveyQuestionsYamlFile[] = [];
+
+    for (const file of files) {
+      const filepath = path.join(SURVEY_DIR, file);
+      const content = fs.readFileSync(filepath, "utf8");
+      const parsed = yaml.load(content) as SurveyQuestionsYamlFile;
+      data.push(parsed);
+    }
 
     data.forEach(({ label, questions }) => {
       questions.forEach((element, index: number) => {
         const id = `${label}-q-${index}`;
-        console.log(id);
+        console.log(`  Generated: ${id}`);
         QS[id] = {
           ...element,
           multiple: element.multiple ?? false, // default to false
@@ -41,9 +65,12 @@ const generate = async () => {
 
     writeToFile("./scripts/questions.json", QS);
 
-    console.log(QS);
+    console.log(
+      `\n✓ Successfully generated ${Object.keys(QS).length} questions`
+    );
   } catch (e) {
-    console.log(e);
+    console.error("\n❌ Error generating questions:", e);
+    process.exit(1);
   }
 };
 

scripts/generate-questions.ts

@@ -0,0 +1,28 @@
+/**
+ * Standalone script to validate all survey YAML files
+ * This can be run independently or as part of the build process
+ */
+
+import {
+  validateAllSurveyFiles,
+  formatValidationReport
+} from "../src/lib/validators/survey-validator";
+import { SURVEY_DIR } from "../src/lib/validators/constants";
+
+async function main() {
+  console.log("🔍 Validating survey YAML files...\n");
+
+  const validationReport = validateAllSurveyFiles(SURVEY_DIR);
+
+  console.log(formatValidationReport(validationReport));
+
+  if (validationReport.success) {
+    console.log("\n✓ All validations passed!");
+    process.exit(0);
+  } else {
+    console.error("\n❌ Validation failed! Please fix the errors above.");
+    process.exit(1);
+  }
+}
+
+main();

scripts/validate-survey.ts

@@ -1,12 +1,30 @@
 ---
-import profileQuestions from "@/survey/1-profile.yml";
-import learningQuestions from "@/survey/2-learning-and-education.yml";
-import workQuestion from "@/survey/3-work.yml";
-import aiQuestion from "@/survey/4-ai.yml";
-import techQuestion from "@/survey/5-tech.yml";
-import communityQuestion from "@/survey/6-community.yml";
+import profileQuestionsRaw from "@/survey/1-profile.yml";
+import learningQuestionsRaw from "@/survey/2-learning-and-education.yml";
+import workQuestionRaw from "@/survey/3-work.yml";
+import aiQuestionRaw from "@/survey/4-ai.yml";
+import techQuestionRaw from "@/survey/5-tech.yml";
+import communityQuestionRaw from "@/survey/6-community.yml";
 import { SurveyApp } from "./survey-app";
 import ExitPopup from "./exit-popup.astro";
+import { validateSurveyFile } from "@/lib/validators/survey-schema";
+
+// Validate each YAML file to ensure data integrity
+const profileQuestions = validateSurveyFile(
+  profileQuestionsRaw,
+  "1-profile.yml"
+);
+const learningQuestions = validateSurveyFile(
+  learningQuestionsRaw,
+  "2-learning-and-education.yml"
+);
+const workQuestion = validateSurveyFile(workQuestionRaw, "3-work.yml");
+const aiQuestion = validateSurveyFile(aiQuestionRaw, "4-ai.yml");
+const techQuestion = validateSurveyFile(techQuestionRaw, "5-tech.yml");
+const communityQuestion = validateSurveyFile(
+  communityQuestionRaw,
+  "6-community.yml"
+);
 
 const questions = [
   profileQuestions,

src/components/survey/index.astro

@@ -0,0 +1,26 @@
+export const SURVEY_DIR = "./survey";
+
+export const VALIDATION_THRESHOLDS = {
+  MIN_LABEL_LENGTH: 3,
+  MAX_LABEL_LENGTH: 500,
+  MIN_TITLE_LENGTH: 2,
+  MAX_CHOICE_LENGTH: 200,
+  MIN_CHOICES: 2,
+  MAX_CHOICES_WARNING: 30,
+  MIN_QUESTIONS_WARNING: 2,
+  MAX_QUESTIONS_WARNING: 20,
+  OPTIONAL_RATIO_WARNING: 0.5
+} as const;
+
+export enum ValidationSeverity {
+  ERROR = "error",
+  WARNING = "warning",
+  INFO = "info"
+}
+
+export interface ValidationError {
+  severity: ValidationSeverity;
+  message: string;
+  path?: string;
+  value?: unknown;
+}