@ramathibodi/nuxt-commons 4.0.12 → 4.0.13

package/scripts/validate-document-template.mjs

@@ -0,0 +1,158 @@
+#!/usr/bin/env node
+/**
+ * Codegen-style validator for Document Template JSON.
+ *
+ * Usage:
+ *   node scripts/validate-document-template.mjs [file|glob ...] [options]
+ *   cat template.json | node scripts/validate-document-template.mjs
+ *
+ * Options:
+ *   --strict   Promote builder-unsafe warnings to errors (exit 1 on them too).
+ *   --json     Emit machine-readable JSON: [{ file, result }].
+ *   --quiet    Print errors only (suppress warnings and infos).
+ *   -h, --help Show this help.
+ *
+ * Exit code: 1 if any input has errors (warnings count as errors under --strict),
+ * otherwise 0.
+ *
+ * Shares the exact validation core used by the `useDocumentTemplate` runtime via
+ * jiti (the TypeScript loader Nuxt already ships), so the CLI and the composable
+ * can never diverge.
+ */
+import { readFileSync } from 'node:fs'
+import { fileURLToPath } from 'node:url'
+import { dirname, resolve, relative } from 'node:path'
+import process from 'node:process'
+import { createJiti } from 'jiti'
+
+const dir = dirname(fileURLToPath(import.meta.url))
+const repoRoot = resolve(dir, '..')
+
+const jiti = createJiti(import.meta.url)
+const { validateDocumentTemplate } = await jiti.import(
+  resolve(repoRoot, 'src/runtime/composables/document/validateTemplate.ts'),
+)
+
+// --- arg parsing -----------------------------------------------------------
+const argv = process.argv.slice(2)
+const flags = new Set(argv.filter(a => a.startsWith('-')))
+const files = argv.filter(a => !a.startsWith('-'))
+
+if (flags.has('-h') || flags.has('--help')) {
+  printHelp()
+  process.exit(0)
+}
+
+const strict = flags.has('--strict')
+const asJson = flags.has('--json')
+const quiet = flags.has('--quiet')
+
+// --- input collection ------------------------------------------------------
+/** @type {{ file: string, content: string }[]} */
+const inputs = []
+
+if (files.length === 0) {
+  const stdin = readFileSync(0, 'utf8')
+  if (!stdin.trim()) {
+    console.error('No input: pass file paths/globs or pipe JSON via stdin.')
+    process.exit(2)
+  }
+  inputs.push({ file: '<stdin>', content: stdin })
+}
+else {
+  const resolved = await expandGlobs(files)
+  if (resolved.length === 0) {
+    console.error(`No files matched: ${files.join(', ')}`)
+    process.exit(2)
+  }
+  for (const f of resolved) {
+    try {
+      inputs.push({ file: f, content: readFileSync(f, 'utf8') })
+    }
+    catch (e) {
+      console.error(`Cannot read ${f}: ${e.message}`)
+      process.exit(2)
+    }
+  }
+}
+
+// --- validation ------------------------------------------------------------
+const results = inputs.map(({ file, content }) => ({
+  file,
+  result: validateDocumentTemplate(content, { strict }),
+}))
+
+const hadErrors = results.some(r => !r.result.valid)
+
+if (asJson) {
+  const rel = f => (f === '<stdin>' ? f : relative(repoRoot, resolve(f)))
+  console.log(JSON.stringify(results.map(r => ({ file: rel(r.file), result: r.result })), null, 2))
+  process.exit(hadErrors ? 1 : 0)
+}
+
+// --- human report ----------------------------------------------------------
+let totalErrors = 0
+let totalWarnings = 0
+let totalInfos = 0
+
+for (const { file, result } of results) {
+  const shown = quiet ? result.errors : result.issues
+  totalErrors += result.errors.length
+  totalWarnings += result.warnings.length
+  totalInfos += result.infos.length
+
+  const status = result.valid ? (result.warnings.length ? 'WARN' : 'OK') : 'FAIL'
+  console.log(`\n${status}  ${file}`)
+  if (shown.length === 0) {
+    if (!quiet) console.log('  no issues')
+    continue
+  }
+  for (const issue of shown) {
+    const tag = issue.severity.toUpperCase().padEnd(7)
+    const loc = issue.path || '(root)'
+    console.log(`  ${tag} ${loc}  ${issue.code}  ${issue.message}`)
+  }
+}
+
+console.log(
+  `\n${results.length} file(s): ${totalErrors} error(s), ${totalWarnings} warning(s), ${totalInfos} info(s)`
+  + (strict ? '  [strict]' : ''),
+)
+
+process.exit(hadErrors ? 1 : 0)
+
+// --- helpers ---------------------------------------------------------------
+async function expandGlobs(patterns) {
+  const out = []
+  for (const p of patterns) {
+    if (/[*?[\]{}]/.test(p)) {
+      try {
+        const { glob } = await import('node:fs/promises')
+        for await (const entry of glob(p)) out.push(entry)
+      }
+      catch {
+        console.error(`Globbing not supported in this Node version for "${p}"; pass explicit file paths.`)
+        process.exit(2)
+      }
+    }
+    else {
+      out.push(p)
+    }
+  }
+  // De-dupe while preserving order.
+  return [...new Set(out)]
+}
+
+function printHelp() {
+  console.log(`Validate Document Template JSON.
+
+Usage:
+  node scripts/validate-document-template.mjs [file|glob ...] [options]
+  cat template.json | node scripts/validate-document-template.mjs
+
+Options:
+  --strict   Promote builder-unsafe warnings to errors.
+  --json     Emit machine-readable JSON.
+  --quiet    Print errors only.
+  -h, --help Show this help.`)
+}