diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index de1eba65de..692a937600 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -355,7 +355,7 @@ export { realProjectRoot, resolveWithinProject, } from "./safePath"; -export { isHyperframesProject, PROJECT_MARKER_FILES } from "./projectRule"; +export { isCompositionFolder, isHyperframesProject, PROJECT_MARKER_FILES } from "./projectRule"; export type { HyperframePickerApi, HyperframePickerBoundingBox, diff --git a/packages/core/src/projectRule.test.ts b/packages/core/src/projectRule.test.ts index 9179af04d9..950b385041 100644 --- a/packages/core/src/projectRule.test.ts +++ b/packages/core/src/projectRule.test.ts @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { isHyperframesProject } from "./projectRule"; +import { isCompositionFolder, isHyperframesProject } from "./projectRule"; describe("isHyperframesProject", () => { it.each(["hyperframes.json", "meta.json", "project.json"])( @@ -14,3 +14,16 @@ describe("isHyperframesProject", () => { expect(isHyperframesProject(["hyperframes.json", "README.md"])).toBe(false); }); }); + +// fails without the fix: a step had only the discovery rule, so a folder holding a composition but no marker file was +// refused by `open` though `snapshot` and `check` worked on it. +describe("isCompositionFolder", () => { + it("counts any folder with index.html, marker or not", () => { + expect(isCompositionFolder(["index.html"])).toBe(true); + expect(isCompositionFolder(["index.html", "hyperframes.json"])).toBe(true); + }); + + it("does not count a folder without index.html", () => { + expect(isCompositionFolder(["hyperframes.json", "assets"])).toBe(false); + }); +}); diff --git a/packages/core/src/projectRule.ts b/packages/core/src/projectRule.ts index 732d37c4d2..c36c0e88d8 100644 --- a/packages/core/src/projectRule.ts +++ b/packages/core/src/projectRule.ts @@ -5,3 +5,7 @@ export function isHyperframesProject(fileNames: Iterable): boolean { const names = new Set(fileNames); return names.has("index.html") && PROJECT_MARKER_FILES.some((name) => names.has(name)); } + +export function isCompositionFolder(fileNames: Iterable): boolean { + return new Set(fileNames).has("index.html"); +} diff --git a/packages/core/src/projects.ts b/packages/core/src/projects.ts index 636f67540d..282e78202b 100644 --- a/packages/core/src/projects.ts +++ b/packages/core/src/projects.ts @@ -3,9 +3,9 @@ import type { Dirent } from "node:fs"; import { readFile, readdir, realpath, stat } from "node:fs/promises"; import { homedir } from "node:os"; import { basename, dirname, isAbsolute, join, relative, sep } from "node:path"; -import { isHyperframesProject, PROJECT_MARKER_FILES } from "./projectRule"; +import { isCompositionFolder, isHyperframesProject, PROJECT_MARKER_FILES } from "./projectRule"; -export { isHyperframesProject, PROJECT_MARKER_FILES }; +export { isCompositionFolder, isHyperframesProject, PROJECT_MARKER_FILES }; export interface FoundProject { path: string; diff --git a/scripts/package-size-budgets.json b/scripts/package-size-budgets.json index 1523d7e3d6..5a9dd37391 100644 --- a/scripts/package-size-budgets.json +++ b/scripts/package-size-budgets.json @@ -9,7 +9,7 @@ }, "@hyperframes/core": { "packed": 1762752, - "unpacked": 4330000 + "unpacked": 4374000 }, "@hyperframes/engine": { "packed": 490452,