feat: initial ROM & emulator manager plugin (M0–M5)
A punktfunk-plugin-* package that scans ROM directories, maps them to emulators, fetches box art, and reconciles them into the host game library under provider id `rom-manager` — with a console-hosted web UI. Engine (pure, unit-tested core): - Table-driven platform registry (~25 consoles) + emulator registry with best-effort per-OS detection (PATH / Flatpak / known paths) and RetroArch core discovery. - Scanner with disc folding (m3u/cue/gdi), archive gating, excludes. - No-Intro title parsing + optional per-platform region dedupe. - Security-critical quoting seam: POSIX single-quote + Windows double-quote with hostile-name refusal; ROM filenames never reach a shell un-quoted. - Pure desired-state reconcile (stable external_ids, scale guard, fingerprint skip) → full-replace PUT /library/provider/rom-manager. Box art (like Steam ROM Manager): SteamGridDB primary (portrait/hero/logo/ header, fuzzy match, operator API key) behind a provider seam, with keyless libretro-thumbnails as the zero-setup fallback (`auto` default). UI: console-hosted via the SDK `servePluginUi` (zero plugin-side auth) with a plugin-local REST/SSE API and a self-contained React SPA (Setup / Emulators / Games / Sync). Standalone password-gated fallback for host-only installs. CLI: scan / detect / preview / sync / uninstall / set-password. 48 engine tests, typecheck + biome clean, SPA builds. Verified end-to-end: scan → detect → reconcile PUT, fingerprint idempotence, and the standalone UI serving SPA + REST. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,131 @@
|
||||
import { describe, expect, test } from "bun:test";
|
||||
import {
|
||||
type DirEnt,
|
||||
makeExcluder,
|
||||
type ScanFs,
|
||||
scanRoot,
|
||||
} from "../src/engine/scanner.js";
|
||||
import { platformById } from "../src/platforms.js";
|
||||
|
||||
/** A synthetic filesystem from a flat `{ absPath: contents }` map (dirs inferred). */
|
||||
const synthFs = (files: Record<string, string>): ScanFs => {
|
||||
const norm = (p: string) => p.replace(/\/+$/, "");
|
||||
return {
|
||||
readDir(dir): DirEnt[] {
|
||||
const base = norm(dir);
|
||||
const children = new Map<string, boolean>(); // name → isDir
|
||||
for (const f of Object.keys(files)) {
|
||||
if (!f.startsWith(`${base}/`)) continue;
|
||||
const rest = f.slice(base.length + 1);
|
||||
const slash = rest.indexOf("/");
|
||||
if (slash === -1) children.set(rest, false);
|
||||
else children.set(rest.slice(0, slash), true);
|
||||
}
|
||||
return [...children].map(([name, isDir]) => ({
|
||||
name,
|
||||
isDir,
|
||||
isFile: !isDir,
|
||||
}));
|
||||
},
|
||||
readText(file) {
|
||||
const c = files[norm(file)];
|
||||
if (c === undefined) throw new Error(`no such file: ${file}`);
|
||||
return c;
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
const snes = platformById("snes")!;
|
||||
const ps1 = platformById("ps1")!;
|
||||
|
||||
const rels = (
|
||||
root: string,
|
||||
files: Record<string, string>,
|
||||
platform = snes,
|
||||
excludes?: string[],
|
||||
) =>
|
||||
scanRoot(synthFs(files), root, platform, excludes)
|
||||
.map((c) => c.relPath)
|
||||
.sort();
|
||||
|
||||
describe("scanRoot — cartridge platform", () => {
|
||||
test("matches platform extensions, recurses, ignores others", () => {
|
||||
const got = rels("/roms/snes", {
|
||||
"/roms/snes/Chrono Trigger (USA).sfc": "",
|
||||
"/roms/snes/Super Metroid.smc": "",
|
||||
"/roms/snes/readme.txt": "",
|
||||
"/roms/snes/sub/Zelda.sfc": "",
|
||||
});
|
||||
expect(got).toEqual([
|
||||
"Chrono Trigger (USA).sfc",
|
||||
"Super Metroid.smc",
|
||||
"sub/Zelda.sfc",
|
||||
]);
|
||||
});
|
||||
|
||||
test("accepts archives regardless of extension list", () => {
|
||||
const got = rels("/roms/snes", {
|
||||
"/roms/snes/Game.zip": "",
|
||||
"/roms/snes/x.foo": "",
|
||||
});
|
||||
expect(got).toEqual(["Game.zip"]);
|
||||
});
|
||||
|
||||
test("excludes apply (glob + directory)", () => {
|
||||
const got = rels(
|
||||
"/roms/snes",
|
||||
{
|
||||
"/roms/snes/A.sfc": "",
|
||||
"/roms/snes/A.sav": "",
|
||||
"/roms/snes/bios/x.sfc": "",
|
||||
},
|
||||
snes,
|
||||
["*.sav", "bios/**"],
|
||||
);
|
||||
expect(got).toEqual(["A.sfc"]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("scanRoot — disc folding", () => {
|
||||
test("m3u playlist folds its cues and their bins into one entry", () => {
|
||||
const got = rels(
|
||||
"/roms/ps1",
|
||||
{
|
||||
"/roms/ps1/FF7.m3u": "FF7 (Disc 1).cue\nFF7 (Disc 2).cue\n",
|
||||
"/roms/ps1/FF7 (Disc 1).cue":
|
||||
'FILE "FF7 (Disc 1).bin" BINARY\n TRACK 01 MODE2/2352',
|
||||
"/roms/ps1/FF7 (Disc 1).bin": "",
|
||||
"/roms/ps1/FF7 (Disc 2).cue": 'FILE "FF7 (Disc 2).bin" BINARY',
|
||||
"/roms/ps1/FF7 (Disc 2).bin": "",
|
||||
},
|
||||
ps1,
|
||||
);
|
||||
expect(got).toEqual(["FF7.m3u"]);
|
||||
});
|
||||
|
||||
test("a standalone cue hides its bin", () => {
|
||||
const got = rels(
|
||||
"/roms/ps1",
|
||||
{
|
||||
"/roms/ps1/Tekken.cue": 'FILE "Tekken.bin" BINARY',
|
||||
"/roms/ps1/Tekken.bin": "",
|
||||
},
|
||||
ps1,
|
||||
);
|
||||
expect(got).toEqual(["Tekken.cue"]);
|
||||
});
|
||||
|
||||
test("chd stands alone", () => {
|
||||
const got = rels("/roms/ps1", { "/roms/ps1/Crash.chd": "" }, ps1);
|
||||
expect(got).toEqual(["Crash.chd"]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("makeExcluder", () => {
|
||||
test("bare pattern matches at any depth; negation re-includes", () => {
|
||||
const ex = makeExcluder(["*.sav", "!keep/**"]);
|
||||
expect(ex("a/b/x.sav")).toBe(true);
|
||||
expect(ex("keep/x.sav")).toBe(false);
|
||||
expect(ex("a/b/x.sfc")).toBe(false);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user