Skip to content

Commit fd83621

Browse files
committed
fix(cli): read BOM-prefixed JSON files for timeline plans, grades and motion specs
1 parent 746ce95 commit fd83621

8 files changed

Lines changed: 50 additions & 8 deletions

File tree

‎packages/cli/src/commands/grade-compare.test.ts‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,22 @@ describe("parseGradesFile", () => {
5757
}
5858
});
5959

60+
it("parses a grades file saved with a UTF-8 BOM", () => {
61+
const dir = tempDir();
62+
try {
63+
const file = join(dir, "grades.json");
64+
writeFileSync(
65+
file,
66+
`\uFEFF${JSON.stringify([{ label: "warm", grading: { preset: "warm-daylight" } }])}`,
67+
);
68+
expect(parseGradesFile(file)).toEqual([
69+
{ label: "warm", grading: { preset: "warm-daylight" } },
70+
]);
71+
} finally {
72+
rmSync(dir, { recursive: true, force: true });
73+
}
74+
});
75+
6076
it("errors clearly for missing or invalid grades files", () => {
6177
const dir = tempDir();
6278
try {

‎packages/cli/src/commands/grade-compare.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
rmSync,
88
writeFileSync,
99
} from "node:fs";
10+
import { readJsonFileText } from "../utils/jsonFlag.js";
1011
import { tmpdir } from "node:os";
1112
import { basename, dirname, extname, join, resolve } from "node:path";
1213
import {
@@ -214,7 +215,7 @@ export function parseGradesFile(filePath: string): GradeCompareCell[] {
214215

215216
let parsed: unknown;
216217
try {
217-
parsed = JSON.parse(readFileSync(filePath, "utf-8"));
218+
parsed = JSON.parse(readJsonFileText(filePath));
218219
} catch (err) {
219220
throw new Error(`Could not parse grades JSON: ${normalizeErrorMessage(err)}`);
220221
}

‎packages/cli/src/timeline/a2Commands.ids.test.ts‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { tmpdir } from "node:os";
33
import { join } from "node:path";
44
import { afterEach, describe, expect, it, vi } from "vitest";
55
import { consumeCommandResult } from "../utils/commandResult.js";
6-
import { runIds } from "./a2Commands.js";
6+
import { readEditPlan, runIds } from "./a2Commands.js";
77

88
const hooks = vi.hoisted(() => ({ minting: undefined as (() => void) | undefined }));
99
vi.mock("@hyperframes/parsers/hf-ids", async (importOriginal) => {
@@ -51,3 +51,13 @@ describe("timeline ids", () => {
5151
});
5252
});
5353
});
54+
55+
describe("timeline apply plan file", () => {
56+
it("reads an edit plan saved with a UTF-8 BOM", () => {
57+
const dir = mkdtempSync(join(tmpdir(), "hf-timeline-plan-"));
58+
dirs.push(dir);
59+
const file = join(dir, "plan.json");
60+
writeFileSync(file, '\uFEFF[{"op":"trim"}]');
61+
expect(readEditPlan(file)).toEqual({ ok: true, edits: [{ op: "trim" }] });
62+
});
63+
});

‎packages/cli/src/timeline/a2Commands.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import {
44
type AppliedFileMutation,
55
} from "@hyperframes/studio-server";
66
import { ensureHfIds } from "@hyperframes/parsers/hf-ids";
7+
import { readJsonFileText, readJsonStdinText } from "../utils/jsonFlag.js";
78
import { readFileSync } from "node:fs";
89
import { join, relative } from "node:path";
910
import { describeProject, type ProjectTimeline, type TimelineRow } from "./describeProject.js";
@@ -167,8 +168,8 @@ function applyPlanEdit(
167168

168169
type EditPlan = { ok: true; edits: unknown[] } | { ok: false; reason: string; fix: string };
169170

170-
function readEditPlan(file: string): EditPlan {
171-
const raw = file === "-" ? readFileSync(0, "utf-8") : readFileSync(file, "utf-8");
171+
export function readEditPlan(file: string): EditPlan {
172+
const raw = file === "-" ? readJsonStdinText() : readJsonFileText(file);
172173
try {
173174
const edits: unknown = JSON.parse(raw);
174175
return Array.isArray(edits)
@@ -283,7 +284,7 @@ type UndoInput =
283284
function readUndoInput(input: string): UndoInput {
284285
let raw: string;
285286
try {
286-
raw = readFileSync(input, "utf-8");
287+
raw = readJsonFileText(input);
287288
} catch {
288289
raw = input;
289290
}

‎packages/cli/src/utils/jsonFlag.test.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
22
import { tmpdir } from "node:os";
33
import { join } from "node:path";
44
import { describe, expect, it } from "vitest";
5-
import { readJsonFlag } from "./jsonFlag.js";
5+
import { readJsonFileText, readJsonFlag } from "./jsonFlag.js";
66

77
const io = {
88
readFile: (path: string) => {
@@ -50,6 +50,8 @@ describe("readJsonFlag file encodings", () => {
5050
writeFileSync(join(dir, "u16.json"), Buffer.from('\uFEFF{"a":2}', "utf16le"));
5151
expect(readJsonFlag("--grading", join(dir, "bom.json"))).toEqual({ a: 1 });
5252
expect(readJsonFlag("--grading", join(dir, "u16.json"))).toEqual({ a: 2 });
53+
expect(JSON.parse(readJsonFileText(join(dir, "bom.json")))).toEqual({ a: 1 });
54+
expect(JSON.parse(readJsonFileText(join(dir, "u16.json")))).toEqual({ a: 2 });
5355
} finally {
5456
rmSync(dir, { recursive: true, force: true });
5557
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ const defaultIO: JsonFlagIO = {
1919
readStdin: () => decode(readFileSync(0)),
2020
};
2121

22+
export const readJsonFileText = (path: string): string => defaultIO.readFile(path);
23+
export const readJsonStdinText = (): string => defaultIO.readStdin();
24+
2225
export class JsonFlagReadError extends Error {
2326
constructor(
2427
readonly path: string,

‎packages/cli/src/utils/motionSpec.test.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,14 @@ describe("readMotionSpec", () => {
142142
if (!result.ok) expect(result.errors[0]).toContain("could not read");
143143
});
144144

145+
it("reads a spec saved with a UTF-8 BOM", () => {
146+
const dir = tempDir("motion-bom-");
147+
const path = join(dir, "bom.motion.json");
148+
writeFileSync(path, `\uFEFF{"version":1}`);
149+
const result = readMotionSpec(path);
150+
expect((result.ok ? [] : result.errors).join()).not.toContain("could not read");
151+
});
152+
145153
it("returns error for a file with invalid JSON", () => {
146154
const dir = tempDir("motion-bad-");
147155
const path = join(dir, "bad.motion.json");

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import { existsSync, readFileSync, readdirSync } from "node:fs";
1+
import { existsSync, readdirSync } from "node:fs";
2+
import { readJsonFileText } from "./jsonFlag.js";
23
import { basename, join } from "node:path";
34

45
/**
@@ -133,7 +134,7 @@ export function findMotionSpec(projectDir: string): string | null {
133134
export function readMotionSpec(path: string): MotionSpecParse {
134135
let raw: unknown;
135136
try {
136-
raw = JSON.parse(readFileSync(path, "utf-8"));
137+
raw = JSON.parse(readJsonFileText(path));
137138
} catch (err) {
138139
return { ok: false, errors: [`could not read ${basename(path)}: ${(err as Error).message}`] };
139140
}

0 commit comments

Comments
 (0)