Skip to content

Commit 9b849c0

Browse files
authored
fix(cli): preserve project assets when archive paths collide
1 parent 49e0312 commit 9b849c0

3 files changed

Lines changed: 53 additions & 1 deletion

File tree

‎docs/guides/export-and-share.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,10 @@ Local images outside the project referenced by an `<img>` or `<source>` element'
138138
`srcset` are included too. Their size or pixel-density descriptors are preserved,
139139
and your source files stay unchanged.
140140

141+
Copied external assets go under `_ext/` in the uploaded project. If a path is
142+
already occupied, the copy gets a suffix such as `logo_2.png`, and its references
143+
use that name. Existing project assets keep their names and contents.
144+
141145
Before sharing source, remove secrets and confirm that every included media file
142146
can be shared. Tell a reviewer whether you need feedback on story, visuals,
143147
timing, facts, or final approval.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
2+
import { tmpdir } from "node:os";
3+
import { join } from "node:path";
4+
import AdmZip from "adm-zip";
5+
import { parseHTML } from "linkedom";
6+
import { expect, it, onTestFinished } from "vitest";
7+
import { createPublishArchive, readStaged, stagePublishFiles } from "./publishProject.js";
8+
9+
it.each([Infinity, 1])(
10+
"preserves existing archive paths when localizing assets (threshold %s)",
11+
(threshold) => {
12+
const root = mkdtempSync(join(tmpdir(), "hf-publish-collision-"));
13+
onTestFinished(() => rmSync(root, { recursive: true, force: true }));
14+
const project = join(root, "project");
15+
mkdirSync(join(project, "_ext", "shared"), { recursive: true });
16+
mkdirSync(join(root, "shared"));
17+
writeFileSync(join(project, "_ext", "shared", "logo.png"), "existing logo");
18+
writeFileSync(join(project, "_ext", "shared", "logo_2.png"), "another existing logo");
19+
writeFileSync(join(root, "shared", "logo.png"), "new external logo");
20+
const html =
21+
'<html><body><img src="_ext/shared/logo.png"><img src="_ext/shared/logo_2.png"><img src="../shared/logo.png"><img src="../shared/logo.png"></body></html>';
22+
writeFileSync(join(project, "index.html"), html);
23+
24+
const files = stagePublishFiles(project, threshold);
25+
const contents = new Map([...files].map(([path, file]) => [path, readStaged(file).toString()]));
26+
expect(contents.size).toBe(4);
27+
expect(contents.get("_ext/shared/logo.png")).toBe("existing logo");
28+
expect(contents.get("_ext/shared/logo_2.png")).toBe("another existing logo");
29+
expect(contents.get("_ext/shared/logo_3.png")).toBe("new external logo");
30+
const { document } = parseHTML(contents.get("index.html") ?? "");
31+
expect([...document.querySelectorAll("img")].map((img) => img.getAttribute("src"))).toEqual([
32+
"_ext/shared/logo.png",
33+
"_ext/shared/logo_2.png",
34+
"_ext/shared/logo_3.png",
35+
"_ext/shared/logo_3.png",
36+
]);
37+
38+
const archive = createPublishArchive(project);
39+
const zip = new AdmZip(archive.buffer);
40+
expect(archive.fileCount).toBe(4);
41+
expect(zip.readAsText("_ext/shared/logo.png")).toBe("existing logo");
42+
expect(zip.readAsText("_ext/shared/logo_3.png")).toBe("new external logo");
43+
expect(readFileSync(join(project, "index.html"), "utf-8")).toBe(html);
44+
expect(readFileSync(join(project, "_ext", "shared", "logo.png"), "utf-8")).toBe(
45+
"existing logo",
46+
);
47+
},
48+
);

‎packages/cli/src/utils/publishProject.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ export function localizeExternalAssets(
601601
fileContents,
602602
onDiskMinBytes,
603603
externalMap: new Map(),
604-
usedArchivePaths: new Set(),
604+
usedArchivePaths: new Set(fileContents.keys()),
605605
};
606606

607607
for (const [entryPath, content] of [...fileContents.entries()]) {

0 commit comments

Comments
 (0)