|
| 1 | +#!/usr/bin/env bun |
| 2 | +import { readFileSync, writeFileSync } from "node:fs" |
| 3 | +import { resolve } from "node:path" |
| 4 | +import { getBadges, type BadgeVariant } from "../packages/opencode/packages/fork-ui/src/readme-badge-catalog" |
| 5 | + |
| 6 | +type Target = "all" | "superproject" | "submodule" |
| 7 | +type ReadmeTarget = Exclude<Target, "all"> |
| 8 | + |
| 9 | +const ROOT_README_PATH = resolve(import.meta.dir, "..", "README.md") |
| 10 | +const SUBMODULE_README_PATH = resolve(import.meta.dir, "..", "packages/opencode/README.md") |
| 11 | + |
| 12 | +const ROOT_BEGIN_MARKER = "<!-- BEGIN:opencode-cloud-readme-badges -->" |
| 13 | +const ROOT_END_MARKER = "<!-- END:opencode-cloud-readme-badges -->" |
| 14 | +const SUBMODULE_BEGIN_MARKER = "<!-- BEGIN:opencode-submodule-readme-badges -->" |
| 15 | +const SUBMODULE_END_MARKER = "<!-- END:opencode-submodule-readme-badges -->" |
| 16 | + |
| 17 | +const DEFAULT_VARIANT_BY_TARGET: Record<ReadmeTarget, BadgeVariant> = { |
| 18 | + superproject: "full", |
| 19 | + submodule: "full", |
| 20 | +} |
| 21 | + |
| 22 | +interface Options { |
| 23 | + check: boolean |
| 24 | + target: Target |
| 25 | + variantOverride?: BadgeVariant |
| 26 | +} |
| 27 | + |
| 28 | +interface Update { |
| 29 | + target: ReadmeTarget |
| 30 | + filePath: string |
| 31 | + changed: boolean |
| 32 | +} |
| 33 | + |
| 34 | +function usage(): never { |
| 35 | + console.error(`Usage: bun scripts/sync-readme-badges.ts [--check] [--target=all|superproject|submodule] [--variant=core|full]\n\nOptions:\n --check Validate files without writing changes.\n --target=... Limit sync/check scope. Default: all\n --variant=core|full Override per-target variant defaults for this run.\n\nExamples:\n bun scripts/sync-readme-badges.ts\n bun scripts/sync-readme-badges.ts --check\n bun scripts/sync-readme-badges.ts --target=submodule --variant=core`) |
| 36 | + process.exit(1) |
| 37 | +} |
| 38 | + |
| 39 | +function parseVariant(value: string): BadgeVariant { |
| 40 | + if (value === "core" || value === "full") return value |
| 41 | + console.error(`Invalid --variant value: ${value}`) |
| 42 | + usage() |
| 43 | +} |
| 44 | + |
| 45 | +function parseTarget(value: string): Target { |
| 46 | + if (value === "all" || value === "superproject" || value === "submodule") return value |
| 47 | + console.error(`Invalid --target value: ${value}`) |
| 48 | + usage() |
| 49 | +} |
| 50 | + |
| 51 | +function parseArgs(argv: string[]): Options { |
| 52 | + const options: Options = { check: false, target: "all" } |
| 53 | + |
| 54 | + for (let i = 0; i < argv.length; i += 1) { |
| 55 | + const arg = argv[i] |
| 56 | + |
| 57 | + if (arg === "--check") { |
| 58 | + options.check = true |
| 59 | + continue |
| 60 | + } |
| 61 | + |
| 62 | + if (arg === "--target") { |
| 63 | + const value = argv[i + 1] |
| 64 | + if (!value) usage() |
| 65 | + options.target = parseTarget(value) |
| 66 | + i += 1 |
| 67 | + continue |
| 68 | + } |
| 69 | + |
| 70 | + if (arg.startsWith("--target=")) { |
| 71 | + options.target = parseTarget(arg.slice("--target=".length)) |
| 72 | + continue |
| 73 | + } |
| 74 | + |
| 75 | + if (arg === "--variant") { |
| 76 | + const value = argv[i + 1] |
| 77 | + if (!value) usage() |
| 78 | + options.variantOverride = parseVariant(value) |
| 79 | + i += 1 |
| 80 | + continue |
| 81 | + } |
| 82 | + |
| 83 | + if (arg.startsWith("--variant=")) { |
| 84 | + options.variantOverride = parseVariant(arg.slice("--variant=".length)) |
| 85 | + continue |
| 86 | + } |
| 87 | + |
| 88 | + if (arg === "-h" || arg === "--help") { |
| 89 | + usage() |
| 90 | + } |
| 91 | + |
| 92 | + console.error(`Unknown argument: ${arg}`) |
| 93 | + usage() |
| 94 | + } |
| 95 | + |
| 96 | + return options |
| 97 | +} |
| 98 | + |
| 99 | +function replaceMarkerBlock(content: string, beginMarker: string, endMarker: string, generatedBody: string, filePath: string): string { |
| 100 | + const beginIndex = content.indexOf(beginMarker) |
| 101 | + const endIndex = content.indexOf(endMarker) |
| 102 | + |
| 103 | + if (beginIndex < 0 || endIndex < 0 || endIndex <= beginIndex) { |
| 104 | + throw new Error(`Markers not found or invalid in ${filePath}: ${beginMarker} ... ${endMarker}`) |
| 105 | + } |
| 106 | + |
| 107 | + const before = content.slice(0, beginIndex + beginMarker.length) |
| 108 | + const after = content.slice(endIndex) |
| 109 | + return `${before}\n${generatedBody.trimEnd()}\n${after}` |
| 110 | +} |
| 111 | + |
| 112 | +function renderRootBadges(variant: BadgeVariant): string { |
| 113 | + return getBadges("opencode-cloud", variant) |
| 114 | + .map((badge) => `[](${badge.linkUrl})`) |
| 115 | + .join("\n") |
| 116 | +} |
| 117 | + |
| 118 | +function renderSubmoduleBadges(variant: BadgeVariant): string { |
| 119 | + return getBadges("opencode-submodule", variant) |
| 120 | + .map((badge) => ` <a href="${badge.linkUrl}"><img alt="${badge.label}" src="${badge.imageUrl}" /></a>`) |
| 121 | + .join("\n") |
| 122 | +} |
| 123 | + |
| 124 | +function resolveVariant(target: ReadmeTarget, variantOverride?: BadgeVariant): BadgeVariant { |
| 125 | + return variantOverride ?? DEFAULT_VARIANT_BY_TARGET[target] |
| 126 | +} |
| 127 | + |
| 128 | +function includesTarget(scope: Target, target: ReadmeTarget): boolean { |
| 129 | + return scope === "all" || scope === target |
| 130 | +} |
| 131 | + |
| 132 | +function syncRootReadme(variant: BadgeVariant, check: boolean): Update { |
| 133 | + const current = readFileSync(ROOT_README_PATH, "utf8") |
| 134 | + const generated = renderRootBadges(variant) |
| 135 | + const next = replaceMarkerBlock(current, ROOT_BEGIN_MARKER, ROOT_END_MARKER, generated, ROOT_README_PATH) |
| 136 | + const changed = next !== current |
| 137 | + |
| 138 | + if (changed && !check) writeFileSync(ROOT_README_PATH, next) |
| 139 | + |
| 140 | + return { target: "superproject", filePath: ROOT_README_PATH, changed } |
| 141 | +} |
| 142 | + |
| 143 | +function syncSubmoduleReadme(variant: BadgeVariant, check: boolean): Update { |
| 144 | + const current = readFileSync(SUBMODULE_README_PATH, "utf8") |
| 145 | + const generated = renderSubmoduleBadges(variant) |
| 146 | + const next = replaceMarkerBlock(current, SUBMODULE_BEGIN_MARKER, SUBMODULE_END_MARKER, generated, SUBMODULE_README_PATH) |
| 147 | + const changed = next !== current |
| 148 | + |
| 149 | + if (changed && !check) writeFileSync(SUBMODULE_README_PATH, next) |
| 150 | + |
| 151 | + return { target: "submodule", filePath: SUBMODULE_README_PATH, changed } |
| 152 | +} |
| 153 | + |
| 154 | +function main() { |
| 155 | + const options = parseArgs(process.argv.slice(2)) |
| 156 | + const updates: Update[] = [] |
| 157 | + |
| 158 | + if (includesTarget(options.target, "superproject")) { |
| 159 | + updates.push(syncRootReadme(resolveVariant("superproject", options.variantOverride), options.check)) |
| 160 | + } |
| 161 | + |
| 162 | + if (includesTarget(options.target, "submodule")) { |
| 163 | + updates.push(syncSubmoduleReadme(resolveVariant("submodule", options.variantOverride), options.check)) |
| 164 | + } |
| 165 | + |
| 166 | + if (options.check) { |
| 167 | + const drifted = updates.filter((update) => update.changed) |
| 168 | + if (drifted.length > 0) { |
| 169 | + console.error("README badge blocks are out of sync:") |
| 170 | + for (const update of drifted) { |
| 171 | + console.error(`- ${update.target}: ${update.filePath}`) |
| 172 | + } |
| 173 | + console.error("Run: just sync-readme-badges") |
| 174 | + process.exit(1) |
| 175 | + } |
| 176 | + |
| 177 | + console.log("README badge blocks are in sync.") |
| 178 | + return |
| 179 | + } |
| 180 | + |
| 181 | + const changed = updates.filter((update) => update.changed) |
| 182 | + if (changed.length === 0) { |
| 183 | + console.log("README badge blocks already up to date.") |
| 184 | + return |
| 185 | + } |
| 186 | + |
| 187 | + for (const update of changed) { |
| 188 | + console.log(`Updated ${update.target} badges: ${update.filePath}`) |
| 189 | + } |
| 190 | +} |
| 191 | + |
| 192 | +main() |
0 commit comments