whatastory-mark-parser

whatastory-mark-parser

This is the parser component of wnatastory-mark. It takes a document (a string representation of a storyboard written in whatastory-mark) and outputs an object representation of that document.

Usage

const opts = {
  panelSeparator: /^==+/,
  subpanelSeparator: /^--+/,
  panelItemMatchers: {
    modifiers: /^\((.*)\)$/,
    sfx: /^<(.*)>$/,
    caption: /^\[(.*)\]$/,
    dialog: /^"(.*)"$/
  },
  allowedModifiers: [
    'frameless',
    'narrow',
    'wide',
    'tall',
    'short'
  ]
}

// configure the parser
const parser = require('whatastory-mark-parser')(opts)

// set up a template; you can use handlebars, pug or any of those
const rendererSource = require('./my-renderer.handlebars')
const render = Handlebars.compile(rendererSource)

// parse and feed the result to the template
const data = parser.parse(source)
const result = render(data)
console.log(result)

Options

• panelSeparator - Regular expression used for detecting panel delimiters.
• subpanelSeparator - Regular expression used for detecting subpanel delimiters.
• panelItemMatchers - Regular expressions used for detecting panel items.
• • modifiers - Regular expression used for detecting lists of modifiers.
• allowedModifiers - List of known modifiers. Unrecognized modifiers will be ignored.