bmad-method-test-architecture-enterprise 1.2.2 → 1.2.5

package/tools/validate-tea-workflow-descriptions.js

@@ -0,0 +1,108 @@
+/**
+ * Validate TEA workflow description quote style for Gemini compatibility.
+ *
+ * Rules for TEA workflow YAML files under src/workflows/testarch/<workflow>/workflow.yaml:
+ * - `description:` must be a single-line YAML scalar on one line
+ * - the raw YAML scalar must be wrapped in single quotes
+ * - parsed description text must not contain single-quote characters
+ *   (use double quotes for examples, e.g. "quote here")
+ *
+ * Usage: node tools/validate-tea-workflow-descriptions.js [project_root]
+ * Exit codes: 0 = success, 1 = validation failures
+ */
+
+const fs = require('node:fs');
+const path = require('node:path');
+const { glob } = require('glob');
+const yaml = require('yaml');
+
+/**
+ * @param {string} filePath
+ * @param {string} projectRoot
+ * @returns {string[]}
+ */
+function validateFile(filePath, projectRoot) {
+  const errors = [];
+  const relativePath = path.relative(projectRoot, filePath).replaceAll('\\', '/');
+  let content;
+  try {
+    content = fs.readFileSync(filePath, 'utf8');
+  } catch (error) {
+    return [`${relativePath}: Failed to read file: ${error.message}`];
+  }
+  /** @type {string | undefined} */
+  let parsedDescription;
+
+  try {
+    const parsed = yaml.parse(content);
+    if (!parsed || typeof parsed.description !== 'string') {
+      errors.push('YAML parsed but `description` is missing or not a string');
+    } else {
+      parsedDescription = parsed.description;
+    }
+  } catch (error) {
+    errors.push(`YAML parse error: ${error.message}`);
+    return [`${relativePath}: ${errors[0]}`];
+  }
+
+  const descriptionMatch = content.match(/^\s*description:\s*(?:'((?:''|[^'])*)'|"((?:\\"|[^"])*)")\s*(?:#.*)?$/m);
+  if (descriptionMatch) {
+    const singleQuotedInner = descriptionMatch[1];
+    const doubleQuotedInner = descriptionMatch[2];
+    const quote = singleQuotedInner === undefined ? '"' : "'";
+
+    if (quote !== "'") {
+      errors.push('`description:` value must be wrapped in single quotes');
+    }
+  } else {
+    if (/^\s*description:\s*/m.test(content)) {
+      errors.push('`description:` value must be wrapped in single quotes');
+    } else {
+      errors.push('Missing single-line `description:` field');
+    }
+  }
+
+  if (typeof parsedDescription === 'string' && parsedDescription.includes("'")) {
+    errors.push('Parsed `description` contains a single quote character; use double quotes for examples');
+  }
+
+  return errors.map((error) => `${relativePath}: ${error}`);
+}
+
+async function main(customProjectRoot) {
+  const projectRoot = customProjectRoot || path.join(__dirname, '..');
+  const files = await glob('src/workflows/testarch/*/workflow.yaml', {
+    cwd: projectRoot,
+    absolute: true,
+  });
+
+  if (files.length === 0) {
+    console.error('No TEA workflow YAML files found at src/workflows/testarch/*/workflow.yaml');
+    process.exit(1);
+  }
+
+  /** @type {string[]} */
+  const failures = [];
+
+  for (const filePath of files.sort()) {
+    failures.push(...validateFile(filePath, projectRoot));
+  }
+
+  if (failures.length > 0) {
+    console.error('TEA workflow description quote validation failed:\n');
+    for (const failure of failures) {
+      console.error(`- ${failure}`);
+    }
+    console.error('\nExpected format example:');
+    console.error(`description: 'Generate traceability, example "quote here"'`);
+    process.exit(1);
+  }
+
+  console.log(`Validated TEA workflow description quoting in ${files.length} file(s).`);
+}
+
+const customProjectRoot = process.argv[2];
+main(customProjectRoot).catch((error) => {
+  console.error('Fatal error:', error);
+  process.exit(1);
+});