@rohal12/twee-ts 1.16.1 → 1.17.0

package/dist/{compiler-Bmpbelqj.js → diagnostics-DZNS7W41.js}

@@ -4419,14 +4419,16 @@ function parseDocument(data, options) {
 */
 /**
 * Parse a Twine 2 or Twine 1 compiled HTML file back into a Story model.
+* Tweego always trims passage text; here `trim: false` keeps it exactly, as for Twee sources.
 */
-function decompileHTML(html) {
+function decompileHTML(html, options = {}) {
 	const diagnostics = [];
 	const story = createStory();
+	const passageText = options.trim === false ? (text) => text : (text) => text.trim();
 	const doc = parseDocument(html);
 	const twine2Data = findElement(doc, "tw-storydata");
 	if (twine2Data) {
-		decompileTwine2(twine2Data, story, diagnostics);
+		decompileTwine2(twine2Data, story, passageText, diagnostics);
 		return {
 			story,
 			diagnostics
@@ -4434,7 +4436,7 @@ function decompileHTML(html) {
 	}
 	const twine1Data = findElementByIdPattern(doc, /^store(?:-a|A)rea$/);
 	if (twine1Data) {
-		decompileTwine1(twine1Data, story, diagnostics);
+		decompileTwine1(twine1Data, story, passageText, diagnostics);
 		return {
 			story,
 			diagnostics
@@ -4449,7 +4451,7 @@ function decompileHTML(html) {
 		diagnostics
 	};
 }
-function decompileTwine2(storyData, story, diagnostics) {
+function decompileTwine2(storyData, story, passageText, diagnostics) {
 	let startnode = 0;
 	const attrs = storyData.attribs ?? {};
 	if (attrs["name"]) story.name = attrs["name"];
@@ -4479,8 +4481,9 @@ function decompileTwine2(storyData, story, diagnostics) {
 		switch (node.name) {
 			case "style":
 			case "script": {
-				const text = getTextContent(node).trim();
-				if (text.length === 0) continue;
+				const content = getTextContent(node);
+				if (content.trim().length === 0) continue;
+				const text = passageText(content);
 				storyAdd(story, {
 					name: node.name === "style" ? "Story Stylesheet" : "Story JavaScript",
 					tags: node.name === "style" ? ["stylesheet"] : ["script"],
@@ -4515,7 +4518,7 @@ function decompileTwine2(storyData, story, diagnostics) {
 				const passage = {
 					name,
 					tags,
-					text: getTextContent(node).trim()
+					text: passageText(getTextContent(node))
 				};
 				if (metadata.position || metadata.size) passage.metadata = metadata;
 				storyAdd(story, passage, diagnostics);
@@ -4529,8 +4532,8 @@ function decompileTwine2(storyData, story, diagnostics) {
 		text: marshalStoryData(story)
 	}, diagnostics);
 }
-function decompileTwine1(storeArea, story, diagnostics) {
-	const passages = (storeArea.children ?? []).filter(isTiddler).map(tiddlerToPassage);
+function decompileTwine1(storeArea, story, passageText, diagnostics) {
+	const passages = (storeArea.children ?? []).filter(isTiddler).map((node) => tiddlerToPassage(node, passageText));
 	const obfuscated = isRot13Obfuscated(passages);
 	for (const p of passages) storyAdd(story, obfuscated && p.name !== "StorySettings" ? {
 		...p,
@@ -4540,12 +4543,12 @@ function decompileTwine1(storeArea, story, diagnostics) {
 function isTiddler(node) {
 	return node.type === "tag" && node.name === "div" && node.attribs !== void 0 && "tiddler" in node.attribs;
 }
-function tiddlerToPassage(node) {
+function tiddlerToPassage(node, passageText) {
 	const nodeAttrs = node.attribs ?? {};
 	const passage = {
 		name: nodeAttrs["tiddler"] ?? "",
 		tags: nodeAttrs["tags"] ? nodeAttrs["tags"].split(/\s+/).filter((s) => s.length > 0) : [],
-		text: tiddlerUnescape(getTextContent(node)).trim()
+		text: passageText(tiddlerUnescape(getTextContent(node)))
 	};
 	const position = nodeAttrs["twine-position"];
 	if (position) passage.metadata = { position };
@@ -4610,7 +4613,7 @@ function loadSources(story, filenames, opts, diagnostics, processedFiles) {
 					break;
 				case "htm":
 				case "html":
-					loadHTML(story, filename, diagnostics);
+					loadHTML(story, filename, opts, diagnostics);
 					break;
 				case "css":
 					loadTagged(story, "stylesheet", filename, diagnostics);
@@ -4764,8 +4767,8 @@ function parseFontFile(filename) {
 		diagnostics: []
 	};
 }
-function parseHTMLFile(filename) {
-	const { story, diagnostics } = decompileHTML(readUTF8(filename));
+function parseHTMLFile(filename, opts) {
+	const { story, diagnostics } = decompileHTML(readUTF8(filename), { trim: opts.trim ?? true });
 	return {
 		passages: story.name !== "" && !storyHas(story, "StoryTitle") ? [{
 			name: "StoryTitle",
@@ -4777,14 +4780,17 @@ function parseHTMLFile(filename) {
 }
 /**
 * Identity of the options that affect how a file parses, stored on its cache entry.
-* Only Twee files depend on them; every other file type yields the same key for all options.
+* Twee files depend on `trim` and `twee2Compat`, HTML files on `trim`; every other file type
+* yields the same key for all options.
 */
 function parseOptionsKey(filename, opts) {
 	const ext = normalizedFileExt(filename);
+	const trim = opts.trim ?? true;
+	if (ext === "htm" || ext === "html") return JSON.stringify({ trim });
 	const twee2File = ext === "tw2" || ext === "twee2";
 	if (!twee2File && ext !== "tw" && ext !== "twee") return "";
 	return JSON.stringify({
-		trim: opts.trim ?? true,
+		trim,
 		twee2Compat: twee2File || (opts.twee2Compat ?? false)
 	});
 }
@@ -4798,7 +4804,7 @@ function parseFile(filename, opts) {
 			twee2Compat: true
 		});
 		case "htm":
-		case "html": return parseHTMLFile(filename);
+		case "html": return parseHTMLFile(filename, opts);
 		case "css": return parseTaggedFile("stylesheet", filename);
 		case "js": return parseTaggedFile("script", filename);
 		case "otf":
@@ -4830,8 +4836,8 @@ function parseFile(filename, opts) {
 		default: return;
 	}
 }
-function loadHTML(story, filename, diagnostics) {
-	const result = parseHTMLFile(filename);
+function loadHTML(story, filename, opts, diagnostics) {
+	const result = parseHTMLFile(filename, opts);
 	diagnostics.push(...result.diagnostics);
 	for (const p of result.passages) storyAdd(story, p, diagnostics);
 }
@@ -4870,7 +4876,8 @@ function loadSourcesCached(story, filenames, opts, diagnostics, processedFiles,
 		const optionsKey = parseOptionsKey(filename, opts);
 		const entry = cache.get(filename);
 		const cached = entry?.parseOptionsKey === optionsKey ? entry : void 0;
-		if (changedFiles && cached && !changedFiles.has(filename)) {
+		const changed = changedFiles?.has(filename) ?? false;
+		if (changedFiles && cached && !changed) {
 			diagnostics.push(...cached.diagnostics);
 			for (const p of cached.passages) storyAdd(story, p, diagnostics);
 			processedFiles.add(filename);
@@ -4882,7 +4889,7 @@ function loadSourcesCached(story, filenames, opts, diagnostics, processedFiles,
 		} catch {
 			continue;
 		}
-		if (cached && cached.mtimeMs === mtimeMs) {
+		if (cached && !changed && cached.mtimeMs === mtimeMs) {
 			diagnostics.push(...cached.diagnostics);
 			for (const p of cached.passages) storyAdd(story, p, diagnostics);
 			processedFiles.add(filename);
@@ -5130,10 +5137,39 @@ function tryReplaceComponent(template, placeholder, componentPath, required) {
 }
 //#endregion
 //#region src/output-twee.ts
-function toTwee(story, outMode) {
-	let data = "";
-	for (const p of story.passages) data += passageToTwee(p, outMode);
-	return data;
+/**
+* Serialize the story as Twee. The StoryData passage is written from the story model rather than
+* from its loaded text, so changes made after loading (a start passage override, test mode) are kept.
+* Tweego writes the loaded text; its own normalization makes the two the same for an unchanged story.
+*
+* `addStoryData`: add a StoryData passage when the story has none, so that StoryData fields the
+* compile options set are recorded. Default: false.
+*/
+function toTwee(story, outMode, options = {}) {
+	return withEffectiveStoryData(story, options.addStoryData ?? false).map((p) => passageToTwee(p, outMode)).join("");
+}
+function withEffectiveStoryData(story, addStoryData) {
+	const storyData = {
+		name: "StoryData",
+		tags: [],
+		text: marshalStoryData(story)
+	};
+	const index = story.passages.findIndex((p) => p.name === "StoryData");
+	if (index !== -1) return story.passages.map((p, i) => i === index && isStoryDataJSON(p.text) ? {
+		...p,
+		text: storyData.text
+	} : p);
+	if (!addStoryData) return story.passages;
+	const at = story.passages[0]?.name === "StoryTitle" ? 1 : 0;
+	return [
+		...story.passages.slice(0, at),
+		storyData,
+		...story.passages.slice(at)
+	];
+}
+/** Whether the text loaded as StoryData. Text that did not is kept as written, for the author to fix. */
+function isStoryDataJSON(text) {
+	return unmarshalStoryData(createStory(), text) === null;
 }
 //#endregion
 //#region src/modules.ts
@@ -5205,7 +5241,19 @@ function modifyHead(html, modulePaths, headFile, diagnostics) {
 	return html;
 }
 //#endregion
-//#region src/start-passage.ts
+//#region src/passage-omission.ts
+/**
+* Why the `target` output leaves `passage` out of its passage elements, or `undefined` when it
+* emits the passage (and so a link or the start can name it).
+*/
+function passageOmission(story, passage, target) {
+	switch (target) {
+		case "twine2": return twine2PassageOmission(story, passage);
+		case "twine1": return twine1PassageOmission(passage);
+		default: throw new Error(`unhandled passage output target: ${String(target)}`);
+	}
+}
+/** Why a passage is left out, as a predicate: `Passage "X" ${describeOmission(o)}`. */
 function describeOmission(omission) {
 	switch (omission.kind) {
 		case "special-name": return `is the special "${omission.name}" passage`;
@@ -5214,13 +5262,8 @@ function describeOmission(omission) {
 		default: throw new Error(`unhandled passage omission: ${JSON.stringify(omission)}`);
 	}
 }
-function omissionFor(story, passage, target) {
-	switch (target) {
-		case "twine2": return twine2PassageOmission(story, passage);
-		case "twine1": return twine1PassageOmission(passage);
-		default: throw new Error(`unhandled start passage target: ${String(target)}`);
-	}
-}
+//#endregion
+//#region src/start-passage.ts
 /**
 * Check that `startName` names a passage the `target` output emits.
 * Returns the error diagnostics to report (empty when the start is usable).
@@ -5231,7 +5274,7 @@ function startPassageDiagnostics(story, startName, target) {
 		level: "error",
 		message: `Starting passage "${startName}" not found.`
 	}];
-	const omission = omissionFor(story, passage, target);
+	const omission = passageOmission(story, passage, target);
 	if (omission === void 0) return [];
 	return [{
 		level: "error",
@@ -5260,6 +5303,11 @@ async function compile(options) {
 /**
 * Compile with incremental caching support.
 * Plugins and advanced users can manage their own cache and changed-file tracking.
+*
+* Without `changedFiles`, a cached file is reused while its modification time is unchanged.
+* With it, a file it names (by the path source discovery gives it, relative to the working
+* directory) is always reparsed, whatever its modification time, and every other cached
+* file is reused as it is.
 */
 async function compileIncremental(options, cache, changedFiles) {
 	return buildOutput(options, cache, changedFiles);
@@ -5311,7 +5359,7 @@ async function buildOutput(options, cache, changedFiles, outFile) {
 	switch (outputMode) {
 		case "twee3":
 		case "twee1":
-			output = toTwee(story, outputMode);
+			output = toTwee(story, outputMode, { addStoryData: Boolean(options.startPassage) || testMode });
 			break;
 		case "twine2-archive":
 			output = toTwine2Archive(story, startName, { sourceInfo });
@@ -5411,6 +5459,35 @@ function storyToJSON(story) {
 	return JSON.stringify(obj, null, 2);
 }
 //#endregion
-export { isExcluded as a, getFilenames as i, compile as n, mediaTypeFromFilename as o, compileIncremental as r, TweeTsError as t };
+//#region src/plugins/diagnostics.ts
+function formatDiagnostic(d) {
+	return `${d.file ? `${d.file}${d.line ? `:${d.line}` : ""}: ` : ""}${d.file && d.line ? d.message.replace(/^line \d+: /, "") : d.message}`;
+}
+/** Returns the warnings; throws a LocatedError when the compile reported errors. */
+function splitDiagnostics(result) {
+	const errors = result.diagnostics.filter((d) => d.level === "error");
+	if (errors.length === 0) return result.diagnostics.filter((d) => d.level === "warning");
+	const error = new Error(errors.map(formatDiagnostic).join("\n"));
+	const [first] = errors;
+	if (first?.file) {
+		error.id = first.file;
+		error.loc = {
+			file: first.file,
+			line: first.line ?? 1,
+			column: 1
+		};
+	}
+	throw error;
+}
+/** An error thrown by the compiler or bundler, with a TweeTsError's error diagnostics folded into its message. */
+function fatalError(e) {
+	if (e instanceof TweeTsError) {
+		const errors = e.diagnostics.filter((d) => d.level === "error").map(formatDiagnostic);
+		return new Error([...errors, e.message].join("\n"));
+	}
+	return e instanceof Error ? e : new Error(String(e));
+}
+//#endregion
+export { compileIncremental as a, mediaTypeFromFilename as c, compile as i, formatDiagnostic as n, getFilenames as o, splitDiagnostics as r, isExcluded as s, fatalError as t };
 
-//# sourceMappingURL=compiler-Bmpbelqj.js.map
+//# sourceMappingURL=diagnostics-DZNS7W41.js.map