0xray 3.4.1 → 3.4.3

package/scripts/node/sync-versions.mjs

@@ -1,140 +1,18 @@
 #!/usr/bin/env node
-
 /**
- * Version Sync Script
- *
- * Syncs version strings across all config and doc files to match package.json.
- * Called automatically by the release script after `npm version patch`.
- *
- * Append-only for docs — never overwrites existing content, only replaces
- * version strings in known patterns.
- *
- * Usage:
- *   node scripts/node/sync-versions.mjs          # dry run (prints changes)
- *   node scripts/node/sync-versions.mjs --apply   # apply changes
+ * @deprecated Use: node scripts/node/version-manager.mjs --artifacts-only
+ * SSOT for version strings is package.json (see reconcile-version.mjs).
  */
+import { execSync } from "child_process";
+import path from "path";
+import { fileURLToPath } from "url";
 
-import { readFileSync, writeFileSync, existsSync } from "fs";
-import { join } from "path";
-
-const root = process.cwd();
-const apply = process.argv.includes("--apply");
-
-function readPkgVersion() {
-  const pkg = JSON.parse(readFileSync(join(root, "package.json"), "utf-8"));
-  return pkg.version;
-}
-
-function replaceVersionInFile(filePath, patterns, newVersion) {
-  if (!existsSync(filePath)) {
-    return { file: filePath, skipped: true, reason: "not found" };
-  }
-
-  let content = readFileSync(filePath, "utf-8");
-  const oldContent = content;
-  let changes = 0;
-
-  for (const pattern of patterns) {
-    const regex = pattern(newVersion);
-    const matches = content.match(regex.regex);
-    if (matches) {
-      content = content.replace(regex.regex, regex.replacement);
-      changes += matches.length;
-    }
-  }
-
-  if (content !== oldContent && apply) {
-    writeFileSync(filePath, content, "utf-8");
-  }
-
-  return { file: filePath, changes, applied: apply };
-}
-
-function replaceJsonVersion(filePath, newVersion) {
-  return replaceVersionInFile(filePath, [
-    (v) => ({
-      regex: /"version"\s*:\s*"\d+\.\d+\.\d+"/g,
-      replacement: `"version": "${v}"`,
-    }),
-  ], newVersion);
-}
-
-function replaceMdVersion(filePath, newVersion) {
-  return replaceVersionInFile(filePath, [
-    (v) => ({
-      regex: /version-(\d+\.\d+\.\d+)/g,
-      replacement: `version-${v}`,
-    }),
-    (v) => ({
-      regex: /Version\*\*:\s*\d+\.\d+\.\d+/g,
-      replacement: `Version**: ${v}`,
-    }),
-    (v) => ({
-      regex: /v(\d+\.\d+\.\d+)/g,
-      replacement: `v${v}`,
-    }),
-    (v) => ({
-      regex: /\*\*Version\*\*:\s*\d+\.\d+\.\d+/g,
-      replacement: `**Version**: ${v}`,
-    }),
-    (v) => ({
-      regex: /"version":\s*"(\d+\.\d+\.\d+)"/g,
-      replacement: `"version": "${v}"`,
-    }),
-    (v) => ({
-      regex: /\d+\.\d+\.\d+(?=[^\d]*\.svg)/g,
-      replacement: v,
-    }),
-  ], newVersion);
-}
-
-function main() {
-  const newVersion = readPkgVersion();
-  console.log(`\n=== Version Sync: ${newVersion} ===\n`);
-  console.log(apply ? "Mode: APPLY" : "Mode: DRY RUN (use --apply to write)\n");
-
-  const results = [];
-
-  // Config JSON files (source of truth in src/opencode/)
-  const configFiles = [
-    "src/opencode/config.json",
-    "src/opencode/features.json",
-    "src/opencode/codex.codex",
-    "src/opencode/integrations.json",
-  ];
-
-  for (const file of configFiles) {
-    results.push(replaceJsonVersion(join(root, file), newVersion));
-  }
-
-  // Doc files
-  const docFiles = [
-    "AGENTS.md",
-    "AGENTS-full.md",
-    "docs/README.md",
-  ];
-
-  for (const file of docFiles) {
-    results.push(replaceMdVersion(join(root, file), newVersion));
-  }
-
-  // Report
-  let totalChanges = 0;
-  for (const r of results) {
-    if (r.skipped) {
-      console.log(`  SKIP  ${r.file} (${r.reason})`);
-    } else if (r.changes > 0) {
-      totalChanges += r.changes;
-      console.log(`  ${r.applied ? "FIX" : "DRY"}  ${r.file} (${r.changes} replacements)`);
-    } else {
-      console.log(`  OK    ${r.file}`);
-    }
-  }
+const rootDir = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "../..");
 
-  console.log(`\nTotal: ${totalChanges} version strings ${apply ? "updated" : "would update"}`);
-  if (!apply && totalChanges > 0) {
-    console.log("Run with --apply to write changes.");
-  }
-}
+console.warn("\n⚠️  sync-versions.mjs is deprecated.");
+console.warn("    Use: node scripts/node/version-manager.mjs --artifacts-only\n");
 
-main();
+execSync("node scripts/node/version-manager.mjs --artifacts-only", {
+  cwd: rootDir,
+  stdio: "inherit",
+});

package/scripts/node/universal-version-manager.js

@@ -651,6 +651,10 @@ const UPDATE_PATTERNS = [
   }
 
   async function standardizeVersions() {
+  console.warn("\n⚠️  universal-version-manager.js is DEPRECATED for releases.");
+  console.warn("    Use: npm run release:patch  or  npm run version:sync");
+  console.warn("    (version-manager.mjs --artifacts-only). Mass JSON version replace is disabled.\n");
+  return;
   console.log("🔧 Starting Universal Version Standardization");
   console.log(`📋 Framework: ${OFFICIAL_VERSIONS.framework.displayName}`);
   console.log(

package/scripts/node/validate-release-docs.mjs

@@ -0,0 +1,299 @@
+#!/usr/bin/env node
+/**
+ * validate-release-docs.mjs — Blocking guard for release doc freshness.
+ *
+ * Ensures README, AGENTS, SKILLS, CHANGELOG, Docusaurus headers, and required
+ * guides match package.json version and live framework counts before tag/publish.
+ *
+ * Usage:
+ *   node scripts/node/validate-release-docs.mjs
+ *   node scripts/node/validate-release-docs.mjs --json
+ */
+
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import {
+  buildDocsHeader,
+  DOCS_SITE_HEADER_FILES,
+  getFrameworkCounts,
+  getReleaseArtifactPaths,
+} from './version-manager.mjs';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const defaultRoot = path.resolve(__dirname, '../..');
+
+const STANDARD_HEADER_RE =
+  /^\*{0,2}v[\d.]+\*{0,2}\s*—\s*\d+ agents · \d+ skills · \d+ MCP servers? · \d+ codex terms(?: · [\d,]+ tests)?/m;
+
+/** Guides that must exist and reference the current release (body or header). */
+const REQUIRED_GUIDES = [
+  'docs-site/docs/guides/features-since-3.1.md',
+  'docs-site/docs/guides/features-json.md',
+  'docs-site/docs/guides/memory-routing.md',
+  'docs-site/docs/guides/aside-context.md',
+  'docs-site/docs/guides/repertoire.md',
+  'docs-site/docs/guides/integrations.md',
+  'docs-site/docs/guides/consumer-migration.md',
+  'docs-site/docs/mcp/README.md',
+  'docs-site/docs/agents/README.md',
+];
+
+const ROOT_DOC_CHECKS = [
+  {
+    rel: 'README.md',
+    validate: (content, version, counts, header) => {
+      const errors = [];
+      if (!content.includes(header)) {
+        errors.push(`missing or stale standard header (expected: ${header})`);
+      }
+      if (!content.includes('SKILLS.md')) {
+        errors.push('missing SKILLS.md reference in postinstall/docs section');
+      }
+      if (!content.includes('install-bridges') && !content.includes('installAllBridges')) {
+        errors.push('missing install-bridges / installAllBridges reference');
+      }
+      return errors;
+    },
+  },
+  {
+    rel: 'AGENTS.md',
+    validate: (content, version, counts) => {
+      const errors = [];
+      if (!content.includes(`**v${version}**`)) {
+        errors.push(`missing version marker **v${version}**`);
+      }
+      if (!content.includes(`${counts.agents} agents`)) {
+        errors.push(`expected ${counts.agents} agents in header`);
+      }
+      if (!content.includes(`${counts.skills} skills`)) {
+        errors.push(`expected ${counts.skills} skills in header`);
+      }
+      if (!content.includes('68 codex terms')) {
+        errors.push('expected 68 codex terms in header');
+      }
+      if (!content.includes('aside-context.md') && !content.includes('AsideContext')) {
+        errors.push('missing AsideContext documentation reference');
+      }
+      if (!content.includes('SKILLS.md')) {
+        errors.push('missing SKILLS.md link');
+      }
+      return errors;
+    },
+  },
+  {
+    rel: 'AGENTS-consumer.md',
+    validate: (content, version, counts) => {
+      const errors = [];
+      const expected = `**v${version}** — ${counts.mcps} MCP servers · ${counts.skills} skills · 68 codex terms`;
+      if (!content.includes(expected)) {
+        errors.push(`consumer header stale (expected substring: ${expected})`);
+      }
+      if (!content.includes('SKILLS.md')) {
+        errors.push('missing SKILLS.md in postinstall section');
+      }
+      if (!content.includes('AsideContext')) {
+        errors.push('missing AsideContext section');
+      }
+      return errors;
+    },
+  },
+  {
+    rel: 'SKILLS.md',
+    validate: (content, version, counts) => {
+      const errors = [];
+      const expected = `**v${version}** — **${counts.skills} skills**`;
+      if (!content.includes(expected)) {
+        errors.push(`header stale (expected: ${expected})`);
+      }
+      return errors;
+    },
+  },
+];
+
+function readFile(rootDir, rel) {
+  const full = path.join(rootDir, rel);
+  if (!fs.existsSync(full)) return null;
+  return fs.readFileSync(full, 'utf-8');
+}
+
+function getPackageVersion(rootDir) {
+  const pkg = JSON.parse(fs.readFileSync(path.join(rootDir, 'package.json'), 'utf-8'));
+  return pkg.version;
+}
+
+function getCodexTermCount(rootDir) {
+  const codexPath = path.join(rootDir, '.xray/codex.json');
+  if (!fs.existsSync(codexPath)) return null;
+  const codex = JSON.parse(fs.readFileSync(codexPath, 'utf-8'));
+  return Object.keys(codex.terms || {}).length;
+}
+
+function validateChangelog(content, version) {
+  const errors = [];
+  const first = content.match(/^## \[([^\]]+)\]/m);
+  if (!first) {
+    errors.push('no version sections found');
+    return errors;
+  }
+  if (first[1] !== version) {
+    errors.push(`top CHANGELOG entry is [${first[1]}], expected [${version}]`);
+  }
+  if (!content.includes(`## [${version}]`)) {
+    errors.push(`missing ## [${version}] section`);
+  }
+  return errors;
+}
+
+function validateStandardHeader(content, expectedHeader, label) {
+  const match = content.match(STANDARD_HEADER_RE);
+  if (!match) {
+    return [`${label}: no standard docs header line found`];
+  }
+  if (match[0] !== expectedHeader) {
+    return [`${label}: header is "${match[0]}", expected "${expectedHeader}"`];
+  }
+  return [];
+}
+
+function validateDocusaurusTagline(content, counts) {
+  const errors = [];
+  const expectedParts = [
+    `${counts.agents} agents`,
+    `${counts.skills} skills`,
+    `${counts.mcps} MCP servers`,
+    '68 codex terms',
+  ];
+  for (const part of expectedParts) {
+    if (!content.includes(part)) {
+      errors.push(`docusaurus.config.ts tagline missing "${part}"`);
+    }
+  }
+  return errors;
+}
+
+/**
+ * @param {string} [rootDir]
+ * @returns {{ ok: boolean; version: string; counts: object; errors: string[]; warnings: string[] }}
+ */
+export function validateReleaseDocs(rootDir = defaultRoot) {
+  const errors = [];
+  const warnings = [];
+  const version = getPackageVersion(rootDir);
+  const counts = getFrameworkCounts(rootDir);
+  const expectedHeader = buildDocsHeader(counts, version);
+  const codexTerms = getCodexTermCount(rootDir);
+
+  if (codexTerms !== null && codexTerms !== 68) {
+    warnings.push(`codex.json has ${codexTerms} terms (docs reference 68)`);
+  }
+
+  const changelog = readFile(rootDir, 'CHANGELOG.md');
+  if (!changelog) {
+    errors.push('CHANGELOG.md missing');
+  } else {
+    errors.push(...validateChangelog(changelog, version).map((e) => `CHANGELOG.md: ${e}`));
+  }
+
+  for (const check of ROOT_DOC_CHECKS) {
+    const content = readFile(rootDir, check.rel);
+    if (!content) {
+      errors.push(`${check.rel}: file missing`);
+      continue;
+    }
+    const relErrors = check.validate(content, version, counts, expectedHeader);
+    for (const e of relErrors) {
+      errors.push(`${check.rel}: ${e}`);
+    }
+  }
+
+  for (const rel of DOCS_SITE_HEADER_FILES) {
+    const content = readFile(rootDir, rel);
+    if (!content) {
+      errors.push(`${rel}: file missing`);
+      continue;
+    }
+    errors.push(...validateStandardHeader(content, expectedHeader, rel));
+  }
+
+  for (const rel of REQUIRED_GUIDES) {
+    const content = readFile(rootDir, rel);
+    if (!content) {
+      errors.push(`${rel}: required guide missing`);
+      continue;
+    }
+    if (content.trim().length < 200) {
+      errors.push(`${rel}: guide too short — likely stub`);
+    }
+    if (rel.includes('features-since-3.1') && !content.includes(version)) {
+      errors.push(`${rel}: must reference current version ${version}`);
+    }
+  }
+
+  const docusaurus = readFile(rootDir, 'docs-site/docusaurus.config.ts');
+  if (!docusaurus) {
+    errors.push('docs-site/docusaurus.config.ts: missing');
+  } else {
+    errors.push(...validateDocusaurusTagline(docusaurus, counts));
+  }
+
+  for (const rel of getReleaseArtifactPaths()) {
+    if (!fs.existsSync(path.join(rootDir, rel))) {
+      errors.push(`release artifact path missing: ${rel}`);
+    }
+  }
+
+  return {
+    ok: errors.length === 0,
+    version,
+    counts,
+    errors,
+    warnings,
+  };
+}
+
+function main() {
+  const jsonOut = process.argv.includes('--json');
+  const result = validateReleaseDocs();
+
+  if (!jsonOut) {
+    console.log('\n╔════════════════════════════════════════════════════════╗');
+    console.log('║        📚 Release Docs Validation                      ║');
+    console.log('╚════════════════════════════════════════════════════════╝');
+    console.log(`\n📌 package.json version: v${result.version}`);
+    console.log(
+      `📊 counts: ${result.counts.agents} agents · ${result.counts.skills} skills · ${result.counts.mcps} MCP servers\n`,
+    );
+  }
+
+  if (result.warnings.length > 0 && !jsonOut) {
+    console.log('⚠️  Warnings:');
+    for (const w of result.warnings) console.log(`   - ${w}`);
+    console.log();
+  }
+
+  if (!result.ok) {
+    if (jsonOut) {
+      console.log(JSON.stringify(result, null, 2));
+    } else {
+      console.error('❌ Release docs validation FAILED:\n');
+      for (const e of result.errors) console.error(`   • ${e}`);
+      console.error('\nFix docs then run: npm run version:sync');
+      console.error('Or: node scripts/node/validate-release-docs.mjs\n');
+    }
+    process.exit(1);
+  }
+
+  if (jsonOut) {
+    console.log(JSON.stringify(result, null, 2));
+  } else {
+    console.log('✅ Release docs validation passed\n');
+  }
+}
+
+const isMain =
+  process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url);
+
+if (isMain) {
+  main();
+}