@rohal12/twee-ts 1.6.0 → 1.7.0

package/dist/bin/twee-ts.js

@@ -151,6 +151,9 @@ function hasInfoTags(p) {
 function hasInfoName(p) {
   return INFO_PASSAGE_NAMES.has(p.name);
 }
+function isInfoPassage(p) {
+  return hasInfoName(p) || hasInfoTags(p);
+}
 function isStoryPassage(p) {
   return !hasInfoName(p) && !hasInfoTags(p);
 }
@@ -2272,6 +2275,171 @@ function storyToJSON(story) {
   return JSON.stringify(obj, null, 2);
 }
 
+// src/inspect.ts
+function extractLinksFromText(text) {
+  const targets = /* @__PURE__ */ new Set();
+  const wikiLinkRe = /\[\[([^\]]+)\]\]/g;
+  let m;
+  while ((m = wikiLinkRe.exec(text)) !== null) {
+    const content = m[1];
+    const arrowIdx = content.indexOf("->");
+    if (arrowIdx !== -1) {
+      targets.add(content.slice(arrowIdx + 2).trim());
+      continue;
+    }
+    const pipeIdx = content.indexOf("|");
+    if (pipeIdx !== -1) {
+      targets.add(content.slice(pipeIdx + 1).trim());
+      continue;
+    }
+    targets.add(content.trim());
+  }
+  const gotoRe = /<<goto\s+["']([^"']+)["']\s*>>/g;
+  while ((m = gotoRe.exec(text)) !== null) {
+    targets.add(m[1]);
+  }
+  const linkMacroRe = /<<link\s+["'][^"']*["']\s+["']([^"']+)["']\s*>>/g;
+  while ((m = linkMacroRe.exec(text)) !== null) {
+    targets.add(m[1]);
+  }
+  return [...targets];
+}
+function storyInspect(story) {
+  const allNames = new Set(story.passages.map((p) => p.name));
+  const passages = [];
+  const storyPassages = [];
+  const infoPassages = [];
+  const tagSet = /* @__PURE__ */ new Set();
+  const passagesByTag = /* @__PURE__ */ new Map();
+  const tagsByPassage = /* @__PURE__ */ new Map();
+  const links = /* @__PURE__ */ new Map();
+  for (const p of story.passages) {
+    passages.push(p.name);
+    if (isStoryPassage(p)) {
+      storyPassages.push(p.name);
+    }
+    if (isInfoPassage(p)) {
+      infoPassages.push(p.name);
+    }
+    tagsByPassage.set(p.name, [...p.tags]);
+    for (const tag of p.tags) {
+      tagSet.add(tag);
+      let list = passagesByTag.get(tag);
+      if (!list) {
+        list = [];
+        passagesByTag.set(tag, list);
+      }
+      list.push(p.name);
+    }
+    const targets = extractLinksFromText(p.text);
+    links.set(p.name, targets);
+  }
+  const brokenLinks = [];
+  for (const [from, targets] of links) {
+    for (const to of targets) {
+      if (!allNames.has(to)) {
+        brokenLinks.push({ from, to });
+      }
+    }
+  }
+  const deadEnds = [];
+  for (const name of storyPassages) {
+    const targets = links.get(name);
+    if (!targets || targets.length === 0) {
+      deadEnds.push(name);
+    }
+  }
+  const start = story.twine2.start || "Start";
+  const linkedTo = /* @__PURE__ */ new Set();
+  for (const targets of links.values()) {
+    for (const t of targets) {
+      linkedTo.add(t);
+    }
+  }
+  const orphans = [];
+  for (const name of storyPassages) {
+    if (name !== start && !linkedTo.has(name)) {
+      orphans.push(name);
+    }
+  }
+  return {
+    passages,
+    storyPassages,
+    infoPassages,
+    tags: [...tagSet].sort(),
+    passagesByTag,
+    tagsByPassage,
+    links,
+    brokenLinks,
+    deadEnds,
+    orphans,
+    start
+  };
+}
+
+// src/lint.ts
+async function lint(options) {
+  const result = await compile({ ...options, outputMode: "json" });
+  const map = storyInspect(result.story);
+  return {
+    diagnostics: result.diagnostics,
+    stats: result.stats,
+    formatName: result.story.twine2.format,
+    formatVersion: result.story.twine2.formatVersion,
+    start: map.start,
+    passages: map.passages.length,
+    storyPassages: map.storyPassages.length,
+    infoPassages: map.infoPassages.length,
+    brokenLinks: map.brokenLinks,
+    deadEnds: map.deadEnds,
+    orphans: map.orphans
+  };
+}
+function formatLintReport(result) {
+  const lines = [];
+  const formatStr = result.formatName ? `${result.formatName}${result.formatVersion ? " " + result.formatVersion : ""}` : "unknown";
+  lines.push(`Format: ${formatStr}`);
+  lines.push(
+    `Passages: ${result.passages} total (${result.storyPassages} story, ${result.infoPassages} info), ${result.stats.words.toLocaleString()} words, ${result.stats.files.length} files`
+  );
+  lines.push(`Start: ${result.start}`);
+  if (result.brokenLinks.length > 0) {
+    lines.push("");
+    lines.push(`Broken links (${result.brokenLinks.length}):`);
+    for (const link of result.brokenLinks) {
+      lines.push(`  ${link.from} -> ${link.to} (passage "${link.to}" does not exist)`);
+    }
+  }
+  if (result.deadEnds.length > 0) {
+    lines.push("");
+    lines.push(`Dead ends (${result.deadEnds.length}): ${result.deadEnds.join(", ")}`);
+  }
+  if (result.orphans.length > 0) {
+    lines.push("");
+    lines.push(`Orphans (${result.orphans.length}): ${result.orphans.join(", ")}`);
+  }
+  const errors = result.diagnostics.filter((d) => d.level === "error");
+  const warnings = result.diagnostics.filter((d) => d.level === "warning");
+  if (errors.length > 0 || warnings.length > 0) {
+    lines.push("");
+    lines.push(`Diagnostics: ${errors.length} error(s), ${warnings.length} warning(s)`);
+    for (const d of errors) {
+      lines.push(`  error: ${d.message}`);
+    }
+    for (const d of warnings) {
+      lines.push(`  warning: ${d.message}`);
+    }
+  }
+  lines.push("");
+  const hasErrors = errors.length > 0 || result.brokenLinks.length > 0;
+  if (hasErrors) {
+    lines.push("Lint failed.");
+  } else {
+    lines.push("Lint passed.");
+  }
+  return lines.join("\n");
+}
+
 // src/config.ts
 import { readFileSync as readFileSync4, existsSync as existsSync2 } from "fs";
 import { join as join5 } from "path";
@@ -2388,6 +2556,7 @@ var { values, positionals } = parseArgs({
     "archive-twine1": { type: "boolean" },
     "twee2-compat": { type: "boolean" },
     "no-trim": { type: "boolean" },
+    lint: { type: "boolean" },
     test: { type: "boolean", short: "t" },
     watch: { type: "boolean", short: "w" },
     "log-stats": { type: "boolean", short: "l" },
@@ -2456,6 +2625,27 @@ async function main() {
       tagAliases[pair.slice(0, eq)] = pair.slice(eq + 1);
     }
   }
+  if (values.lint) {
+    const lintResult = await lint({
+      sources,
+      formatId: values.format ?? config?.formatId,
+      startPassage: values.start ?? config?.startPassage,
+      formatPaths: config?.formatPaths,
+      modules: values.module ?? config?.modules,
+      headFile: values.head ?? config?.headFile,
+      trim: values["no-trim"] ? false : config?.trim ?? true,
+      twee2Compat: values["twee2-compat"] ?? config?.twee2Compat ?? false,
+      testMode: values.test ?? config?.testMode ?? false,
+      formatIndices: values["format-index"] ?? config?.formatIndices,
+      formatUrls: values["format-url"] ?? config?.formatUrls,
+      noRemote: values["no-remote"] ?? config?.noRemote ?? false,
+      tagAliases,
+      sourceInfo: values["source-info"] ?? config?.sourceInfo ?? false
+    });
+    console.log(formatLintReport(lintResult));
+    const hasErrors = lintResult.brokenLinks.length > 0 || lintResult.diagnostics.some((d) => d.level === "error");
+    process.exit(hasErrors ? 1 : 0);
+  }
   const compileOptions = {
     sources,
     outputMode,
@@ -2588,6 +2778,7 @@ Options:
   --archive-twine1          Output as Twine 1 archive
   --json                    Output as JSON
   --twee2-compat            Enable Twee2 syntax compatibility
+  --lint                    Lint story structure (broken links, dead ends, orphans)
   --no-trim                 Don't trim passage whitespace
   -t, --test                Enable test/debug mode
   -w, --watch               Watch for changes and rebuild