madlibs-template-parser v0.1.1

madlibs-template-parser

A minimal parser for Mad Libs templates

Features

The following types of English words are supported as blanks:

• Nouns
  • Singular (e.g. boy, country, bridge, city)
  • Plural (e.g. boys, countries, bridges, cities)
  • Proper (e.g. Steven, Africa, London, Monday)
  • Collective (e.g. family, government, audience, team, jury)
• Verbs
  • Root (e.g. go, do, show, eat)
  • Third person singular (e.g. watches, shrinks, does)
  • Present participle (e.g. coming, drawing, washing)
  • Simple past (e.g. sang, saw, fell, gave, went)
  • Past participle (e.g. sung, seen, fallen, given, gone)
• Adjectives
  • Descriptive: describes (pro)nouns (e.g. fast, hungry, flying)
  • Quantitative (e.g. twenty, three, whole)
  • Proper (e.g. American, Chinese, Marxist)
• Adverbs
  • Degree (e.g. almost, enough, just, hardly)
  • Frequency (e.g. always, never, seldom, normally)
  • Manner (e.g. beautifully, gorgeously, patiently)
  • Place (e.g. above, below, under, within)
  • Time (e.g. yesterday, tomorrow, monthly, daily, recently)

Usage

Pass in a piece of English text with certain words replaced with blanks of the appropriate type (delimited by < and >) to obtain a parse as an array, where each subarray denotes a paragraph and each object in each subarray denotes a word (roughly) or blank of a given type:

const mtp = require('madlibs-template-parser')

mtp("The   <descriptiveAdjective>  brown <singularNoun> <simplePastVerb> over the lazy <singularNoun> and shouted,\r\n\r\n\"That was easy!\"")

// Output:
/*
  [
    [
      { type: 'text', text: 'The' },
      { type: 'blank', category: 'adjective', variant: 'descriptive' },
      { type: 'text', text: 'brown' },
      { type: 'blank', category: 'noun', variant: 'singular' },
      { type: 'blank', category: 'verb', variant: 'simple past' },
      { type: 'text', text: 'over' },
      { type: 'text', text: 'the' },
      { type: 'text', text: 'lazy' },
      { type: 'blank', category: 'noun', variant: 'singular' },
      { type: 'text', text: 'and' },
      { type: 'text', text: 'shouted,' }
    ],
    [
      { type: 'text', text: '"That' },
      { type: 'text', text: 'was' },
      { type: 'text', text: 'easy!"' }
    ]
  ]
*/

Supported blanks are:

• <singularNoun>: Noun (singular)
• <pluralNoun>: Noun (plural)
• <properNoun>: Noun (proper)
• <collectiveNoun>: Noun (collective)
• <rootVerb>: Verb (root)
• <thirdPersonSingularVerb>: Verb (third person singular)
• <presentParticipleVerb>: Verb (present participle)
• <simplePastVerb>: Verb (simple past)
• <pastParticipleVerb>: Verb (past participle)
• <descriptiveAdjective>: Adjective (descriptive)
• <quantitativeAdjective>: Adjective (quantitative)
• <properAdjective>: Adjective (proper)
• <degreeAdverb>: Adverb (degree)
• <frequencyAdverb>: Adverb (frequency)
• <mannerAdverb>: Adverb (manner)
• <placeAdverb>: Adverb (place)
• <timeAdverb>: Adverb (time)

License

GPLv3 or any later version at your discretion