Vendor OpenClaw source as Adolf fork baseline
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
This commit is contained in:
268
scripts/format-docs.mjs
Normal file
268
scripts/format-docs.mjs
Normal file
@@ -0,0 +1,268 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
// Formats docs Markdown/MDX and repairs Mintlify accordion indentation.
|
||||
import { spawnSync } from "node:child_process";
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { pathToFileURL } from "node:url";
|
||||
import { repairMintlifyAccordionIndentation } from "./lib/mintlify-accordion.mjs";
|
||||
import { buildCmdExeCommandLine, resolveWindowsCmdExePath } from "./windows-cmd-helpers.mjs";
|
||||
|
||||
const ROOT = path.resolve(import.meta.dirname, "..");
|
||||
const CHECK = process.argv.includes("--check");
|
||||
const DOCS_FORMAT_MAX_BUFFER_BYTES = 1024 * 1024 * 16;
|
||||
export const DOCS_FORMAT_MAX_COMMAND_LINE_BYTES = 24 * 1024;
|
||||
const FAILURE_OUTPUT_TAIL_BYTES = 16 * 1024;
|
||||
|
||||
function outputText(value) {
|
||||
if (typeof value === "string") {
|
||||
return value;
|
||||
}
|
||||
if (Buffer.isBuffer(value)) {
|
||||
return value.toString("utf8");
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
function outputTail(value) {
|
||||
const text = outputText(value).trim();
|
||||
if (!text) {
|
||||
return "";
|
||||
}
|
||||
const bytes = Buffer.from(text, "utf8");
|
||||
if (bytes.byteLength <= FAILURE_OUTPUT_TAIL_BYTES) {
|
||||
return text;
|
||||
}
|
||||
return bytes.subarray(bytes.byteLength - FAILURE_OUTPUT_TAIL_BYTES).toString("utf8");
|
||||
}
|
||||
|
||||
function commandFailureMessage(label, result, invocation) {
|
||||
const details = [];
|
||||
if (invocation) {
|
||||
details.push(`command: ${invocation.command}`);
|
||||
if (invocation.args.length > 0) {
|
||||
const previewArgs = invocation.args.slice(0, 12).join(" ");
|
||||
const suffix = invocation.args.length > 12 ? ` ... (${invocation.args.length} args)` : "";
|
||||
details.push(`args: ${previewArgs}${suffix}`);
|
||||
}
|
||||
}
|
||||
if (result.error?.message) {
|
||||
details.push(result.error.message);
|
||||
}
|
||||
if (result.status !== null && result.status !== undefined && result.status !== 0) {
|
||||
details.push(`exit status: ${result.status}`);
|
||||
}
|
||||
if (result.signal) {
|
||||
details.push(`signal: ${result.signal}`);
|
||||
}
|
||||
const stderrTail = outputTail(result.stderr);
|
||||
if (stderrTail) {
|
||||
details.push(`stderr tail:\n${stderrTail}`);
|
||||
}
|
||||
const stdoutTail = outputTail(result.stdout);
|
||||
if (stdoutTail) {
|
||||
details.push(`stdout tail:\n${stdoutTail}`);
|
||||
}
|
||||
return `${label} failed${details.length > 0 ? `:\n${details.join("\n")}` : ""}`;
|
||||
}
|
||||
|
||||
export function docsFiles(root = ROOT, deps = {}) {
|
||||
const spawnSyncImpl = deps.spawnSync ?? spawnSync;
|
||||
const result = spawnSyncImpl("git", ["ls-files", "docs/**/*.md", "docs/**/*.mdx", "README.md"], {
|
||||
cwd: root,
|
||||
encoding: "utf8",
|
||||
maxBuffer: DOCS_FORMAT_MAX_BUFFER_BYTES,
|
||||
});
|
||||
if (result.error || result.status !== 0) {
|
||||
throw new Error(
|
||||
commandFailureMessage("git ls-files", result, {
|
||||
command: "git",
|
||||
args: ["ls-files", "docs/**/*.md", "docs/**/*.mdx", "README.md"],
|
||||
}),
|
||||
);
|
||||
}
|
||||
return outputText(result.stdout)
|
||||
.split("\n")
|
||||
.filter(Boolean)
|
||||
.filter((relativePath) => (deps.existsSync ?? fs.existsSync)(path.join(root, relativePath)));
|
||||
}
|
||||
|
||||
function commandLineBytes(args) {
|
||||
return args.reduce((total, arg) => total + Buffer.byteLength(arg, "utf8") + 3, 0);
|
||||
}
|
||||
|
||||
export function chunkFilesForCommand(
|
||||
files,
|
||||
prefixArgs,
|
||||
maxBytes = DOCS_FORMAT_MAX_COMMAND_LINE_BYTES,
|
||||
) {
|
||||
const chunks = [];
|
||||
let chunk = [];
|
||||
let chunkBytes = commandLineBytes(prefixArgs);
|
||||
|
||||
for (const file of files) {
|
||||
const fileBytes = Buffer.byteLength(file, "utf8") + 3;
|
||||
if (chunk.length > 0 && chunkBytes + fileBytes > maxBytes) {
|
||||
chunks.push(chunk);
|
||||
chunk = [];
|
||||
chunkBytes = commandLineBytes(prefixArgs);
|
||||
}
|
||||
chunk.push(file);
|
||||
chunkBytes += fileBytes;
|
||||
}
|
||||
|
||||
if (chunk.length > 0) {
|
||||
chunks.push(chunk);
|
||||
}
|
||||
|
||||
return chunks;
|
||||
}
|
||||
|
||||
export function resolveOxfmtInvocation(args, params = {}) {
|
||||
const repoRoot = params.repoRoot ?? ROOT;
|
||||
const platform = params.platform ?? process.platform;
|
||||
const existsSync = params.existsSync ?? fs.existsSync;
|
||||
const shimName = platform === "win32" ? "oxfmt.cmd" : "oxfmt";
|
||||
const shimPath = path.join(repoRoot, "node_modules", ".bin", shimName);
|
||||
|
||||
if (existsSync(shimPath)) {
|
||||
if (platform === "win32") {
|
||||
const comSpec = params.comSpec ?? resolveWindowsCmdExePath(params.env ?? process.env);
|
||||
return {
|
||||
command: comSpec,
|
||||
args: ["/d", "/s", "/c", buildCmdExeCommandLine(shimPath, args)],
|
||||
shell: false,
|
||||
windowsVerbatimArguments: true,
|
||||
};
|
||||
}
|
||||
return {
|
||||
command: shimPath,
|
||||
args,
|
||||
shell: false,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
command: params.nodeExecPath ?? process.execPath,
|
||||
args: [path.join(repoRoot, "node_modules", "oxfmt", "bin", "oxfmt"), ...args],
|
||||
shell: false,
|
||||
};
|
||||
}
|
||||
|
||||
export function runOxfmt(files, params = {}, deps = {}) {
|
||||
if (files.length === 0) {
|
||||
return;
|
||||
}
|
||||
const repoRoot = params.repoRoot ?? ROOT;
|
||||
const spawnSyncImpl = deps.spawnSync ?? spawnSync;
|
||||
const prefixArgs = ["--write", "--threads=1", "--config", path.join(repoRoot, ".oxfmtrc.jsonc")];
|
||||
for (const chunk of chunkFilesForCommand(
|
||||
files,
|
||||
prefixArgs,
|
||||
params.maxCommandLineBytes ?? DOCS_FORMAT_MAX_COMMAND_LINE_BYTES,
|
||||
)) {
|
||||
const invocation = resolveOxfmtInvocation([...prefixArgs, ...chunk], {
|
||||
comSpec: params.comSpec,
|
||||
existsSync: deps.existsSync,
|
||||
nodeExecPath: params.nodeExecPath,
|
||||
platform: params.platform,
|
||||
repoRoot,
|
||||
});
|
||||
const result = spawnSyncImpl(invocation.command, invocation.args, {
|
||||
cwd: repoRoot,
|
||||
encoding: "utf8",
|
||||
maxBuffer: DOCS_FORMAT_MAX_BUFFER_BYTES,
|
||||
shell: invocation.shell,
|
||||
windowsVerbatimArguments: invocation.windowsVerbatimArguments,
|
||||
});
|
||||
|
||||
if (result.error || result.status !== 0) {
|
||||
throw new Error(commandFailureMessage("oxfmt", result, invocation));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function repairFiles(root, files) {
|
||||
const changed = [];
|
||||
for (const relativePath of files) {
|
||||
const absolutePath = path.join(root, relativePath);
|
||||
const raw = fs.readFileSync(absolutePath, "utf8");
|
||||
const formatted = repairMintlifyAccordionIndentation(raw);
|
||||
if (formatted === raw) {
|
||||
continue;
|
||||
}
|
||||
fs.writeFileSync(absolutePath, formatted);
|
||||
changed.push(relativePath);
|
||||
}
|
||||
return changed;
|
||||
}
|
||||
|
||||
function copyDocsToTemp(root, files) {
|
||||
const tempRoot = fs.mkdtempSync(path.join(os.tmpdir(), "openclaw-docs-format-"));
|
||||
for (const relativePath of files) {
|
||||
const source = path.join(root, relativePath);
|
||||
const target = path.join(tempRoot, relativePath);
|
||||
fs.mkdirSync(path.dirname(target), { recursive: true });
|
||||
fs.copyFileSync(source, target);
|
||||
}
|
||||
return tempRoot;
|
||||
}
|
||||
|
||||
export function formatDocs(params = {}, deps = {}) {
|
||||
const root = params.root ?? ROOT;
|
||||
const check = params.check ?? false;
|
||||
const changed = [];
|
||||
const files = docsFiles(root, deps);
|
||||
|
||||
if (check) {
|
||||
const tempRoot = copyDocsToTemp(root, files);
|
||||
try {
|
||||
runOxfmt(
|
||||
files.map((relativePath) => path.join(tempRoot, relativePath)),
|
||||
{ ...params, repoRoot: root },
|
||||
deps,
|
||||
);
|
||||
repairFiles(tempRoot, files);
|
||||
for (const relativePath of files) {
|
||||
const raw = fs.readFileSync(path.join(root, relativePath), "utf8");
|
||||
const formatted = fs.readFileSync(path.join(tempRoot, relativePath), "utf8");
|
||||
if (formatted !== raw) {
|
||||
changed.push(relativePath);
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
fs.rmSync(tempRoot, { recursive: true, force: true });
|
||||
}
|
||||
} else {
|
||||
runOxfmt(files, { ...params, repoRoot: root }, deps);
|
||||
changed.push(...repairFiles(root, files));
|
||||
}
|
||||
|
||||
return {
|
||||
changed,
|
||||
fileCount: files.length,
|
||||
};
|
||||
}
|
||||
|
||||
function main() {
|
||||
const { changed, fileCount } = formatDocs({ check: CHECK, root: ROOT });
|
||||
|
||||
if (CHECK && changed.length > 0) {
|
||||
console.error(`Format issues found in ${changed.length} docs file(s):`);
|
||||
for (const relativePath of changed) {
|
||||
console.error(`- ${relativePath}`);
|
||||
}
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
if (changed.length > 0) {
|
||||
console.log(`Formatted ${changed.length} docs file(s).`);
|
||||
} else {
|
||||
console.log(`Docs formatting clean (${fileCount} files).`);
|
||||
}
|
||||
}
|
||||
|
||||
if (import.meta.url === pathToFileURL(process.argv[1] ?? "").href) {
|
||||
main();
|
||||
}
|
||||
Reference in New Issue
Block a user