@rohal12/twee-ts 1.6.0 → 1.7.0

package/dist/index.cjs

@@ -30,9 +30,11 @@ __export(src_exports, {
   discoverFormats: () => discoverFormats,
   fetchAndCacheFormat: () => fetchAndCacheFormat,
   fetchDirectFormat: () => fetchDirectFormat,
+  formatLintReport: () => formatLintReport,
   generateIFID: () => generateIFID,
   getCacheDir: () => getCacheDir,
   getFormatSearchDirs: () => getFormatSearchDirs,
+  lint: () => lint,
   loadConfig: () => loadConfig,
   loadConfigFile: () => loadConfigFile,
   parseFormatJSON: () => parseFormatJSON,
@@ -2437,6 +2439,69 @@ function storyInspect(story) {
   };
 }
 
+// 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
 var import_node_fs8 = require("fs");
 var import_node_path8 = require("path");
@@ -2549,9 +2614,11 @@ function scaffoldConfig() {
   discoverFormats,
   fetchAndCacheFormat,
   fetchDirectFormat,
+  formatLintReport,
   generateIFID,
   getCacheDir,
   getFormatSearchDirs,
+  lint,
   loadConfig,
   loadConfigFile,
   parseFormatJSON,