@synergyerp/frontend-standards 1.6.2 → 1.6.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synergyerp/frontend-standards",
-  "version": "1.6.2",
+  "version": "1.6.3",
   "description": "SynergyERP frontend standards — ESLint, Prettier, commitlint, Husky, Vitest, TypeScript configs, modularization enforcement, and PR templates.",
   "private": false,
   "type": "module",
@@ -78,8 +78,9 @@
     "lint": "eslint .",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "check-modularization": "node scripts/check-modularization.mjs; exit 0",
-    "check-types": "tsc --noEmit; exit 0",
+    "check-modularization": "node scripts/check-modularization.mjs",
+    "check-types": "tsc --noEmit",
+    "check-documentation": "node scripts/check-documentation.mjs",
     "test:ci": "exit 0",
     "test": "exit 0"
   }

package/scripts/check-documentation.mjs

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+/**
+ * Documentation Validation Script
+ * Validates that child projects in apps/* have required documentation files
+ * with minimum content size to prevent empty/blank documentation.
+ */
+
+import fs from 'fs';
+import path from 'path';
+
+const MIN_DOC_SIZE = 500; // Minimum bytes for documentation files
+const REQUIRED_DOCS = [
+  'README.md',
+  'REQUIREMENTS.md',
+  'WORKFLOW.md'
+];
+
+const APPS_DIR = 'apps';
+
+function checkDocumentation(projectRoot = '.') {
+  const appsPath = path.join(projectRoot, APPS_DIR);
+  
+  if (!fs.existsSync(appsPath)) {
+    console.log('✅ No apps/ directory found - skipping documentation check');
+    return { valid: true, errors: [] };
+  }
+
+  const apps = fs.readdirSync(appsPath).filter(name => {
+    const fullPath = path.join(appsPath, name);
+    return fs.statSync(fullPath).isDirectory();
+  });
+
+  if (apps.length === 0) {
+    console.log('✅ No child projects found in apps/ - skipping documentation check');
+    return { valid: true, errors: [] };
+  }
+
+  const errors = [];
+  let valid = true;
+
+  for (const app of apps) {
+    const appPath = path.join(appsPath, app);
+    
+    for (const docFile of REQUIRED_DOCS) {
+      const docPath = path.join(appPath, docFile);
+      
+      if (!fs.existsSync(docPath)) {
+        errors.push(`❌ ${app}/${docFile}: Missing required documentation file`);
+        valid = false;
+        continue;
+      }
+
+      const stats = fs.statSync(docPath);
+      if (stats.size < MIN_DOC_SIZE) {
+        errors.push(
+          `❌ ${app}/${docFile}: Documentation too small (${stats.size} bytes, minimum ${MIN_DOC_SIZE} bytes)`
+        );
+        valid = false;
+        continue;
+      }
+
+      // Check for meaningful content (not just whitespace)
+      const content = fs.readFileSync(docPath, 'utf-8').trim();
+      if (content.length < MIN_DOC_SIZE / 2) {
+        errors.push(
+          `❌ ${app}/${docFile}: Documentation appears to be mostly whitespace (${content.length} chars after trim)`
+        );
+        valid = false;
+        continue;
+      }
+
+      console.log(`✅ ${app}/${docFile}: Valid (${stats.size} bytes)`);
+    }
+  }
+
+  return { valid, errors };
+}
+
+function main() {
+  console.log('📚 Checking child project documentation...\n');
+  
+  const projectRoot = process.argv[2] || '.';
+  const { valid, errors } = checkDocumentation(projectRoot);
+
+  if (!valid) {
+    console.log('\n❌ Documentation validation failed:');
+    errors.forEach(err => console.log(`  ${err}`));
+    console.log('\n💡 Each child project in apps/* must have:');
+    console.log('   - README.md (project overview & setup)');
+    console.log('   - REQUIREMENTS.md (functional & technical requirements)');
+    console.log('   - WORKFLOW.md (user flows, business processes, API interactions)');
+    console.log(`\n   Minimum size: ${MIN_DOC_SIZE} bytes per file`);
+    process.exit(1);
+  } else {
+    console.log('\n✅ All child project documentation validated successfully');
+  }
+}
+
+main();