@rohal12/twee-ts 1.2.0 → 1.4.0

package/README.md

@@ -1,5 +1,14 @@
 # twee-ts
 
+[![npm](https://img.shields.io/npm/v/@rohal12/twee-ts)](https://www.npmjs.com/package/@rohal12/twee-ts)
+[![CI](https://img.shields.io/github/actions/workflow/status/rohal12/twee-ts/ci.yml)](https://github.com/rohal12/twee-ts/actions)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/@rohal12/twee-ts)](https://bundlephobia.com/package/@rohal12/twee-ts)
+[![zero dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)]()
+[![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue)](https://www.typescriptlang.org/)
+[![node](https://img.shields.io/node/v/@rohal12/twee-ts)](https://nodejs.org/)
+[![last commit](https://img.shields.io/github/last-commit/rohal12/twee-ts)](https://github.com/rohal12/twee-ts/commits)
+[![license](https://img.shields.io/npm/l/@rohal12/twee-ts)](./UNLICENSE)
+
 TypeScript reimplementation of [Tweego](https://www.motoslave.net/tweego/) — a command-line compiler for Twine/Twee interactive fiction projects.
 
 Zero runtime dependencies. Node.js 22+.

package/dist/bin/twee-ts.js

@@ -64,6 +64,10 @@ function attrEscape(s) {
   if (s.length === 0) return s;
   return s.replace(/&/g, "&").replace(/"/g, """).replace(/'/g, "'");
 }
+function fullAttrEscape(s) {
+  if (s.length === 0) return s;
+  return s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
+}
 function htmlEscape(s) {
   if (s.length === 0) return s;
   return s.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
@@ -86,6 +90,13 @@ function commentSanitize(s) {
 function htmlCommentSanitize(s) {
   return s.replace(/-->/g, "-- >");
 }
+function rot13(s) {
+  if (s.length === 0) return s;
+  return s.replace(/[A-Za-z]/g, (ch) => {
+    const base = ch <= "Z" ? 65 : 97;
+    return String.fromCharCode((ch.charCodeAt(0) - base + 13) % 26 + base);
+  });
+}
 function tweeUnescape(s) {
   if (s.length === 0) return s;
   let result = "";
@@ -150,12 +161,14 @@ function hasMetadataSize(p) {
   return p.metadata != null && p.metadata.size != null && p.metadata.size !== "";
 }
 function hasAnyMetadata(p) {
-  return hasMetadataPosition(p) || hasMetadataSize(p);
+  if (!p.metadata) return false;
+  return Object.values(p.metadata).some((v) => v != null && v !== "");
 }
 function marshalMetadata(meta) {
   const obj = {};
-  if (meta.position) obj.position = meta.position;
-  if (meta.size) obj.size = meta.size;
+  for (const [key, value] of Object.entries(meta)) {
+    if (typeof value === "string" && value) obj[key] = value;
+  }
   return JSON.stringify(obj);
 }
 function passageToTwee(p, outMode) {
@@ -198,9 +211,9 @@ function passageToPassagedata(p, pid) {
   } else {
     size = "100,100";
   }
-  return `<tw-passagedata pid="${pid}" name=${quote(attrEscape(p.name))} tags=${quote(attrEscape(p.tags.join(" ")))} position=${quote(attrEscape(position))} size=${quote(attrEscape(size))}>${htmlEscape(p.text)}</tw-passagedata>`;
+  return `<tw-passagedata pid="${pid}" name=${quote(fullAttrEscape(p.name))} tags=${quote(attrEscape(p.tags.join(" ")))} position=${quote(attrEscape(position))} size=${quote(attrEscape(size))}>${htmlEscape(p.text)}</tw-passagedata>`;
 }
-function passageToTiddler(p, pid) {
+function passageToTiddler(p, pid, obfuscateRot13 = false) {
   let position;
   if (hasMetadataPosition(p)) {
     position = p.metadata?.position ?? "";
@@ -211,7 +224,10 @@ function passageToTiddler(p, pid) {
     const yp = x === 0 ? y : y + 1;
     position = `${xp * 140 - 130},${yp * 140 - 130}`;
   }
-  return `<div tiddler=${quote(attrEscape(p.name))} tags=${quote(attrEscape(p.tags.join(" ")))} twine-position=${quote(attrEscape(position))}>${tiddlerEscape(p.text)}</div>`;
+  const created = (/* @__PURE__ */ new Date()).toISOString().replace(/[-:T]/g, "").slice(0, 12);
+  const content = obfuscateRot13 && p.name !== "StorySettings" ? tiddlerEscape(rot13(p.text)) : tiddlerEscape(p.text);
+  const nameComment = obfuscateRot13 ? `<!-- ${commentSanitize(p.name)} -->` : "";
+  return `<div tiddler=${quote(attrEscape(p.name))} tags=${quote(attrEscape(p.tags.join(" ")))} created=${quote(created)} modifier=${quote("twee")} twine-position=${quote(attrEscape(position))}>${nameComment}${content}</div>`;
 }
 function countWords(p) {
   let text = p.text;
@@ -254,6 +270,7 @@ function createStory() {
       formatVersion: "",
       options: /* @__PURE__ */ new Map(),
       start: "",
+      tags: "",
       tagColors: /* @__PURE__ */ new Map(),
       zoom: 1
     }
@@ -300,6 +317,7 @@ function marshalStoryData(story) {
   }
   if (options.length > 0) data.options = options;
   if (story.twine2.start) data.start = story.twine2.start;
+  if (story.twine2.tags) data.tags = story.twine2.tags;
   if (story.twine2.tagColors.size > 0) {
     data["tag-colors"] = Object.fromEntries(story.twine2.tagColors);
   }
@@ -327,6 +345,7 @@ function unmarshalStoryData(story, json) {
     }
   }
   if (typeof data.start === "string" && data.start) story.twine2.start = data.start;
+  if (typeof data.tags === "string") story.twine2.tags = data.tags;
   if (typeof data["tag-colors"] === "object" && data["tag-colors"] !== null && !Array.isArray(data["tag-colors"])) {
     for (const [tag, color] of Object.entries(data["tag-colors"])) {
       if (typeof color === "string") story.twine2.tagColors.set(tag, color);
@@ -398,7 +417,7 @@ function storyAdd(story, p, diagnostics) {
         processed = { ...p, text: marshalStoryData(story) };
       } else {
         diagnostics.push({
-          level: "error",
+          level: "warning",
           message: `Cannot unmarshal "StoryData" compiler special passage; ${err}.`
         });
       }
@@ -621,17 +640,41 @@ function baseNameWithoutExt(filename) {
 }
 
 // src/formats.ts
+function relaxedJSONParse(json) {
+  try {
+    return JSON.parse(json);
+  } catch {
+  }
+  let fixed = json;
+  fixed = fixed.replace(/'([^'\\]*(?:\\.[^'\\]*)*)'/g, '"$1"');
+  fixed = fixed.replace(/(?<=^|[{,]\s*)([A-Za-z_$][A-Za-z0-9_$]*)\s*:/gm, '"$1":');
+  fixed = fixed.replace(/,\s*([}\]])/g, "$1");
+  return JSON.parse(fixed);
+}
 function parseFormatJSON(source, formatId) {
   const first = source.indexOf("{");
   const last = source.lastIndexOf("}");
   if (first === -1 || last === -1) return null;
   let chunk = source.slice(first, last + 1);
   const parse = (json) => {
-    const raw = JSON.parse(json);
+    const raw = relaxedJSONParse(json);
     if (typeof raw !== "object" || raw === null || Array.isArray(raw)) return null;
     const obj = raw;
-    if (typeof obj.name !== "string" || typeof obj.version !== "string" || typeof obj.source !== "string") return null;
-    return { name: obj.name, version: obj.version, source: obj.source, proofing: obj.proofing === true };
+    if (typeof obj.version !== "string" || typeof obj.source !== "string") return null;
+    if (!parseSemver(obj.version)) return null;
+    const name = typeof obj.name === "string" ? obj.name : "Untitled Story Format";
+    const result = {
+      name,
+      version: obj.version,
+      source: obj.source,
+      proofing: obj.proofing === true
+    };
+    if (typeof obj.author === "string") result.author = obj.author;
+    if (typeof obj.description === "string") result.description = obj.description;
+    if (typeof obj.image === "string") result.image = obj.image;
+    if (typeof obj.url === "string") result.url = obj.url;
+    if (typeof obj.license === "string") result.license = obj.license;
+    return result;
   };
   try {
     return parse(chunk);
@@ -697,17 +740,55 @@ function discoverFormats(searchDirs) {
             format.name = data.name;
             format.version = data.version;
             format.proofing = data.proofing ?? false;
+            if (data.author) format.author = data.author;
+            if (data.description) format.description = data.description;
+            if (data.image) format.image = data.image;
+            if (data.url) format.url = data.url;
+            if (data.license) format.license = data.license;
           } catch {
             continue;
           }
+        } else {
+          format.name = entry;
         }
         formats.set(entry, format);
         break;
       }
     }
   }
+  pruneFormats(formats);
   return formats;
 }
+function pruneFormats(formats) {
+  const bestByNameMajor = /* @__PURE__ */ new Map();
+  const seenNameVersion = /* @__PURE__ */ new Set();
+  for (const [id, f] of formats) {
+    if (!f.isTwine2 || !f.name || !f.version) continue;
+    const v = parseSemver(f.version);
+    if (!v) continue;
+    const nameVersionKey = `${f.name}@${f.version}`;
+    if (seenNameVersion.has(nameVersionKey)) {
+      formats.delete(id);
+      continue;
+    }
+    seenNameVersion.add(nameVersionKey);
+    const groupKey = `${f.name}@${v[0]}`;
+    const existing = bestByNameMajor.get(groupKey);
+    if (!existing || semverCompare(v, existing.version) > 0) {
+      bestByNameMajor.set(groupKey, { id, version: v });
+    }
+  }
+  for (const [id, f] of [...formats]) {
+    if (!f.isTwine2 || !f.name || !f.version) continue;
+    const v = parseSemver(f.version);
+    if (!v) continue;
+    const groupKey = `${f.name}@${v[0]}`;
+    const best = bestByNameMajor.get(groupKey);
+    if (best && best.id !== id) {
+      formats.delete(id);
+    }
+  }
+}
 function getFormatSearchDirs(extraPaths = [], useTweegoPath = true) {
   const subdirNames = ["storyformats", ".storyformats", "story-formats", "storyFormats", "targets"];
   const basePaths = /* @__PURE__ */ new Set();
@@ -1144,8 +1225,11 @@ function parseTwee(source, options = {}) {
           }
           const parsed = raw;
           const meta = {};
-          if (typeof parsed.position === "string") meta.position = parsed.position;
-          if (typeof parsed.size === "string") meta.size = parsed.size;
+          for (const [key, value] of Object.entries(parsed)) {
+            if (typeof value === "string") {
+              meta[key] = value;
+            }
+          }
           current.metadata = meta;
         } catch (e) {
           diagnostics.push({
@@ -1159,7 +1243,11 @@ function parseTwee(source, options = {}) {
       }
       case 6 /* Content */: {
         if (!current) break;
-        current.text = trim ? item.val.trim() : item.val;
+        if (trim) {
+          current.text = item.val.trim();
+        } else {
+          current.text = item.val.replace(/\n\s*$/, "");
+        }
         break;
       }
       default: {
@@ -1387,8 +1475,12 @@ function getTwine2DataChunk(story, startName, diagnostics) {
     }
   }
   parts.push(`<script role="script" id="twine-user-script" type="text/twine-javascript">${scriptContent}</script>`);
+  const validTagColors = /* @__PURE__ */ new Set(["gray", "red", "orange", "yellow", "green", "blue", "purple"]);
+  const hexColorPattern = /^#[0-9a-fA-F]{3,8}$/;
   for (const [tag, color] of story.twine2.tagColors) {
-    parts.push(`<tw-tag name="${attrEscape(tag)}" color="${attrEscape(color)}"></tw-tag>`);
+    if (validTagColors.has(color) || hexColorPattern.test(color)) {
+      parts.push(`<tw-tag name="${attrEscape(tag)}" color="${attrEscape(color)}"></tw-tag>`);
+    }
   }
   pid = 1;
   for (const p of story.passages) {
@@ -1409,23 +1501,24 @@ function getTwine2DataChunk(story, startName, diagnostics) {
     if (val) opts.push(opt);
   }
   const options = opts.join(" ");
-  const zoom = story.twine2.zoom === Math.floor(story.twine2.zoom) ? story.twine2.zoom.toString() : story.twine2.zoom.toFixed(1);
-  const wrapper = `<!-- UUID://${htmlCommentSanitize(story.ifid)}// --><tw-storydata name="${attrEscape(story.name)}" startnode="${attrEscape(startID)}" creator="${attrEscape(CREATOR_NAME)}" creator-version="${attrEscape(VERSION)}" ifid="${attrEscape(story.ifid)}" zoom="${attrEscape(zoom)}" format="${attrEscape(story.twine2.format)}" format-version="${attrEscape(story.twine2.formatVersion)}" options="${attrEscape(options)}" hidden>`;
+  const zoom = String(story.twine2.zoom);
+  const wrapper = `<!-- UUID://${htmlCommentSanitize(story.ifid)}// --><tw-storydata name="${attrEscape(story.name)}" startnode="${attrEscape(startID)}" creator="${attrEscape(CREATOR_NAME)}" creator-version="${attrEscape(VERSION)}" ifid="${attrEscape(story.ifid)}" zoom="${attrEscape(zoom)}" format="${attrEscape(story.twine2.format)}" format-version="${attrEscape(story.twine2.formatVersion)}" options="${attrEscape(options)}" tags="${attrEscape(story.twine2.tags)}" hidden>`;
   return wrapper + parts.join("") + "</tw-storydata>";
 }
 function ensureIFID(story, diagnostics) {
   if (story.ifid !== "") return;
   if (story.legacyIFID !== "") {
+    story.ifid = story.legacyIFID;
     diagnostics.push({
       level: "warning",
       message: 'Story IFID not found; reusing "ifid" entry from the "StorySettings" special passage.'
     });
-    story.ifid = story.legacyIFID;
   } else {
-    story.ifid = generateIFID();
+    const ifid = generateIFID();
+    story.ifid = ifid;
     diagnostics.push({
-      level: "warning",
-      message: `Story IFID not found; generated ${story.ifid} for your project. Add it to a StoryData passage.`
+      level: "error",
+      message: `Story IFID not found. Add an IFID to your story: {"ifid":"${ifid}"}`
     });
   }
 }
@@ -1436,7 +1529,7 @@ import { join as join3, dirname } from "path";
 var CREATOR_NAME2 = "twee-ts";
 function toTwine1Archive(story, _startName) {
   const { data, count } = getTwine1PassageChunk(story);
-  return `<div id="storeArea" data-size="${count}" hidden>${data}</div>
+  return `<div id="storeArea" data-size="${count}">${data}</div>
 `;
 }
 function toTwine1HTML(story, format, startName, _diagnostics) {
@@ -1481,12 +1574,13 @@ function toTwine1HTML(story, format, startName, _diagnostics) {
   return template;
 }
 function getTwine1PassageChunk(story) {
+  const obfuscateRot13 = story.twine1.settings.get("obfuscate") === "rot13";
   let data = "";
   let count = 0;
   for (const p of story.passages) {
     if (hasTag(p, "Twine.private")) continue;
     count++;
-    data += passageToTiddler(p, count);
+    data += passageToTiddler(p, count, obfuscateRot13);
   }
   return { data, count };
 }
@@ -1822,6 +1916,7 @@ function discoverCachedFormats() {
 }
 
 // src/compiler.ts
+var CREATOR_NAME3 = "Twee-ts";
 var DEFAULT_FORMAT_ID = "sugarcube-2";
 var DEFAULT_START_NAME = "Start";
 var TweeTsError = class extends Error {
@@ -1968,28 +2063,49 @@ async function buildOutput(options) {
   return { output, story, format, diagnostics, stats };
 }
 function storyToJSON(story) {
-  return JSON.stringify(
-    {
-      name: story.name,
-      ifid: story.ifid,
-      passages: story.passages.map((p) => ({
+  const scripts = [];
+  const stylesheets = [];
+  const storyPassages = [];
+  for (const p of story.passages) {
+    if (p.name === "StoryTitle" || p.name === "StoryData") continue;
+    if (hasTag(p, "Twine.private")) continue;
+    if (hasTag(p, "script")) {
+      scripts.push(p.text);
+    } else if (hasTag(p, "stylesheet")) {
+      stylesheets.push(p.text);
+    } else {
+      const entry = {
         name: p.name,
         tags: p.tags,
-        text: p.text,
-        metadata: p.metadata ?? null
-      })),
-      twine2: {
-        format: story.twine2.format,
-        formatVersion: story.twine2.formatVersion,
-        start: story.twine2.start,
-        tagColors: Object.fromEntries(story.twine2.tagColors),
-        options: Object.fromEntries(story.twine2.options),
-        zoom: story.twine2.zoom
+        text: p.text
+      };
+      if (p.metadata) {
+        const meta = {};
+        for (const [key, value] of Object.entries(p.metadata)) {
+          if (typeof value === "string") meta[key] = value;
+        }
+        if (Object.keys(meta).length > 0) {
+          entry.metadata = meta;
+        }
       }
-    },
-    null,
-    2
-  );
+      storyPassages.push(entry);
+    }
+  }
+  const obj = {
+    name: story.name
+  };
+  if (story.ifid) obj.ifid = story.ifid;
+  if (story.twine2.format) obj.format = story.twine2.format;
+  if (story.twine2.formatVersion) obj["format-version"] = story.twine2.formatVersion;
+  if (story.twine2.start) obj.start = story.twine2.start;
+  if (story.twine2.tagColors.size > 0) obj["tag-colors"] = Object.fromEntries(story.twine2.tagColors);
+  if (story.twine2.zoom !== 1) obj.zoom = story.twine2.zoom;
+  obj.creator = CREATOR_NAME3;
+  obj["creator-version"] = VERSION;
+  obj.style = stylesheets.join("\n");
+  obj.script = scripts.join("\n");
+  obj.passages = storyPassages;
+  return JSON.stringify(obj, null, 2);
 }
 
 // src/config.ts