@rohal12/twee-ts 1.4.0 → 1.5.0

package/dist/index.d.cts

@@ -38,6 +38,8 @@ interface CompileOptions {
     noRemote?: boolean;
     /** Map alias tags to canonical special tags (e.g. { library: 'script' }). */
     tagAliases?: Record<string, string>;
+    /** Emit source file and line as data- attributes on passage elements. Default: false. */
+    sourceInfo?: boolean;
 }
 interface CompileToFileOptions extends CompileOptions {
     /** Output file path. */
@@ -73,6 +75,10 @@ interface CompileStats {
     words: number;
     files: string[];
 }
+interface SourceLocation {
+    readonly file: string;
+    readonly line: number;
+}
 interface PassageMetadata {
     position?: string;
     size?: string;
@@ -83,6 +89,7 @@ interface Passage {
     tags: string[];
     text: string;
     metadata?: PassageMetadata;
+    source?: SourceLocation;
 }
 interface Twine1Metadata {
     settings: Map<string, string>;
@@ -171,6 +178,7 @@ interface TweeTsConfig {
     testMode?: boolean;
     noRemote?: boolean;
     tagAliases?: Record<string, string>;
+    sourceInfo?: boolean;
 }
 
 declare class TweeTsError extends Error {
@@ -365,4 +373,4 @@ declare function resolveRemoteFormat(name: string, version: string, indices?: st
 /** Discover all cached remote formats. Returns a Map like discoverFormats(). */
 declare function discoverCachedFormats(): Map<string, StoryFormatInfo>;
 
-export { type BrokenLink, CONFIG_FILENAME, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type InlineSource, ItemType, type LexerItem, type OutputMode, type Passage, type PassageMetadata, type SFAIndex, type SFAIndexEntry, type SourceInput, type Story, type StoryFormatInfo, type StoryMap, TweeLexer, type TweeTsConfig, TweeTsError, type WatchOptions, applyTagAliases, compile, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, generateIFID, getCacheDir, getFormatSearchDirs, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };
+export { type BrokenLink, CONFIG_FILENAME, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type InlineSource, ItemType, type LexerItem, type OutputMode, type Passage, type PassageMetadata, type SFAIndex, type SFAIndexEntry, type SourceInput, type SourceLocation, type Story, type StoryFormatInfo, type StoryMap, TweeLexer, type TweeTsConfig, TweeTsError, type WatchOptions, applyTagAliases, compile, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, generateIFID, getCacheDir, getFormatSearchDirs, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };

package/dist/index.d.ts

@@ -38,6 +38,8 @@ interface CompileOptions {
     noRemote?: boolean;
     /** Map alias tags to canonical special tags (e.g. { library: 'script' }). */
     tagAliases?: Record<string, string>;
+    /** Emit source file and line as data- attributes on passage elements. Default: false. */
+    sourceInfo?: boolean;
 }
 interface CompileToFileOptions extends CompileOptions {
     /** Output file path. */
@@ -73,6 +75,10 @@ interface CompileStats {
     words: number;
     files: string[];
 }
+interface SourceLocation {
+    readonly file: string;
+    readonly line: number;
+}
 interface PassageMetadata {
     position?: string;
     size?: string;
@@ -83,6 +89,7 @@ interface Passage {
     tags: string[];
     text: string;
     metadata?: PassageMetadata;
+    source?: SourceLocation;
 }
 interface Twine1Metadata {
     settings: Map<string, string>;
@@ -171,6 +178,7 @@ interface TweeTsConfig {
     testMode?: boolean;
     noRemote?: boolean;
     tagAliases?: Record<string, string>;
+    sourceInfo?: boolean;
 }
 
 declare class TweeTsError extends Error {
@@ -365,4 +373,4 @@ declare function resolveRemoteFormat(name: string, version: string, indices?: st
 /** Discover all cached remote formats. Returns a Map like discoverFormats(). */
 declare function discoverCachedFormats(): Map<string, StoryFormatInfo>;
 
-export { type BrokenLink, CONFIG_FILENAME, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type InlineSource, ItemType, type LexerItem, type OutputMode, type Passage, type PassageMetadata, type SFAIndex, type SFAIndexEntry, type SourceInput, type Story, type StoryFormatInfo, type StoryMap, TweeLexer, type TweeTsConfig, TweeTsError, type WatchOptions, applyTagAliases, compile, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, generateIFID, getCacheDir, getFormatSearchDirs, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };
+export { type BrokenLink, CONFIG_FILENAME, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type InlineSource, ItemType, type LexerItem, type OutputMode, type Passage, type PassageMetadata, type SFAIndex, type SFAIndexEntry, type SourceInput, type SourceLocation, type Story, type StoryFormatInfo, type StoryMap, TweeLexer, type TweeTsConfig, TweeTsError, type WatchOptions, applyTagAliases, compile, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, generateIFID, getCacheDir, getFormatSearchDirs, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };

package/dist/index.js

@@ -190,7 +190,7 @@ function passageToTwee(p, outMode) {
   output += "\n\n";
   return output;
 }
-function passageToPassagedata(p, pid) {
+function passageToPassagedata(p, pid, options) {
   let position;
   let size;
   if (hasMetadataPosition(p)) {
@@ -207,7 +207,11 @@ function passageToPassagedata(p, pid) {
   } else {
     size = "100,100";
   }
-  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>`;
+  let attrs = `<tw-passagedata pid="${pid}" name=${quote(fullAttrEscape(p.name))} tags=${quote(attrEscape(p.tags.join(" ")))} position=${quote(attrEscape(position))} size=${quote(attrEscape(size))}`;
+  if (options?.sourceInfo && p.source) {
+    attrs += ` data-source-file=${quote(attrEscape(p.source.file))} data-source-line="${p.source.line}"`;
+  }
+  return `${attrs}>${htmlEscape(p.text)}</tw-passagedata>`;
 }
 function passageToTiddler(p, pid, obfuscateRot13 = false) {
   let position;
@@ -1187,7 +1191,7 @@ function parseTwee(source, options = {}) {
         if (pCount > 1 && current) {
           passages.push(current);
         }
-        current = { name: "", tags: [], text: "" };
+        current = { name: "", tags: [], text: "", source: { file: filename, line: item.line } };
         break;
       case 3 /* Name */: {
         if (!current) break;
@@ -1434,20 +1438,20 @@ var VERSION = "1.2.0";
 
 // src/output-twine2.ts
 var CREATOR_NAME = "Twee-ts";
-function toTwine2Archive(story, startName, diagnostics) {
-  return getTwine2DataChunk(story, startName, diagnostics) + "\n";
+function toTwine2Archive(story, startName, diagnostics, options) {
+  return getTwine2DataChunk(story, startName, diagnostics, options) + "\n";
 }
-function toTwine2HTML(story, format, startName, diagnostics) {
+function toTwine2HTML(story, format, startName, diagnostics, options) {
   let template = readFormatSource(format);
   if (template.includes("{{STORY_NAME}}")) {
     template = template.replaceAll("{{STORY_NAME}}", htmlEscape(story.name));
   }
   if (template.includes("{{STORY_DATA}}")) {
-    template = template.replace("{{STORY_DATA}}", getTwine2DataChunk(story, startName, diagnostics));
+    template = template.replace("{{STORY_DATA}}", getTwine2DataChunk(story, startName, diagnostics, options));
   }
   return template;
 }
-function getTwine2DataChunk(story, startName, diagnostics) {
+function getTwine2DataChunk(story, startName, diagnostics, options) {
   ensureIFID(story, diagnostics);
   const parts = [];
   let startID = "";
@@ -1502,7 +1506,7 @@ function getTwine2DataChunk(story, startName, diagnostics) {
     if (p.name === "StorySettings" && story.twine1.settings.size === 0) {
       continue;
     }
-    parts.push(passageToPassagedata(p, pid));
+    parts.push(passageToPassagedata(p, pid, options));
     if (startName === p.name) {
       startID = String(pid);
     }
@@ -1512,9 +1516,9 @@ function getTwine2DataChunk(story, startName, diagnostics) {
   for (const [opt, val] of story.twine2.options) {
     if (val) opts.push(opt);
   }
-  const options = opts.join(" ");
+  const optionsStr = opts.join(" ");
   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>`;
+  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(optionsStr)}" tags="${attrEscape(story.twine2.tags)}" hidden>`;
   return wrapper + parts.join("") + "</tw-storydata>";
 }
 function ensureIFID(story, diagnostics) {
@@ -1969,6 +1973,7 @@ async function buildOutput(options) {
   const twee2Compat = options.twee2Compat ?? false;
   const testMode = options.testMode ?? false;
   const noRemote = options.noRemote ?? false;
+  const sourceInfo = options.sourceInfo ?? false;
   clearIndexCache();
   const filePaths = [];
   const inlineSources = [];
@@ -2030,7 +2035,7 @@ async function buildOutput(options) {
       output = toTwee(story, outputMode);
       break;
     case "twine2-archive":
-      output = toTwine2Archive(story, startName, diagnostics);
+      output = toTwine2Archive(story, startName, diagnostics, { sourceInfo });
       break;
     case "twine1-archive":
       output = toTwine1Archive(story, startName);
@@ -2049,7 +2054,7 @@ async function buildOutput(options) {
         throw new TweeTsError("No story format available for HTML output.", diagnostics);
       }
       if (format.isTwine2) {
-        output = toTwine2HTML(story, format, startName, diagnostics);
+        output = toTwine2HTML(story, format, startName, diagnostics, { sourceInfo });
       } else {
         if (story.name === "" && !storyHas(story, "StoryTitle")) {
           diagnostics.push({
@@ -2282,7 +2287,7 @@ function validateConfig(data) {
       errors.push(`"${key}" must be a string.`);
     }
   }
-  for (const key of ["useTweegoPath", "trim", "twee2Compat", "testMode", "noRemote"]) {
+  for (const key of ["useTweegoPath", "trim", "twee2Compat", "testMode", "noRemote", "sourceInfo"]) {
     if (key in obj && typeof obj[key] !== "boolean") {
       errors.push(`"${key}" must be a boolean.`);
     }