perf(electron): prune authoring docs from packages (#10359)

This commit is contained in:
backryun
2026-08-16 12:15:42 +09:00
committed by GitHub
parent 4b76d3b76f
commit 684ea70fb3
3 changed files with 143 additions and 1 deletions

View File

@@ -1,7 +1,9 @@
import assert from "node:assert/strict";
import { readFileSync } from "node:fs";
import { existsSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import test from "node:test";
import { pruneElectronRuntimeDocs } from "../../scripts/build/electronRuntimeDocs.mjs";
const ROOT = join(import.meta.dirname, "..", "..");
@@ -36,3 +38,69 @@ test("electron standalone assembly normalizes Turbopack hashed external imports"
"Electron packages must strip Turbopack's hashed external package names before bundling"
);
});
test("electron docs manifest prunes authoring payloads without removing runtime docs", () => {
const bundleRoot = mkdtempSync(join(tmpdir(), "omniroute-electron-docs-"));
const files = new Map([
["docs/openapi.yaml", "openapi: 3.1.0"],
["docs/guides/CODEX-CLI-CONFIGURATION.md", "# Codex CLI"],
["docs/i18n/ko/docs/guides/ELECTRON_GUIDE.md", "# Electron"],
["docs/i18n/ko/CHANGELOG.md", "translated release history"],
["docs/i18n/fr/CHANGELOG.md", "historique traduit"],
["docs/research/desktop-notes.md", "authoring notes"],
["docs/superpowers/plans/desktop-plan.md", "implementation plan"],
]);
try {
for (const [relativePath, content] of files) {
const absolutePath = join(bundleRoot, relativePath);
mkdirSync(join(absolutePath, ".."), { recursive: true });
writeFileSync(absolutePath, content);
}
const result = pruneElectronRuntimeDocs(bundleRoot);
assert.deepEqual(result.removedPaths, [
"docs/i18n/fr/CHANGELOG.md",
"docs/i18n/ko/CHANGELOG.md",
"docs/research",
"docs/superpowers",
]);
assert.equal(result.removedFiles, 4);
assert.equal(
result.removedBytes,
Buffer.byteLength("translated release history") +
Buffer.byteLength("historique traduit") +
Buffer.byteLength("authoring notes") +
Buffer.byteLength("implementation plan")
);
assert.equal(existsSync(join(bundleRoot, "docs/openapi.yaml")), true);
assert.equal(existsSync(join(bundleRoot, "docs/guides/CODEX-CLI-CONFIGURATION.md")), true);
assert.equal(existsSync(join(bundleRoot, "docs/i18n/ko/docs/guides/ELECTRON_GUIDE.md")), true);
assert.equal(existsSync(join(bundleRoot, "docs/i18n/ko/CHANGELOG.md")), false);
assert.equal(existsSync(join(bundleRoot, "docs/research")), false);
assert.equal(existsSync(join(bundleRoot, "docs/superpowers")), false);
assert.deepEqual(pruneElectronRuntimeDocs(bundleRoot), {
removedFiles: 0,
removedBytes: 0,
removedPaths: [],
});
} finally {
rmSync(bundleRoot, { recursive: true, force: true });
}
});
test("electron bundle preparation applies the runtime docs manifest to its staging tree", () => {
const prepareScript = readFileSync(
join(ROOT, "scripts", "build", "prepare-electron-standalone.mjs"),
"utf8"
);
assert.match(
prepareScript,
/pruneElectronRuntimeDocs\(ELECTRON_STANDALONE_DIR\)/,
"Electron staging must prune authoring docs before electron-builder copies the bundle"
);
});