@blockrun/clawrouter 0.12.264 → 0.12.266

package/scripts/sync-brand-numbers.mjs

@@ -1,270 +0,0 @@
-#!/usr/bin/env node
-/**
- * Sync marketing numbers from BlockRun's canonical brand artifact.
- *
- * This file is copied byte-for-byte into every public repo as
- * scripts/sync-brand-numbers.mjs. It is a copy rather than an npm package on
- * purpose: a package would mean 37 dependency bumps, and several consuming
- * repos have no package.json at all. Zero dependencies, plain Node.
- *
- *   node scripts/sync-brand-numbers.mjs            rewrite markers in place
- *   node scripts/sync-brand-numbers.mjs --check    exit 1 on drift, write nothing
- *   node scripts/sync-brand-numbers.mjs --refresh  re-fetch the artifact first
- *
- * --check NEVER touches the network. PR CI must be deterministic and offline:
- * if it fetched, a deploy in progress would fail every repo in the org at once.
- * Freshness is the fan-out job's problem, not the pull request's.
- *
- * Markers look like:  <!-- br:models.chatVisible -->66<!-- /br:models.chatVisible -->
- * and wrap the WHOLE token, so a badge URL, its alt text and the prose number
- * can all regenerate from one key.
- */
-import { existsSync, lstatSync, readFileSync, writeFileSync, readdirSync } from "node:fs";
-import { join, relative, extname } from "node:path";
-
-const ROOT = process.cwd();
-const SNAPSHOT = join(ROOT, "brand-numbers.json");
-// ORIGIN is tried first because it IS the truth — the mirror can only ever be
-// as fresh as the last time someone refreshed it. The mirror exists so a repo
-// can still sync while blockrun.ai is down, not to front the origin.
-//
-// The mirror is awesome-blockrun's own brand-numbers.json: that repo consumes
-// the artifact like every other, and its snapshot doubles as the org's copy.
-// One file, one role per repo, nothing to keep in step by hand.
-const ORIGIN = "https://blockrun.ai/brand/numbers.json";
-const MIRROR =
-  "https://raw.githubusercontent.com/BlockRunAI/awesome-blockrun/main/brand-numbers.json";
-
-const argv = new Set(process.argv.slice(2));
-const check = argv.has("--check");
-const refresh = argv.has("--refresh");
-
-const SKIP_DIRS = new Set([
-  "node_modules", ".git", "dist", "build", "out", ".next", "coverage",
-  "vendor", "target", "__pycache__", ".venv", "venv",
-]);
-// .txt is here for llms.txt, which is a first-class marketing surface: it is
-// what agents read to find out what BlockRun serves. Scanning other .txt files
-// costs a read and changes nothing — only files with markers are ever written.
-const TEXT_EXT = new Set([".md", ".mdx", ".txt"]);
-
-/* ── 1. numbers ──────────────────────────────────────────────────────────── */
-
-async function loadNumbers() {
-  if (!refresh) {
-    try {
-      return JSON.parse(readFileSync(SNAPSHOT, "utf8"));
-    } catch {
-      fail(
-        `no brand-numbers.json in ${ROOT}\n` +
-          `  run with --refresh once to seed it from ${ORIGIN}`,
-      );
-    }
-  }
-  for (const url of [ORIGIN, MIRROR]) {
-    try {
-      const res = await fetch(url, { signal: AbortSignal.timeout(10_000) });
-      if (!res.ok) continue;
-      const json = await res.json();
-      writeFileSync(SNAPSHOT, `${JSON.stringify(json, null, 2)}\n`);
-      return json;
-    } catch {
-      /* try the next source */
-    }
-  }
-  fail(`could not refresh from ${MIRROR} or ${ORIGIN}`);
-}
-
-/** Flatten nested numbers into dotted keys, ignoring $comment / rationale prose. */
-function flatten(obj, prefix = "") {
-  return Object.entries(obj).flatMap(([k, v]) => {
-    if (k.startsWith("$")) return [];
-    const key = `${prefix}${k}`;
-    if (v && typeof v === "object" && !Array.isArray(v)) return flatten(v, `${key}.`);
-    if (v === null) return [];
-    return [[key, v]];
-  });
-}
-
-/* ── 2. renderers ────────────────────────────────────────────────────────── */
-
-/**
- * How a key becomes text. Default is the bare value.
- *
- * A marker may carry an `@modifier` — `<!-- br:mcp.tools@badge -->` — which
- * selects a renderer without changing which number is looked up. The modifier
- * is what makes a key reusable: the same mcp.tools appears as a shields badge
- * at the top of a README and as a bare "19 tools" in a table two screens down,
- * and one marker still keeps the badge URL, its alt text and the label in step.
- *
- * Renderers are registered under the FULL marker name so a badge's label is
- * written out rather than guessed from the key.
- */
-const badge = (label) => (n) =>
-  `<img src="https://img.shields.io/badge/${label}-${n}-5B9BF6?style=flat-square&labelColor=0B0A0F" alt="${n} ${label}">`;
-
-const RENDER = {
-  "mcp.tools@badge": badge("tools"),
-  "models.totalVisible@badge": badge("models"),
-  "models.chatVisible@badge": badge("models"),
-};
-const render = (marker, value) => (RENDER[marker] ?? String)(value);
-
-/** `mcp.tools@badge` looks up `mcp.tools`. Unmodified markers are unaffected. */
-const keyOf = (marker) => marker.split("@")[0];
-
-/* ── 3. marker rewriting ─────────────────────────────────────────────────── */
-
-const esc = (s) => s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-const OPEN_ANY = /<!--\s*br:([A-Za-z0-9_.@]+)\s*-->/g;
-const CLOSE_ANY = /<!--\s*\/br:([A-Za-z0-9_.@]+)\s*-->/g;
-
-/** Byte ranges of fenced code blocks — markers inside them are documentation. */
-function fencedRanges(text) {
-  const ranges = [];
-  const fence = /^(\s*)(`{3,}|~{3,})[^\n]*$/gm;
-  let open = null;
-  for (let m; (m = fence.exec(text)); ) {
-    if (open === null) open = m.index;
-    else {
-      ranges.push([open, m.index + m[0].length]);
-      open = null;
-    }
-  }
-  return ranges;
-}
-
-function syncFile(file, numbers, problems) {
-  const before = readFileSync(file, "utf8");
-  const rel = relative(ROOT, file);
-  const fenced = fencedRanges(before);
-  const inFence = (i) => fenced.some(([a, b]) => i >= a && i < b);
-  const known = new Map(numbers);
-  const used = new Set();
-
-  // Markers actually present, so a file is only ever rewritten for what it uses
-  // and an @modifier is carried through to the renderer verbatim.
-  const markers = new Set();
-  // A marker naming a key that does not exist is an error, never a silent
-  // no-op: a typo'd marker would otherwise sit there looking synced forever.
-  for (const [re, shown] of [
-    [OPEN_ANY, (n) => `<!-- br:${n} -->`],
-    [CLOSE_ANY, (n) => `<!-- /br:${n} -->`],
-  ]) {
-    for (const m of before.matchAll(re)) {
-      if (inFence(m.index)) continue;
-      markers.add(m[1]);
-      if (!known.has(keyOf(m[1]))) problems.push(`${rel}: unknown key ${shown(m[1])}`);
-    }
-  }
-
-  let after = before;
-  for (const marker of markers) {
-    const key = keyOf(marker);
-    if (!known.has(key)) continue;
-    const value = known.get(key);
-    const pair = new RegExp(
-      `(<!--\\s*br:${esc(marker)}\\s*-->)([\\s\\S]*?)(<!--\\s*/br:${esc(marker)}\\s*-->)`,
-      "g",
-    );
-    after = after.replace(pair, (whole, open, inner, close, offset) => {
-      if (inFence(offset)) return whole;
-      // Nesting means the closing tag of an inner marker would be consumed by
-      // the outer one. Refuse rather than produce mangled output.
-      if (/<!--\s*\/?br:/.test(inner)) {
-        problems.push(`${rel}: nested marker inside br:${marker}`);
-        return whole;
-      }
-      used.add(marker);
-      return open + render(marker, value) + close;
-    });
-
-    // An opening tag with no partner silently swallows the rest of the file on
-    // a naive regex, so catch it explicitly.
-    const opens = [...before.matchAll(new RegExp(`<!--\\s*br:${esc(marker)}\\s*-->`, "g"))]
-      .filter((m) => !inFence(m.index)).length;
-    const closes = [...before.matchAll(new RegExp(`<!--\\s*/br:${esc(marker)}\\s*-->`, "g"))]
-      .filter((m) => !inFence(m.index)).length;
-    if (opens !== closes) problems.push(`${rel}: unbalanced marker br:${marker} (${opens} open, ${closes} close)`);
-  }
-
-  return { before, after, changed: before !== after, used };
-}
-
-/* ── 4. walk ─────────────────────────────────────────────────────────────── */
-
-function* walk(dir) {
-  for (const name of readdirSync(dir)) {
-    if (SKIP_DIRS.has(name)) continue;
-    const p = join(dir, name);
-    // lstat, not stat: a symlinked directory is reached by its real path or not
-    // at all. blockrun's docs/ -> awesome-blockrun/docs is exactly the case that
-    // matters — following it would edit a submodule's files behind the skip
-    // below, and a link pointing at an ancestor would recurse forever.
-    const s = lstatSync(p);
-    if (s.isSymbolicLink()) continue;
-    if (s.isDirectory()) {
-      // A nested repo is a submodule or vendored checkout: it carries its own
-      // brand-numbers.json and syncs itself. Rewriting its markers from THIS
-      // repo's snapshot would dirty a submodule nobody asked us to touch, and
-      // would report drift that belongs to another repo's CI.
-      if (existsSync(join(p, ".git"))) continue;
-      yield* walk(p);
-    } else if (TEXT_EXT.has(extname(name))) yield p;
-  }
-}
-
-function fail(msg) {
-  console.error(`brand-numbers: ${msg}`);
-  process.exit(1);
-}
-
-/* ── 5. run ──────────────────────────────────────────────────────────────── */
-
-const raw = await loadNumbers();
-const numbers = flatten(raw);
-const problems = [];
-const drifted = [];
-const everUsed = new Set();
-
-for (const file of walk(ROOT)) {
-  const { before, after, changed, used } = syncFile(file, numbers, problems);
-  used.forEach((k) => everUsed.add(k));
-  if (!changed) continue;
-  drifted.push({ file: relative(ROOT, file), before, after });
-  if (!check) writeFileSync(file, after);
-}
-
-if (problems.length) {
-  for (const p of problems) console.error(`  ${p}`);
-  fail(`${problems.length} marker problem(s)`);
-}
-
-if (check) {
-  if (drifted.length === 0) {
-    console.log(`brand-numbers: up to date (${everUsed.size} keys in use)`);
-    process.exit(0);
-  }
-  console.error("brand-numbers: these files disagree with brand-numbers.json\n");
-  for (const { file, before, after } of drifted) {
-    const b = before.split("\n");
-    const a = after.split("\n");
-    for (let i = 0; i < Math.max(b.length, a.length); i++) {
-      if (b[i] !== a[i]) {
-        console.error(`  ${file}:${i + 1}`);
-        console.error(`    - ${(b[i] ?? "").trim()}`);
-        console.error(`    + ${(a[i] ?? "").trim()}`);
-      }
-    }
-  }
-  console.error(
-    "\n  fix with:  node scripts/sync-brand-numbers.mjs && git commit -am 'chore: sync brand numbers'",
-  );
-  process.exit(1);
-}
-
-console.log(
-  drifted.length
-    ? `brand-numbers: updated ${drifted.length} file(s)`
-    : `brand-numbers: already up to date (${everUsed.size} keys in use)`,
-);