marlarky 1.0.1 → 1.0.2

package/dist/cli.js

@@ -23,150 +23,150 @@ function getVersion() {
     }
 }
 // ---------- Help text ----------
-const MAIN_HELP = `
-marlarky - Generate syntactically plausible English text
-
-Usage:
-  marlarky <command> [options]
-
-Commands:
-  sentence    Generate one or more sentences
-  paragraph   Generate one or more paragraphs
-  text        Generate a text block (multiple paragraphs)
-  validate    Validate a lexicon JSON file
-  list        List available transforms or sentence types
-
-Global Options:
-  -s, --seed <n>          RNG seed for deterministic output
-  -l, --lexicon <path>    Path to a lexicon JSON file
-  -a, --archetype <name>  Archetype to activate from the lexicon
-  -x, --transform <id>    Apply an output transform (repeatable, comma-separated)
-  -t, --trace             Output JSON trace to stderr
-  -j, --json              Output full result as JSON to stdout
-  -n, --count <n>         Number of units to generate (default: 1)
-  -h, --help              Show help
-  -v, --version           Show version
-
-Examples:
-  marlarky sentence
-  marlarky sentence --seed 42 --type question
-  marlarky paragraph --sentences 5 --lexicon ./corp.json
-  marlarky text --paragraphs 3 --archetype corporate
-  marlarky sentence --transform pigLatin
-  marlarky sentence --transform leet,uwu --json
-  marlarky validate ./my-lexicon.json
-  marlarky list transforms
+const MAIN_HELP = `
+marlarky - Generate syntactically plausible English text
+
+Usage:
+  marlarky <command> [options]
+
+Commands:
+  sentence    Generate one or more sentences
+  paragraph   Generate one or more paragraphs
+  text        Generate a text block (multiple paragraphs)
+  validate    Validate a lexicon JSON file
+  list        List available transforms or sentence types
+
+Global Options:
+  -s, --seed <n>          RNG seed for deterministic output
+  -l, --lexicon <path>    Path to a lexicon JSON file
+  -a, --archetype <name>  Archetype to activate from the lexicon
+  -x, --transform <id>    Apply an output transform (repeatable, comma-separated)
+  -t, --trace             Output JSON trace to stderr
+  -j, --json              Output full result as JSON to stdout
+  -n, --count <n>         Number of units to generate (default: 1)
+  -h, --help              Show help
+  -v, --version           Show version
+
+Examples:
+  marlarky sentence
+  marlarky sentence --seed 42 --type question
+  marlarky paragraph --sentences 5 --lexicon ./corp.json
+  marlarky text --paragraphs 3 --archetype corporate
+  marlarky sentence --transform pigLatin
+  marlarky sentence --transform leet,uwu --json
+  marlarky validate ./my-lexicon.json
+  marlarky list transforms
 `.trimStart();
-const SENTENCE_HELP = `
-marlarky sentence - Generate one or more sentences
-
-Usage:
-  marlarky sentence [options]
-
-Options:
-  --type <type>           Sentence type: simpleDeclarative, compound,
-                          introAdverbial, subordinate, interjection, question
-  --hints <tags>          Comma-separated hint tags (e.g. domain:tech,register:formal)
-  --min-words <n>         Minimum word count per sentence
-  --max-words <n>         Maximum word count per sentence
-  -x, --transform <id>   Apply an output transform (repeatable, comma-separated)
-  -s, --seed <n>          RNG seed for deterministic output
-  -l, --lexicon <path>    Path to a lexicon JSON file
-  -a, --archetype <name>  Archetype to activate from the lexicon
-  -t, --trace             Output JSON trace to stderr
-  -j, --json              Output full result as JSON to stdout
-  -n, --count <n>         Number of sentences to generate (default: 1)
-  -h, --help              Show this help
-
-Examples:
-  marlarky sentence
-  marlarky sentence --seed 42 --type question
-  marlarky sentence --count 5 --lexicon ./corp.json --archetype corporate
-  marlarky sentence --transform pigLatin --seed 42
-  marlarky sentence --min-words 10 --max-words 20
+const SENTENCE_HELP = `
+marlarky sentence - Generate one or more sentences
+
+Usage:
+  marlarky sentence [options]
+
+Options:
+  --type <type>           Sentence type: simpleDeclarative, compound,
+                          introAdverbial, subordinate, interjection, question
+  --hints <tags>          Comma-separated hint tags (e.g. domain:tech,register:formal)
+  --min-words <n>         Minimum word count per sentence
+  --max-words <n>         Maximum word count per sentence
+  -x, --transform <id>   Apply an output transform (repeatable, comma-separated)
+  -s, --seed <n>          RNG seed for deterministic output
+  -l, --lexicon <path>    Path to a lexicon JSON file
+  -a, --archetype <name>  Archetype to activate from the lexicon
+  -t, --trace             Output JSON trace to stderr
+  -j, --json              Output full result as JSON to stdout
+  -n, --count <n>         Number of sentences to generate (default: 1)
+  -h, --help              Show this help
+
+Examples:
+  marlarky sentence
+  marlarky sentence --seed 42 --type question
+  marlarky sentence --count 5 --lexicon ./corp.json --archetype corporate
+  marlarky sentence --transform pigLatin --seed 42
+  marlarky sentence --min-words 10 --max-words 20
 `.trimStart();
-const PARAGRAPH_HELP = `
-marlarky paragraph - Generate one or more paragraphs
-
-Usage:
-  marlarky paragraph [options]
-
-Options:
-  --sentences <n>         Exact number of sentences per paragraph
-  --min-sentences <n>     Minimum sentences per paragraph
-  --max-sentences <n>     Maximum sentences per paragraph
-  --hints <tags>          Comma-separated hint tags
-  -x, --transform <id>   Apply an output transform (repeatable, comma-separated)
-  -s, --seed <n>          RNG seed for deterministic output
-  -l, --lexicon <path>    Path to a lexicon JSON file
-  -a, --archetype <name>  Archetype to activate from the lexicon
-  -t, --trace             Output JSON trace to stderr
-  -j, --json              Output full result as JSON to stdout
-  -n, --count <n>         Number of paragraphs to generate (default: 1)
-  -h, --help              Show this help
-
-Examples:
-  marlarky paragraph --sentences 5 --seed 42
-  marlarky paragraph --count 3 --lexicon ./corp.json
-  marlarky paragraph --transform pirate
+const PARAGRAPH_HELP = `
+marlarky paragraph - Generate one or more paragraphs
+
+Usage:
+  marlarky paragraph [options]
+
+Options:
+  --sentences <n>         Exact number of sentences per paragraph
+  --min-sentences <n>     Minimum sentences per paragraph
+  --max-sentences <n>     Maximum sentences per paragraph
+  --hints <tags>          Comma-separated hint tags
+  -x, --transform <id>   Apply an output transform (repeatable, comma-separated)
+  -s, --seed <n>          RNG seed for deterministic output
+  -l, --lexicon <path>    Path to a lexicon JSON file
+  -a, --archetype <name>  Archetype to activate from the lexicon
+  -t, --trace             Output JSON trace to stderr
+  -j, --json              Output full result as JSON to stdout
+  -n, --count <n>         Number of paragraphs to generate (default: 1)
+  -h, --help              Show this help
+
+Examples:
+  marlarky paragraph --sentences 5 --seed 42
+  marlarky paragraph --count 3 --lexicon ./corp.json
+  marlarky paragraph --transform pirate
 `.trimStart();
-const TEXT_HELP = `
-marlarky text - Generate a text block (multiple paragraphs)
-
-Usage:
-  marlarky text [options]
-
-Options:
-  --paragraphs <n>        Exact number of paragraphs
-  --min-paragraphs <n>    Minimum paragraphs
-  --max-paragraphs <n>    Maximum paragraphs
-  --hints <tags>          Comma-separated hint tags
-  -x, --transform <id>   Apply an output transform (repeatable, comma-separated)
-  -s, --seed <n>          RNG seed for deterministic output
-  -l, --lexicon <path>    Path to a lexicon JSON file
-  -a, --archetype <name>  Archetype to activate from the lexicon
-  -t, --trace             Output JSON trace to stderr
-  -j, --json              Output full result as JSON to stdout
-  -n, --count <n>         Number of text blocks to generate (default: 1)
-  -h, --help              Show this help
-
-Examples:
-  marlarky text --paragraphs 3 --seed 42
-  marlarky text --lexicon ./corp.json --archetype corporate
-  marlarky text --transform bizJargon
+const TEXT_HELP = `
+marlarky text - Generate a text block (multiple paragraphs)
+
+Usage:
+  marlarky text [options]
+
+Options:
+  --paragraphs <n>        Exact number of paragraphs
+  --min-paragraphs <n>    Minimum paragraphs
+  --max-paragraphs <n>    Maximum paragraphs
+  --hints <tags>          Comma-separated hint tags
+  -x, --transform <id>   Apply an output transform (repeatable, comma-separated)
+  -s, --seed <n>          RNG seed for deterministic output
+  -l, --lexicon <path>    Path to a lexicon JSON file
+  -a, --archetype <name>  Archetype to activate from the lexicon
+  -t, --trace             Output JSON trace to stderr
+  -j, --json              Output full result as JSON to stdout
+  -n, --count <n>         Number of text blocks to generate (default: 1)
+  -h, --help              Show this help
+
+Examples:
+  marlarky text --paragraphs 3 --seed 42
+  marlarky text --lexicon ./corp.json --archetype corporate
+  marlarky text --transform bizJargon
 `.trimStart();
-const VALIDATE_HELP = `
-marlarky validate - Validate a lexicon JSON file
-
-Usage:
-  marlarky validate <file.json> [options]
-
-Options:
-  --json                  Output validation result as JSON
-  -h, --help              Show this help
-
-Examples:
-  marlarky validate ./my-lexicon.json
-  marlarky validate ./my-lexicon.json --json
+const VALIDATE_HELP = `
+marlarky validate - Validate a lexicon JSON file
+
+Usage:
+  marlarky validate <file.json> [options]
+
+Options:
+  --json                  Output validation result as JSON
+  -h, --help              Show this help
+
+Examples:
+  marlarky validate ./my-lexicon.json
+  marlarky validate ./my-lexicon.json --json
 `.trimStart();
-const LIST_HELP = `
-marlarky list - List available transforms or sentence types
-
-Usage:
-  marlarky list <category>
-
-Categories:
-  transforms              List all registered output transforms
-  types                   List all sentence types
-
-Options:
-  --json                  Output as JSON
-  -h, --help              Show this help
-
-Examples:
-  marlarky list transforms
-  marlarky list types
-  marlarky list transforms --json
+const LIST_HELP = `
+marlarky list - List available transforms or sentence types
+
+Usage:
+  marlarky list <category>
+
+Categories:
+  transforms              List all registered output transforms
+  types                   List all sentence types
+
+Options:
+  --json                  Output as JSON
+  -h, --help              Show this help
+
+Examples:
+  marlarky list transforms
+  marlarky list types
+  marlarky list transforms --json
 `.trimStart();
 // ---------- Constants ----------
 const GLOBAL_OPTIONS = {

package/examples/basic-usage.ts

@@ -1,48 +1,48 @@
-/**
- * Example A: Basic Usage (No Lexicon)
- * Demonstrates text generation using only the built-in word lists
- */
-
-import { TextGenerator, SimpleFakerAdapter } from '../src';
-
-// Create a generator with just the simple faker adapter
-const generator = new TextGenerator({
-  fakerAdapter: new SimpleFakerAdapter(),
-});
-
-// Set a seed for reproducible output
-generator.setSeed(42);
-
-console.log('=== Basic Text Generation (No Lexicon) ===\n');
-
-// Generate a single sentence
-console.log('Single sentence:');
-console.log(generator.sentence());
-console.log();
-
-// Generate different sentence types
-console.log('Different sentence types:');
-console.log('Simple declarative:', generator.sentence({ type: 'simpleDeclarative' }));
-console.log('Question:', generator.sentence({ type: 'question' }));
-console.log('Compound:', generator.sentence({ type: 'compound' }));
-console.log('With intro adverbial:', generator.sentence({ type: 'introAdverbial' }));
-console.log();
-
-// Generate a paragraph
-console.log('Paragraph (5 sentences):');
-console.log(generator.paragraph({ sentences: 5 }));
-console.log();
-
-// Generate multiple paragraphs
-console.log('Text block (2 paragraphs):');
-console.log(generator.textBlock({ paragraphs: 2 }));
-console.log();
-
-// Demonstrate determinism
-console.log('=== Determinism Test ===\n');
-generator.setSeed(12345);
-const text1 = generator.sentence();
-generator.setSeed(12345);
-const text2 = generator.sentence();
-console.log('Same seed produces same output:', text1 === text2);
-console.log('Output:', text1);
+/**
+ * Example A: Basic Usage (No Lexicon)
+ * Demonstrates text generation using only the built-in word lists
+ */
+
+import { TextGenerator, SimpleFakerAdapter } from '../src';
+
+// Create a generator with just the simple faker adapter
+const generator = new TextGenerator({
+  fakerAdapter: new SimpleFakerAdapter(),
+});
+
+// Set a seed for reproducible output
+generator.setSeed(42);
+
+console.log('=== Basic Text Generation (No Lexicon) ===\n');
+
+// Generate a single sentence
+console.log('Single sentence:');
+console.log(generator.sentence());
+console.log();
+
+// Generate different sentence types
+console.log('Different sentence types:');
+console.log('Simple declarative:', generator.sentence({ type: 'simpleDeclarative' }));
+console.log('Question:', generator.sentence({ type: 'question' }));
+console.log('Compound:', generator.sentence({ type: 'compound' }));
+console.log('With intro adverbial:', generator.sentence({ type: 'introAdverbial' }));
+console.log();
+
+// Generate a paragraph
+console.log('Paragraph (5 sentences):');
+console.log(generator.paragraph({ sentences: 5 }));
+console.log();
+
+// Generate multiple paragraphs
+console.log('Text block (2 paragraphs):');
+console.log(generator.textBlock({ paragraphs: 2 }));
+console.log();
+
+// Demonstrate determinism
+console.log('=== Determinism Test ===\n');
+generator.setSeed(12345);
+const text1 = generator.sentence();
+generator.setSeed(12345);
+const text2 = generator.sentence();
+console.log('Same seed produces same output:', text1 === text2);
+console.log('Output:', text1);

package/examples/corporate-lexicon.ts

@@ -1,71 +1,71 @@
-/**
- * Example B: Lexicon-Steered Corporate Text
- * Demonstrates text generation using a corporate lexicon
- */
-
-import { readFileSync } from 'fs';
-import { join, dirname } from 'path';
-import { fileURLToPath } from 'url';
-import { TextGenerator, SimpleFakerAdapter, loadLexiconFromString } from '../src';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-// Load the corporate lexicon
-const lexiconPath = join(__dirname, 'lexicons', 'corporate-min.json');
-const lexiconJson = readFileSync(lexiconPath, 'utf-8');
-const lexicon = loadLexiconFromString(lexiconJson);
-
-console.log('=== Lexicon-Steered Corporate Text ===\n');
-console.log(`Loaded lexicon: ${lexicon.id} v${lexicon.version}\n`);
-
-// Create generator with lexicon
-const generator = new TextGenerator({
-  fakerAdapter: new SimpleFakerAdapter(),
-  lexicon,
-});
-
-// Set archetype to "corporate"
-generator.setArchetype('corporate');
-generator.setSeed(42);
-
-// Generate corporate sentences
-console.log('Corporate sentences:');
-for (let i = 0; i < 5; i++) {
-  console.log(`${i + 1}. ${generator.sentence()}`);
-}
-console.log();
-
-// Generate a corporate paragraph
-console.log('Corporate paragraph:');
-console.log(generator.paragraph({ sentences: 4 }));
-console.log();
-
-// Generate corporate text block
-console.log('Corporate text block (3 paragraphs):');
-console.log(generator.textBlock({ paragraphs: 3 }));
-console.log();
-
-// Compare with non-lexicon output
-console.log('=== Comparison: With vs Without Lexicon ===\n');
-
-const withLexicon = new TextGenerator({
-  fakerAdapter: new SimpleFakerAdapter(),
-  lexicon,
-});
-withLexicon.setArchetype('corporate');
-withLexicon.setSeed(100);
-
-const withoutLexicon = new TextGenerator({
-  fakerAdapter: new SimpleFakerAdapter(),
-});
-withoutLexicon.setSeed(100);
-
-console.log('With corporate lexicon:');
-for (let i = 0; i < 3; i++) {
-  console.log(`  ${withLexicon.sentence()}`);
-}
-
-console.log('\nWithout lexicon (same seed):');
-for (let i = 0; i < 3; i++) {
-  console.log(`  ${withoutLexicon.sentence()}`);
-}
+/**
+ * Example B: Lexicon-Steered Corporate Text
+ * Demonstrates text generation using a corporate lexicon
+ */
+
+import { readFileSync } from 'fs';
+import { join, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { TextGenerator, SimpleFakerAdapter, loadLexiconFromString } from '../src';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+// Load the corporate lexicon
+const lexiconPath = join(__dirname, 'lexicons', 'corporate-min.json');
+const lexiconJson = readFileSync(lexiconPath, 'utf-8');
+const lexicon = loadLexiconFromString(lexiconJson);
+
+console.log('=== Lexicon-Steered Corporate Text ===\n');
+console.log(`Loaded lexicon: ${lexicon.id} v${lexicon.version}\n`);
+
+// Create generator with lexicon
+const generator = new TextGenerator({
+  fakerAdapter: new SimpleFakerAdapter(),
+  lexicon,
+});
+
+// Set archetype to "corporate"
+generator.setArchetype('corporate');
+generator.setSeed(42);
+
+// Generate corporate sentences
+console.log('Corporate sentences:');
+for (let i = 0; i < 5; i++) {
+  console.log(`${i + 1}. ${generator.sentence()}`);
+}
+console.log();
+
+// Generate a corporate paragraph
+console.log('Corporate paragraph:');
+console.log(generator.paragraph({ sentences: 4 }));
+console.log();
+
+// Generate corporate text block
+console.log('Corporate text block (3 paragraphs):');
+console.log(generator.textBlock({ paragraphs: 3 }));
+console.log();
+
+// Compare with non-lexicon output
+console.log('=== Comparison: With vs Without Lexicon ===\n');
+
+const withLexicon = new TextGenerator({
+  fakerAdapter: new SimpleFakerAdapter(),
+  lexicon,
+});
+withLexicon.setArchetype('corporate');
+withLexicon.setSeed(100);
+
+const withoutLexicon = new TextGenerator({
+  fakerAdapter: new SimpleFakerAdapter(),
+});
+withoutLexicon.setSeed(100);
+
+console.log('With corporate lexicon:');
+for (let i = 0; i < 3; i++) {
+  console.log(`  ${withLexicon.sentence()}`);
+}
+
+console.log('\nWithout lexicon (same seed):');
+for (let i = 0; i < 3; i++) {
+  console.log(`  ${withoutLexicon.sentence()}`);
+}