osu-stable-db 0.2.0 → 0.2.1

package/README.md

@@ -55,13 +55,6 @@ const collectionDatabase: CollectionDatabase = {
 const collectionBytes = writeCollectionDatabase(collectionDatabase)
 ```
 
-Main entry exports:
-
-- All public types and constants
-- readOsuDatabase and writeOsuDatabase
-- readCollectionDatabase and writeCollectionDatabase
-- readScoresDatabase and writeScoresDatabase
-
 ## Node Usage
 
 Use the Node subpath when you want to work with a full osu! folder or with direct file reads and writes through node:fs/promises.
@@ -71,7 +64,8 @@ import {
   OsuFolder,
 } from 'osu-stable-db/node'
 
-const osuFolder = new OsuFolder('C:/Games/osu!')
+const osuFolder = new OsuFolder('C:/osu!')
+
 const osuDatabase = await osuFolder.readOsuDatabase()
 const scoresDatabase = await osuFolder.readScoresDatabase()
 
@@ -106,23 +100,13 @@ This project is 100% AI-generated.
 
 Committed minimal fixtures live in [tests/files](tests/files).
 
-Large real-world local fixtures can be placed in:
-
-- [tests/files/local](tests/files/local)
-- [tests/files/local/osu!](tests/files/local/osu!) via a directory link created by the package script below
+To run tests and local scripts against your real osu! installation, set this in [.env](.env):
 
-That directory is git-ignored. When those files are present, the test suite will:
-
-- parse them
-- verify byte-for-byte round-trip for osu!.db, collection.db, and scores.db
-
-To link your real local osu! folder into the workspace on Windows, run:
-
-```bash
-pnpm run local:link -- "C:\\path\\to\\osu!"
+```dotenv
+OSU_STABLE_DIR=C:/osu!
 ```
 
-This creates [tests/files/local/osu!](tests/files/local/osu!) as a directory junction. Tests and local scripts now prefer databases from that linked folder, and fall back to [tests/files/local](tests/files/local) for the previous workflow.
+When OSU_STABLE_DIR is set, local validation reads your real database files and verifies byte-for-byte round-trip for osu!.db, collection.db, and scores.db.
 
 You can also generate a local inspection report for a specific beatmap identifier with:
 
@@ -145,7 +129,7 @@ pnpm run build
 
 ## Notes On Validation
 
-Local validation also passes against private real-world database files in [tests/files/local/osu!](tests/files/local/osu!):
+Local validation also passes against private real-world database files referenced by OSU_STABLE_DIR:
 
 - osu!.db: 58,295,932 bytes, 72,038 beatmaps
 - collection.db: 195,402 bytes, 11 collections, 5,743 stored beatmap references

package/dist/node.d.mts

@@ -2,6 +2,9 @@ import { b as ScoresDatabase, m as OsuDatabase, n as CollectionDatabase, t as Be
 
 //#region src/node.d.ts
 type DatabaseFilePath = string | URL;
+declare const OSU_STABLE_DIR_ENV_VAR = "OSU_STABLE_DIR";
+declare function getConfiguredOsuFolderPath(): string | null;
+declare function getConfiguredOsuFolder(): OsuFolder | null;
 declare function readOsuDatabaseFile(path: DatabaseFilePath): Promise<OsuDatabase>;
 declare function writeOsuDatabaseFile(path: DatabaseFilePath, database: OsuDatabase): Promise<void>;
 declare function readCollectionDatabaseFile(path: DatabaseFilePath): Promise<CollectionDatabase>;
@@ -24,4 +27,4 @@ declare class OsuFolder {
   getOsrFilePath(score: ScoreEntry): string;
 }
 //#endregion
-export { DatabaseFilePath, OsuFolder, readCollectionDatabaseFile, readOsuDatabaseFile, readScoresDatabaseFile, writeCollectionDatabaseFile, writeOsuDatabaseFile, writeScoresDatabaseFile };
+export { DatabaseFilePath, OSU_STABLE_DIR_ENV_VAR, OsuFolder, getConfiguredOsuFolder, getConfiguredOsuFolderPath, readCollectionDatabaseFile, readOsuDatabaseFile, readScoresDatabaseFile, writeCollectionDatabaseFile, writeOsuDatabaseFile, writeScoresDatabaseFile };

package/dist/node.mjs

@@ -2,6 +2,15 @@ import { a as writeOsuDatabase, i as readOsuDatabase, n as writeScoresDatabase,
 import { readFile, writeFile } from "node:fs/promises";
 import { join } from "node:path";
 //#region src/node.ts
+const OSU_STABLE_DIR_ENV_VAR = "OSU_STABLE_DIR";
+function getConfiguredOsuFolderPath() {
+	const folderPath = process.env[OSU_STABLE_DIR_ENV_VAR]?.trim();
+	return folderPath === void 0 || folderPath.length === 0 ? null : folderPath;
+}
+function getConfiguredOsuFolder() {
+	const folderPath = getConfiguredOsuFolderPath();
+	return folderPath === null ? null : new OsuFolder(folderPath);
+}
 async function readOsuDatabaseFile(path) {
 	return readOsuDatabase(new Uint8Array(await readFile(path)));
 }
@@ -62,4 +71,4 @@ var OsuFolder = class {
 	}
 };
 //#endregion
-export { OsuFolder, readCollectionDatabaseFile, readOsuDatabaseFile, readScoresDatabaseFile, writeCollectionDatabaseFile, writeOsuDatabaseFile, writeScoresDatabaseFile };
+export { OSU_STABLE_DIR_ENV_VAR, OsuFolder, getConfiguredOsuFolder, getConfiguredOsuFolderPath, readCollectionDatabaseFile, readOsuDatabaseFile, readScoresDatabaseFile, writeCollectionDatabaseFile, writeOsuDatabaseFile, writeScoresDatabaseFile };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "osu-stable-db",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript reader and writer for osu!stable database files.",
   "author": "zzzzv",
   "license": "MIT",
@@ -29,10 +29,9 @@
   "scripts": {
     "build": "tsdown",
     "dev": "tsdown --watch",
-    "local:link": "node scripts/local-link.mjs",
-    "local:inspect": "pnpm run build && node scripts/local-inspect.mjs",
-    "local:roundtrip": "pnpm run build && node scripts/local-roundtrip.mjs",
-    "test": "vitest",
+    "local:inspect": "pnpm run build && node --env-file=.env scripts/local-inspect.mjs",
+    "local:roundtrip": "pnpm run build && node --env-file=.env scripts/local-roundtrip.mjs",
+    "test": "node --env-file=.env ./node_modules/vitest/vitest.mjs",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "pnpm run build"
   },