feat: add metadata.json to overwrite story.json metadata

.github/workflows/deno.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Setup Deno
         uses: denoland/setup-deno@v1
         with:
-          deno-version: v1.34.2
+          deno-version: v1.39.1
 
       - name: Verify formatting
         run: deno task fmt
@@ -43,7 +43,7 @@ jobs:
       - name: Setup Deno
         uses: denoland/setup-deno@v1
         with:
-          deno-version: v1.34.2
+          deno-version: v1.39.1
 
       - name: check version
         run: test $(./version.ts) = ${GITHUB_REF##*/}

.gitignore

@@ -9,3 +9,4 @@
 /.idea/jpa-buddy.xml
 /.idea/google-java-format.xml
 /.idea/inspectionProfiles
+/.idea/sonarlint/

CHANGELOG.md

@@ -1,3 +1,8 @@
+### v0.2.10 / 2023.12.27
+
+- use deno 1.39.1
+- add metadata.json to overwrite story.json metadata
+
 ### v0.2.9 / 2023.07.28
 
 - feat: add images convertion #21

README.md

@@ -245,6 +245,23 @@ Options:
 - Option to skip the beginning of stories.
 - Zip Pack aggregation
 
+### Overwrite metadata
+
+If the file `metadata.json` exists in the story folder, it will be used to
+overwrite the `story.json` metadata.
+
+All key/value are optional, ex:
+
+```json
+{
+  "title": "title - overwrite",
+  "description": "description - overwrite",
+  "format": "v1",
+  "version": 1,
+  "nightModeAvailable": false
+}
+```
+
 ## Development
 
 Some dev command are listed in the deno.json file :

gen_pack.ts

@@ -1,4 +1,4 @@
-import { File, Folder } from "./serialize/types.ts";
+import { File, Folder, Metadata } from "./serialize/types.ts";
 import { fsToFolder } from "./serialize/fs.ts";
 import { extractImagesFromAudio } from "./generate/extract_images_from_audio.ts";
 import { genMissingItems } from "./generate/gen_missing_items.ts";
@@ -95,7 +95,9 @@ export async function generatePack(opt: ModOptions) {
     }
     if (!opt.skipZipGeneration) {
       folder = await fsToFolder(opt.storyPath, true);
-      const pack = folderToPack(folder, !!opt.nightMode);
+
+      const metadata: Metadata = await getMetadata(opt);
+      const pack = folderToPack(folder, metadata);
       const nightModeAudioItemName = getNightModeAudioItem(folder);
       const serializedPack = await serializePack(pack, opt, {
         autoNextStoryTransition: opt.autoNextStoryTransition,
@@ -115,3 +117,15 @@ export async function generatePack(opt: ModOptions) {
     }
   }
 }
+
+async function getMetadata(opt: ModOptions): Promise<Metadata> {
+  const metadataPath = `${opt.storyPath}/metadata.json`;
+  if (await exists(metadataPath)) {
+    const metadataJson = await Deno.readTextFile(metadataPath);
+    return JSON.parse(metadataJson);
+  } else {
+    return {
+      nightMode: !!opt.nightMode,
+    };
+  }
+}

serialize/converter.ts

@@ -2,6 +2,7 @@ import {
   File,
   Folder,
   Menu,
+  Metadata,
   Pack,
   Story,
   StoryItem,
@@ -20,14 +21,14 @@ import {
   isZipFile,
 } from "../utils/utils.ts";
 
-export function folderToPack(folder: Folder, nightMode = false): Pack {
+export function folderToPack(folder: Folder, metadata?: Metadata): Pack {
   const firstSubFolder = folder.files.find((f) => isFolder(f)) as Folder;
   return {
-    title: folder!.name,
-    description: "",
-    format: "v1",
-    version: 1,
-    nightModeAvailable: nightMode,
+    title: metadata?.title ?? folder!.name,
+    description: metadata?.description ?? "",
+    format: metadata?.format ?? "v1",
+    version: metadata?.version ?? 1,
+    nightModeAvailable: !!(metadata?.nightMode),
     entrypoint: {
       class: "StageNode-Entrypoint",
       name: "Cover node",

serialize/types.ts

@@ -9,9 +9,9 @@ export type File = {
 
 export type Pack = {
   title: string;
-  description: "";
-  format: "v1";
-  version: 1;
+  description: string;
+  format: string;
+  version: number;
   nightModeAvailable: boolean;
   entrypoint: Entrypoint;
 };
@@ -81,9 +81,9 @@ export type ActionNode = {
 
 export type SerializedPack = {
   title: string;
-  description: "";
-  format: "v1";
-  version: 1;
+  description: string;
+  format: string;
+  version: number;
   nightModeAvailable: boolean;
   actionNodes: ActionNode[];
   stageNodes: StageNode[];
@@ -94,3 +94,11 @@ export type ZipMenu = {
   class: "ZipMenu";
   path: string;
 };
+
+export type Metadata = {
+  title?: string;
+  description?: string;
+  format?: string;
+  version?: number;
+  nightMode?: boolean;
+};

version.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S deno run -A
 
-export const version = "v0.2.9";
+export const version = "v0.2.10";
 
 if (import.meta.main) {
   console.log(version);