@rohal12/twee-ts 1.9.0 → 1.11.0

package/dist/index.d.cts

@@ -2,6 +2,7 @@
  * All public interfaces for twee-ts.
  */
 type OutputMode = 'html' | 'twee3' | 'twee1' | 'twine2-archive' | 'twine1-archive' | 'json';
+type WordCountMethod = 'tweego' | 'whitespace';
 type InlineSource = {
     filename: string;
     content: string | Buffer;
@@ -40,6 +41,8 @@ interface CompileOptions {
     tagAliases?: Record<string, string>;
     /** Emit source file and line as data- attributes on passage elements. Default: false. */
     sourceInfo?: boolean;
+    /** Word counting method. Default: 'tweego'. */
+    wordCountMethod?: WordCountMethod;
 }
 interface CompileToFileOptions extends CompileOptions {
     /** Output file path. */
@@ -184,6 +187,7 @@ interface TweeTsConfig {
     noRemote?: boolean;
     tagAliases?: Record<string, string>;
     sourceInfo?: boolean;
+    wordCountMethod?: WordCountMethod;
 }
 
 declare class TweeTsError extends Error {
@@ -438,4 +442,4 @@ declare function getCacheSize(): {
     count: number;
 };
 
-export { type BrokenLink, CONFIG_FILENAME, type CachedFormatEntry, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type FileCacheEntry, type InlineSource, ItemType, type LexerItem, type LintResult, 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, clearCachedFormats, compile, compileIncremental, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, formatLintReport, generateIFID, getCacheDir, getCacheSize, getFormatSearchDirs, lint, listCachedFormats, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };
+export { type BrokenLink, CONFIG_FILENAME, type CachedFormatEntry, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type FileCacheEntry, type InlineSource, ItemType, type LexerItem, type LintResult, 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, type WordCountMethod, applyTagAliases, clearCachedFormats, compile, compileIncremental, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, formatLintReport, generateIFID, getCacheDir, getCacheSize, getFormatSearchDirs, lint, listCachedFormats, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };

package/dist/index.d.ts

@@ -2,6 +2,7 @@
  * All public interfaces for twee-ts.
  */
 type OutputMode = 'html' | 'twee3' | 'twee1' | 'twine2-archive' | 'twine1-archive' | 'json';
+type WordCountMethod = 'tweego' | 'whitespace';
 type InlineSource = {
     filename: string;
     content: string | Buffer;
@@ -40,6 +41,8 @@ interface CompileOptions {
     tagAliases?: Record<string, string>;
     /** Emit source file and line as data- attributes on passage elements. Default: false. */
     sourceInfo?: boolean;
+    /** Word counting method. Default: 'tweego'. */
+    wordCountMethod?: WordCountMethod;
 }
 interface CompileToFileOptions extends CompileOptions {
     /** Output file path. */
@@ -184,6 +187,7 @@ interface TweeTsConfig {
     noRemote?: boolean;
     tagAliases?: Record<string, string>;
     sourceInfo?: boolean;
+    wordCountMethod?: WordCountMethod;
 }
 
 declare class TweeTsError extends Error {
@@ -438,4 +442,4 @@ declare function getCacheSize(): {
     count: number;
 };
 
-export { type BrokenLink, CONFIG_FILENAME, type CachedFormatEntry, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type FileCacheEntry, type InlineSource, ItemType, type LexerItem, type LintResult, 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, clearCachedFormats, compile, compileIncremental, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, formatLintReport, generateIFID, getCacheDir, getCacheSize, getFormatSearchDirs, lint, listCachedFormats, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };
+export { type BrokenLink, CONFIG_FILENAME, type CachedFormatEntry, type CompileOptions, type CompileResult, type CompileStats, type CompileToFileOptions, type Diagnostic, type FileCacheEntry, type InlineSource, ItemType, type LexerItem, type LintResult, 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, type WordCountMethod, applyTagAliases, clearCachedFormats, compile, compileIncremental, compileToFile, discoverCachedFormats, discoverFormats, fetchAndCacheFormat, fetchDirectFormat, formatLintReport, generateIFID, getCacheDir, getCacheSize, getFormatSearchDirs, lint, listCachedFormats, loadConfig, loadConfigFile, parseFormatJSON, parseSemver, parseTwee, resolveRemoteFormat, scaffoldConfig, semverCompare, storyInspect, tweeLexer, validateConfig, validateIFID, watch };

package/dist/index.js

@@ -229,15 +229,32 @@ function passageToTiddler(p, pid, obfuscateRot13 = false) {
   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;
-  text = text.replace(/\n/g, "");
-  text = text.replace(/(?:\/%.+?%\/|\/\*.+?\*\/|<!--.+?-->)/gs, "");
-  const normalized = text.normalize("NFKD");
-  const count = [...normalized].length;
-  if (count === 0) return 0;
-  const words = Math.floor(count / 5);
-  return count % 5 > 0 ? words + 1 : words;
+function countWords(p, method = "tweego") {
+  switch (method) {
+    case "tweego": {
+      let text = p.text;
+      text = text.replace(/\n/g, "");
+      text = text.replace(/(?:\/%.+?%\/|\/\*.+?\*\/|<!--.+?-->)/gs, "");
+      const normalized = text.normalize("NFKD");
+      const count = [...normalized].length;
+      if (count === 0) return 0;
+      const words = Math.floor(count / 5);
+      return count % 5 > 0 ? words + 1 : words;
+    }
+    case "whitespace": {
+      let text = p.text;
+      text = text.replace(/(?:\/%.+?%\/|\/\*.+?\*\/|<!--.+?-->)/gs, "");
+      text = text.replace(/<<[^>]*>>/g, "");
+      text = text.replace(/\[\[([^\]|]*?)(?:\|[^\]]*?)?\]\]/g, "$1");
+      text = text.replace(/<[^>]+>/g, "");
+      const tokens = text.split(/\s+/).filter((t) => t.length > 0);
+      return tokens.length;
+    }
+    default: {
+      const _exhaustive = method;
+      throw new Error(`Unhandled word count method: ${_exhaustive}`);
+    }
+  }
 }
 function applyTagAliases(passages, aliases) {
   const entries = Object.entries(aliases);
@@ -455,13 +472,13 @@ function storyAdd(story, p, diagnostics) {
   }
   storyAppend(story, processed, diagnostics);
 }
-function getStoryStats(story) {
+function getStoryStats(story, wordCountMethod = "tweego") {
   let storyPassages = 0;
   let words = 0;
   for (const p of story.passages) {
     if (isStoryPassage(p)) {
       storyPassages++;
-      words += countWords(p);
+      words += countWords(p, wordCountMethod);
     }
   }
   return { passages: story.passages.length, storyPassages, words };
@@ -2305,7 +2322,7 @@ async function buildOutput(options, cache, changedFiles) {
     }
   }
   const stats = {
-    ...getStoryStats(story),
+    ...getStoryStats(story, options.wordCountMethod),
     files: [...processedFiles]
   };
   return { output, story, format, diagnostics, stats };
@@ -2526,6 +2543,7 @@ import { readFileSync as readFileSync4, existsSync as existsSync2 } from "fs";
 import { join as join5 } from "path";
 var CONFIG_FILENAME = "twee-ts.config.json";
 var VALID_OUTPUT_MODES = ["html", "twee3", "twee1", "twine2-archive", "twine1-archive", "json"];
+var VALID_WORD_COUNT_METHODS = ["tweego", "whitespace"];
 function loadConfig(dir) {
   const base = dir ?? process.cwd();
   const configPath = join5(base, CONFIG_FILENAME);
@@ -2612,10 +2630,16 @@ function validateConfig(data) {
       errors.push(`"outputMode" must be one of: ${VALID_OUTPUT_MODES.join(", ")}.`);
     }
   }
+  if ("wordCountMethod" in obj) {
+    if (typeof obj["wordCountMethod"] !== "string" || !VALID_WORD_COUNT_METHODS.includes(obj["wordCountMethod"])) {
+      errors.push(`"wordCountMethod" must be one of: ${VALID_WORD_COUNT_METHODS.join(", ")}.`);
+    }
+  }
   return errors;
 }
 function scaffoldConfig() {
   const config = {
+    $schema: "https://unpkg.com/@rohal12/twee-ts/schemas/twee-ts.config.schema.json",
     sources: ["src/"],
     output: "story.html"
   };