commonform-docx 5.5.2 → 7.0.0

package/README.md

@@ -18,7 +18,7 @@ It may contain:
 
 1. a `title` property whose value is a string
 
-2. an `edition` property whose value is a string
+2. an `version` property whose value is a string
 
 3. a `hash` property whose value is `true` or `false`
 

package/bin.js

@@ -1,52 +1,55 @@
 #!/usr/bin/env node
-var docopt = require('@kemitchell/docopt').docopt
-var fs = require('fs')
-var has = require('has')
-var path = require('path')
+const docopt = require('@kemitchell/docopt').docopt
+const fs = require('fs')
+const has = require('has')
+const path = require('path')
 
 // Parse arguments and options.
 
-var usage = [
+const usage = [
   'Usage:',
   '  commonform-docx [options] <FILE>',
   '',
   'Options:',
-  '  -h, --help                    Show this screen.',
-  '  -v, --version                 Show version.',
-  '  -H, --hash                    Render form hash',
-  '  -a, --a4-paper                A4 paper.',
-  '  -b TEXT, --blank-text TEXT    Render blanks with custom text.',
-  '  -d JSON --directions JSON     Use directions to fill in blanks',
-  '  -e EDITION, --edition EDITION Form edition to be rendered',
-  '  -i, --indent-margins          Indent margins, commonwealth style',
-  '  -l, --left-align-title        Align title flush to left margin',
-  '  -m, --mark-filled             Mark filled blanks',
-  '  -p, --smartify                Render Unicode punctuation',
-  '  -n STYLE, --number STYLE      Numbering style [default: decimal]',
-  '  -r --left-align-body          Left-align body paragraphs.',
-  '  -s PAGES, --signatures PAGES  Signature page data',
-  '  -t TITLE, --title TITLE       Render title as <h1>.',
-  '  -v JSON --values JSON         Use values to fill in blanks',
-  '  -y JSON, --styles JSON        Render with custom styles.'
+  '  -h, --help                          Show this screen.',
+  '  -v, --version                       Show version.',
+  '  -H, --hash                          Render form hash',
+  '  -a, --a4-paper                      A4 paper',
+  '  -b TEXT, --blank-text TEXT          Render blanks with custom text',
+  '  --component-style STYLE             Change component style [default: both]',
+  '  -d JSON --directions JSON           Use directions to fill in blanks',
+  '  -e VERSION, --form-version VERSION  Form version to be rendered',
+  '  -i, --indent-margins                Indent margins, commonwealth style',
+  '  --incorporate-component-text TEXT   Verb for component references [default: Incorporate]',
+  '  --quote-component-text TEXT         Text for introducing quoted components',
+  '  -l, --left-align-title              Align title flush to left margin',
+  '  -m, --mark-filled                   Mark filled blanks',
+  '  -p, --smart                         Render Unicode punctuation',
+  '  -n STYLE, --number STYLE            Numbering style [default: decimal]',
+  '  -r --left-align-body                Left-align body paragraphs.',
+  '  -s PAGES, --signatures PAGES        Signature page data',
+  '  -t TITLE, --title TITLE             Render title as <h1>',
+  '  -v JSON --values JSON               Use values to fill in blanks',
+  '  -y JSON, --styles JSON              Render with custom styles'
 ].join('\n')
 
-var parsed = docopt(usage, { version: require('./package.json').version })
+const parsed = docopt(usage, { version: require('./package.json').version })
 
 // Parse arguments and options.
 
-var form = readJSON(parsed['<FILE>'])
+const form = readJSON(parsed['<FILE>'])
 
-var values = parsed['--values'] ? readJSON(parsed['--values']) : {}
-var directions = parsed['--directions'] ? readJSON(parsed['--directions']) : []
-var blanks = require('commonform-prepare-blanks')(values, directions)
+const values = parsed['--values'] ? readJSON(parsed['--values']) : {}
+const directions = parsed['--directions'] ? readJSON(parsed['--directions']) : []
+const blanks = require('commonform-prepare-blanks')(values, directions)
 
-var options = {}
+const options = {}
 
 if (parsed['--title']) options.title = parsed['--title']
 
 if (parsed['--number']) {
-  var numberStyle = parsed['--number']
-  var supportedNumberingStyles = {
+  const numberStyle = parsed['--number']
+  const supportedNumberingStyles = {
     rse: 'resolutions-schedules-exhibits-numbering',
     ase: 'agreement-schedules-exhibits-numbering',
     pae: 'plan-addenda-exhibits-numbering',
@@ -55,18 +58,18 @@ if (parsed['--number']) {
   }
   if (!has(supportedNumberingStyles, numberStyle)) {
     process.stderr.write([
-      '"' + numberStyle + '" is not a valid numbering style.',
+      `"${numberStyle}" is not a valid numbering style.`,
       'Valid styles are ' +
-      Object.keys(supportedNumberingStyles).map(function (s) {
-        return '"' + s + '"'
-      }).join(', ') + '.'
+      Object.keys(supportedNumberingStyles)
+        .map(s => `"${s}"`)
+        .join(', ') + '.'
     ].join('\n') + '\n')
     process.exit(1)
   } else {
-    options.numbering = require(supportedNumberingStyles[numberStyle])
+    options.numberStyle = require(supportedNumberingStyles[numberStyle])
   }
 } else {
-  options.numbering = require('decimal-numbering')
+  options.numberStyle = require('decimal-numbering')
 }
 
 if (parsed['--signatures']) {
@@ -81,7 +84,7 @@ if (parsed['--styles']) {
 
 if (parsed['--title']) options.title = parsed['--title']
 
-if (parsed['--edition']) options.edition = parsed['--edition']
+if (parsed['--form-version']) options.version = parsed['--form-version']
 
 if (parsed['--hash']) options.hash = true
 
@@ -89,21 +92,25 @@ if (parsed['--a4-paper']) options.a4 = true
 
 options.indentMargins = parsed['--indent-margins']
 
-options.centerTitle = !parsed['--left-align-title']
+options.leftAlignTitle = parsed['--left-align-title']
 
 options.leftAlignBody = parsed['--left-align-body']
 
-options.smartify = !!parsed['--smartify']
+options.smart = !!parsed['--smart']
 
 if (parsed['--blank-text']) options.blanks = parsed['--blank-text']
 
 if (parsed['--mark-filled']) options.markFilled = true
 
+options.loadedComponentStyle = parsed['--component-style']
+if (parsed['--quote-component-text']) options.quoteComponentText = parsed['--quote-component-text']
+options.incorporateComponentText = parsed['--incorporate-component-text']
+
 function readJSON (file) {
   return JSON.parse(fs.readFileSync(path.resolve(file)))
 }
 
 // Render and print.
-var rendered = require('./')(form, blanks, options)
+const rendered = require('./')(form, blanks, options)
 
 rendered.generateNodeStream().pipe(process.stdout)

package/escape.js

@@ -1,12 +1,10 @@
-module.exports = function escape (string) {
-  var special = {
+module.exports = string => {
+  const special = {
     '&': /&/g,
     ''': /'/g,
     '>': />/g,
     '&lt;': /</g,
     '&quot;': /"/g
   }
-  return Object.keys(special).reduce(function (string, escaped) {
-    return string.replace(special[escaped], escaped)
-  }, string)
+  return Object.keys(special).reduce((string, escaped) => string.replace(special[escaped], escaped), string)
 }

package/index.js

@@ -1,9 +1,10 @@
-var JSZip = require('jszip')
-var assign = require('object-assign')
-var commonformHash = require('commonform-hash')
-var smartify = require('commonform-smartify')
+const JSZip = require('jszip')
+const commonformHash = require('commonform-hash')
+const decimalNumbering = require('decimal-numbering')
+const smartify = require('commonform-smartify')
 
-var doc = require('./templates/document')
+const doc = require('./templates/document')
+const docRels = require('./templates/document-relationships')
 
 function defaultStyles (smart) {
   return {
@@ -24,41 +25,67 @@ function defaultStyles (smart) {
   }
 }
 
-module.exports = function (form, values, options) {
-  var title = options.title
-  var edition = options.edition
-  var hash = options.hash ? commonformHash(form) : undefined
-  var centerTitle = options.centerTitle || false
-  var leftAlignBody = options.leftAlignBody || false
-  var numberStyle = options.numbering
-  var indentMargins = options.indentMargins || false
-  var a4Paper = options.a4 || false
-  var after = options.after || ''
-  var smart = options.smartify
-  var styles = options.styles
-    ? assign({}, defaultStyles(smart), options.styles)
+module.exports = (
+  form,
+  values = [],
+  {
+    a4 = false,
+    after = '',
+    blanks = { text: '[•]', highlight: 'yellow' },
+    hash = false,
+    incorporateComponentText = 'Incorporate',
+    indentMargins = false,
+    leftAlignBody = false,
+    leftAlignTitle = false,
+    loadedComponentStyle = 'inline',
+    markFilled = false,
+    numberStyle = decimalNumbering,
+    quoteComponentText = 'Quoting for convenience, with any conflicts resolved in favor of the standard:',
+    smart,
+    styles,
+    title,
+    version
+  }
+) => {
+  styles = styles
+    ? Object.assign({}, defaultStyles(smart), styles)
     : defaultStyles(smart)
-  var blanks = options.blanks === undefined
-    ? { text: '[•]', highlight: 'yellow' }
-    : typeof options.blanks === 'string'
-      ? { text: options.blanks }
-      : options.blanks
-  var markFilled = !!options.markFilled
-  var scaffold = require('./data/scaffold.json')
-  scaffold.word['document.xml'] = doc(
+  if (typeof blanks === 'string') blanks = { text: blanks }
+  hash = hash ? commonformHash(form) : undefined
+  const result = doc(
     smart ? smartify(form) : form,
-    values, title, edition, hash,
-    centerTitle, leftAlignBody, numberStyle, indentMargins, a4Paper, after, blanks, markFilled,
-    styles
+    values,
+    {
+      a4,
+      after,
+      blanks,
+      hash,
+      incorporateComponentText,
+      indentMargins,
+      leftAlignBody,
+      leftAlignTitle,
+      loadedComponentStyle,
+      markFilled,
+      numberStyle,
+      quoteComponentText,
+      smart,
+      styles,
+      title,
+      version
+    }
   )
-  var zip = new JSZip()
-  zipObject(zip, scaffold)
+  const scaffold = require('./data/scaffold.json')
+  const clone = Object.assign({}, scaffold)
+  clone.word['document.xml'] = result.xml
+  clone.word._rels['document.xml.rels'] = docRels(result.hrefs)
+  const zip = new JSZip()
+  zipObject(zip, clone)
   return zip
 }
 
 function zipObject (zip, object) {
-  Object.keys(object).forEach(function (path) {
-    var content = object[path]
+  Object.keys(object).forEach(path => {
+    const content = object[path]
     // File
     if (typeof content === 'string') {
       zip.file(path, content.trim())

package/lint.log

@@ -0,0 +1,4 @@
+
+> commonform-docx@6.0.0 lint
+> standard
+

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "commonform-docx",
   "description": "render Common Forms in Office Open XML (Microsoft Word .docx format)",
-  "version": "5.5.2",
+  "version": "7.0.0",
   "author": "Kyle E. Mitchell <kyle@kemitchell.com> (http://kemitchell.com)",
   "bin": "bin.js",
   "dependencies": {
     "@kemitchell/docopt": "^1.0.0",
     "agreement-schedules-exhibits-numbering": "^2.0.0",
-    "commonform-flatten": "^1.0.0",
+    "commonform-flatten": "^2.1.0",
     "commonform-hash": "^1.0.0",
     "commonform-prepare-blanks": "^1.0.1",
     "commonform-smartify": "^1.0.1",
     "decimal-numbering": "^3.0.2",
     "has": "^1.0.3",
     "jszip": "^3.2.1",
-    "object-assign": "^4.1.1",
+    "number-to-words-en": "^1.2.5",
     "ooxml-signature-pages": "^3.0.2",
     "outline-numbering": "^2.0.0",
     "plan-addenda-exhibits-numbering": "^3.0.0",
@@ -23,9 +23,9 @@
   "devDependencies": {
     "istanbul": "^0.4.0",
     "run-series": "^1.1.8",
-    "standard": "^14.0.2",
+    "standard": "^17.0.0",
     "tape": "^5.0.1",
-    "textract": "^2.4.0"
+    "textract": "^2.5.0"
   },
   "keywords": [
     "Microsoft Office",

package/templates/document-relationships.js

@@ -0,0 +1,15 @@
+const escape = require('../escape')
+
+module.exports = array => {
+  const scaffolded = require('../data/scaffold.json').word._rels['document.xml.rels']
+  if (array.length === 0) return scaffolded
+  const appended = []
+  for (let index = 0; index < array.length; index++) {
+    const assignment = array[index]
+    appended.push(`<Relationship Id="${assignment.rId}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" Target="${escape(assignment.url)}" TargetMode="External"/>`)
+  }
+  return scaffolded.replace(
+    '</Relationships>',
+    `${appended.join('')}</Relationships>`
+  )
+}

package/templates/document.js

@@ -1,9 +1,9 @@
-var flatten = require('commonform-flatten')
-var hashRun = require('./hash')
-var titleRun = require('./title')
-var paragraph = require('./paragraph')
+const flatten = require('commonform-flatten')
+const hashRun = require('./hash')
+const titleRun = require('./title')
+const paragraph = require('./paragraph')
 
-var DOCUMENT_XMLNS = (
+const DOCUMENT_XMLNS = (
 /* jscs:disable maximumLineLength */
 /* jshint ignore: start */
   'xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" ' +
@@ -27,7 +27,7 @@ var DOCUMENT_XMLNS = (
 )
 
 function section (a4) {
-  var returned = '<w:sectPr>'
+  let returned = '<w:sectPr>'
   if (a4) {
     returned += '<w:pgSz w:w="11907" w:h="16839"/>'
   } else {
@@ -40,28 +40,35 @@ function section (a4) {
   return returned
 }
 
-module.exports = function (
-  form, values, title, edition, hash,
-  centerTitle, leftAlignBody, numberStyle, indentMargins, a4Paper, after, blanks, markFilled, styles
-) {
-  var paragraphs = flatten(form, values)
-    .map(function (element) {
-      if (leftAlignBody) element.alignment = 'left'
-      return paragraph(
-        element, numberStyle, indentMargins, blanks, markFilled, styles
-      )
+module.exports = (form, values, options) => {
+  // Hyperlinks in documents must refer to Relationships by rId.
+  // Set up a running list of HREFs to turn into Relationships,
+  // then pass a helper function that assigns rIds to HREFs.
+  const hrefs = []
+  options.rIdForHREF = url => {
+    const rId = `rId${100 + (hrefs.length - 1)}`
+    hrefs.push({ rId, url })
+    return rId
+  }
+  const paragraphs = flatten(form, values)
+    .map(element => {
+      if (options.leftAlignBody) element.alignment = 'left'
+      return paragraph(element, options)
     })
     .join('')
-  return (
+  const { title, version, hash, after, a4 } = options
+  const xml = (
+    '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' +
     '<w:document ' + DOCUMENT_XMLNS + '>' +
       '<w:body>' +
-        (title ? titleRun(title, centerTitle, styles) : '') +
-        (edition ? titleRun(edition, centerTitle, styles) : '') +
-        (hash ? hashRun(hash, centerTitle, styles) : '') +
+        (title ? titleRun(title, options) : '') +
+        (version ? titleRun(version, options) : '') +
+        (hash ? hashRun(hash, options) : '') +
         paragraphs +
         after +
-        section(a4Paper) +
+        section(a4) +
       '</w:body>' +
     '</w:document>'
   )
+  return { xml, hrefs }
 }

package/templates/hash.js

@@ -1,10 +1,9 @@
-var paragraph = require('./paragraph')
+const paragraph = require('./paragraph')
 
-module.exports = function (string, center, styles) {
+module.exports = (string, options) => {
   return paragraph({
-    alignment: center ? 'center' : 'left',
-    depth: 1,
     title: true,
+    alignment: options.leftAlignTitle ? 'left' : 'center',
     content: [{ monospaced: string }]
-  }, null, null, null, null, styles)
+  }, options)
 }

package/templates/paragraph.js

@@ -1,11 +1,13 @@
-var has = require('has')
-var run = require('./run')
-var tag = require('./tag')
+const escape = require('../escape')
+const has = require('has')
+const numberToWords = require('number-to-words-en')
+const run = require('./run')
+const tag = require('./tag')
 
 // Half an inch in twentieths of a point
-var HALF_INCH = 720
+const HALF_INCH = 720
 
-var alignments = {
+const alignments = {
   left: 'start',
   right: 'end',
   center: 'center',
@@ -13,113 +15,169 @@ var alignments = {
   distribute: 'distribute'
 }
 
-var properties = function (o, number, indentMargins) {
-  // CAVEAT: The order of properties is important.
-  var depth = ('heading' in o || 'numbering' in o || 'title' in o)
+function properties (o, number, indentMargins) {
+  if (o.title) {
+    // Titles don't have margins or indentation.
+    return tag('w:pPr', `<w:jc w:val="${alignments[o.alignment]}" />`)
+  }
+  const depth = ('heading' in o || 'numbering' in o)
     ? o.depth
     : o.depth + 1
-  var alignment = o.alignment
+  // CAVEAT: The order of properties is important.
   return tag('w:pPr',
     '<w:ind' +
     (
       indentMargins
         ? (
-          number.length === 0
-            ? (' w:left="' + ((depth - 2) * HALF_INCH) + '"')
-            : (
-              ' w:left="' + ((depth - 1) * HALF_INCH) + '"' +
-              ' w:firstLine="-' + HALF_INCH + '"'
-            )
-        )
+            number.length === 0
+              ? (
+                  ' w:left="' + ((depth - 2) * HALF_INCH) + '"'
+                )
+              : (
+                  ' w:left="' + ((depth - 1) * HALF_INCH) + '"' +
+                  ' w:firstLine="-' + HALF_INCH + '"'
+                )
+          )
         : (' w:firstLine="' + ((depth - 1) * HALF_INCH) + '"')
     ) + ' />' +
-    '<w:jc w:val="' + alignments[alignment] + '" />'
+    '<w:jc w:val="' + alignments[o.alignment] + '" />'
   )
 }
 
-var TAB = '<w:r><w:tab/></w:r>'
+const TAB = '<w:r><w:tab/></w:r>'
 
-module.exports = function (
-  element, numberStyle, indentMargins, blanks, markFilled, styles
-) {
+module.exports = (element, options) => {
   if (!has(element, 'alignment')) {
-    element.alignment = styles.alignment || 'justify'
+    element.alignment = options.styles.alignment || 'justify'
   }
-  var number = has(element, 'numbering')
-    ? numberStyle(element.numbering, true)
+  const number = has(element, 'numbering')
+    ? options.numberStyle(element.numbering, true)
     : ''
-  var conspicuous = has(element, 'conspicuous')
-  return tag('w:p',
-    properties(element, number, indentMargins) +
-    (
-      number
-        ? makeRun(number, false) + TAB
-        : ''
-    ) + (
-      has(element, 'heading')
-        ? (
-          makeRun({ caption: element.heading }, conspicuous) +
-          (/\.$/.test(element.heading) ? '' : makeRun('.', false)) +
-          (element.content.length === 0 ? '' : makeRun(' ', false))
+  const conspicuous = has(element, 'conspicuous')
+  const hasComponent = has(element, 'component')
+  const hasContent = has(element, 'content')
+  let returned = '<w:p>'
+  returned += properties(element, number, options.indentMargins)
+  returned += number ? makeRun(number, false) + TAB : ''
+  if (has(element, 'heading')) {
+    returned += makeRun({ caption: element.heading }, conspicuous)
+    if (!/\.$/.test(element.heading)) {
+      returned += makeRun('.', false)
+    }
+    if ((hasComponent && !hasContent) || element.content.length === 0) {
+      // pass
+    } else {
+      returned += makeRun(' ', false)
+    }
+  }
+  if (hasComponent) {
+    if (hasContent) {
+      const style = options.loadedComponentStyle
+      if (style === 'both') {
+        returned += componentReference(element.reference, element.component)
+        returned += makeRun(' ' + options.quoteComponentText)
+        returned += '</w:p><w:p>'
+        returned += properties(
+          Object.assign({}, element, { depth: element.depth + 1 }),
+          number,
+          options.indentMargins
         )
-        : ''
-    ) +
-    (
-      has(element, 'repository') // component
-        ? componentToContent(element)
-          .map(function (element) {
-            return makeRun(element, conspicuous)
-          })
-          .join('')
-        : element.content
-          .map(function (element) {
-            return makeRun(element, conspicuous)
-          })
-          .join('')
-    )
-  )
+        returned += childContent({ content: element.content })
+      } else if (style === 'copy') {
+        returned += childContent({ content: element.content })
+      } else if (style === 'reference') {
+        returned += componentReference(element.reference, element.component)
+      } else {
+        throw new Error('Uknown Loaded Component Style: ' + style)
+      }
+    } else {
+      returned += componentReference(element)
+    }
+  } else {
+    returned += childContent(element)
+  }
+  returned += '</w:p>'
+  return returned
+
+  function childContent (element) {
+    const conspicuous = has(element, 'conspicuous')
+    return element.content
+      .map(element => makeRun(element, conspicuous, options))
+      .join('')
+  }
+
   function makeRun (element, conspicuous) {
-    return run(element, numberStyle, conspicuous, blanks, markFilled, styles)
+    return run(element, conspicuous, options)
   }
-}
 
-function componentToContent (component) {
-  var url = 'https://' + [
-    component.repository,
-    component.publisher,
-    component.project,
-    component.edition
-  ].map(encodeURIComponent).join('/')
-  var returned = []
-  var substitutions = component.substitutions
-  var hasSubstitutions = (
-    Object.keys(substitutions.terms).length > 0 ||
-    Object.keys(substitutions.headings).length > 0
-  )
-  var firstString = url
-  if (hasSubstitutions) {
-    if (component.upgrade) firstString += ' with updates and corrections, replacing '
-    else firstString += ' replacing '
-    returned.push(firstString)
-    var substitutionContent = []
-    Object.keys(substitutions.terms).forEach(function (from) {
-      var to = substitutions.terms[from]
-      substitutionContent.push(from + ' with ', { use: to })
-    })
-    Object.keys(substitutions.headings).forEach(function (from) {
-      var to = substitutions.headings[from]
-      substitutionContent.push(from + ' with ', { referene: to })
-    })
-    var length = substitutionContent.length
-    for (var index = 2; index < length - 1; index += 2) {
-      substitutionContent[index] = ', ' + substitutionContent[index]
+  function componentReference (component, meta) {
+    const href = component.component + '/' + component.version
+    const returned = [makeRun(options.incorporateComponentText + ' ')]
+    const rId = options.rIdForHREF(href)
+    const link = '<w:hyperlink r:id="' + rId + '" w:history="1"><w:r><w:rPr><w:color w:val="0000EE"/><w:u w:val="single"/></w:rPr><w:t>' + escape(href) + '</w:t></w:r></w:hyperlink>'
+    if (meta) {
+      returned.push(
+        makeRun(meta.publisher + ' ' + meta.name + ' Version ' + meta.version + ' ('),
+        link,
+        makeRun(')')
+      )
+    } else {
+      returned.push(link)
     }
-    substitutionContent.forEach(function (element) {
-      returned.push(element)
-    })
-  } else {
-    if (component.upgrade) firstString += ' with updates and corrections'
-    returned.push(firstString)
+    const substitutions = component.substitutions
+    const hasSubstitutions = (
+      Object.keys(substitutions.terms).length > 0 ||
+      Object.keys(substitutions.headings).length > 0
+    )
+    if (hasSubstitutions) {
+      returned.push(makeRun(' substituting '))
+      const phrases = []
+      Object.keys(substitutions.terms).forEach(from => {
+        const to = substitutions.terms[from]
+        phrases.push(
+          makeRun('the term ') +
+          makeRun({ use: to }) +
+          makeRun(' for the term ') +
+          makeRun({ use: from })
+        )
+      })
+      Object.keys(substitutions.headings).forEach(from => {
+        const to = substitutions.headings[from]
+        phrases.push(
+          makeRun('references to ') +
+          makeRun({ use: to }) +
+          makeRun(' for references to ') +
+          makeRun({ use: from })
+        )
+      })
+      Object.keys(substitutions.blanks).forEach(number => {
+        const value = substitutions.blanks[number]
+        phrases.push(
+          makeRun(quote(value)) +
+          makeRun(' for the ' + numberToWords.toWordsOrdinal(parseInt(number)) + ' blank')
+        )
+      })
+      const length = phrases.length
+      if (length === 1) {
+        returned.push(phrases[0])
+      } else if (length === 2) {
+        returned.push(phrases[0])
+        returned.push(makeRun(' and '))
+        returned.push(phrases[1])
+      } else {
+        returned.push(
+          phrases.slice(0, -1).join(makeRun(', ')) +
+          makeRun(', and ') +
+          phrases[phrases.length - 1]
+        )
+      }
+    }
+    returned.push(makeRun('.'))
+    return returned.join('')
+  }
+
+  function quote (string) {
+    if (options.smart) return '“' + string + '”'
+    else return '"' + string + '"'
   }
-  return returned
 }

package/templates/run.js

@@ -1,91 +1,83 @@
-var assign = require('object-assign')
-var escape = require('../escape')
-var has = require('has')
-var tag = require('./tag')
+const escape = require('../escape')
+const has = require('has')
+const tag = require('./tag')
 
-var defaults = {
+const defaults = {
   highlight: false,
   bold: false,
   italic: false,
   underline: false
 }
 
-module.exports = function run (
-  element, numberStyle, conspicuous, blanks, markFilled, styles
-) {
-  var properties = assign({}, defaults)
+module.exports = function run (element, conspicuous, options) {
+  const { styles } = options
+  const properties = Object.assign({}, defaults)
   if (conspicuous === true) {
-    assign(properties, styles.conspicuous)
+    Object.assign(properties, styles.conspicuous)
   }
-  var text = ''
+  let text = ''
   /* istanbul ignore else */
   if (typeof element === 'string') {
-    assign(properties, styles.text)
+    Object.assign(properties, styles.text)
     text = element
   } else if (has(element, 'caption')) {
-    assign(properties, styles.heading)
+    Object.assign(properties, styles.heading)
     text = element.caption
   } else if (has(element, 'title')) {
-    assign(properties, styles.title)
+    Object.assign(properties, styles.title)
     text = element.title
   } else if (has(element, 'monospaced')) {
-    assign(properties, styles.monospaced)
+    Object.assign(properties, styles.monospaced)
     text = element.monospaced
   } else if (has(element, 'definition')) {
-    var term = element.definition
+    const term = element.definition
     return (
       (
         styles.beforeDefinition
-          ? run(
-            styles.beforeDefinition, numberStyle, conspicuous, blanks,
-            markFilled, styles
-          )
+          ? run(styles.beforeDefinition, conspicuous, options)
           : ''
       ) +
       tag('w:r', runProperties(styles.definition) + runText(term)) +
       (
         styles.afterDefinition
-          ? run(
-            styles.afterDefinition, numberStyle, conspicuous, blanks,
-            markFilled, styles
-          )
+          ? run(styles.afterDefinition, conspicuous, options)
           : ''
       )
     )
   } else if (has(element, 'blank')) {
-    assign(properties, styles.text)
+    Object.assign(properties, styles.text)
     if (element.blank !== undefined) {
       text = element.blank
-      if (markFilled) assign(properties, styles.filled)
+      if (options.markFilled) Object.assign(properties, styles.filled)
     } else {
-      text = blanks.text
-      if (blanks.highlight) assign(properties, styles.highlighted)
+      text = options.blanks.text
+      if (options.blanks.highlight) Object.assign(properties, styles.highlighted)
     }
   } else if (has(element, 'use')) {
-    assign(properties, styles.use)
+    Object.assign(properties, styles.use)
     text = element.use
   } else if (has(element, 'heading')) {
-    var numbering = element.numbering
-    var heading = element.heading
+    const numbering = element.numbering
+    const heading = element.heading
     if (
       has(element, 'broken') ||
       has(element, 'ambiguous')
     ) {
-      assign(properties, styles.broken)
+      Object.assign(properties, styles.broken)
       text = '[Broken Cross-Reference to "' + heading + '"]'
     } else {
-      text = numberStyle(numbering)
+      text = options.numberStyle(numbering)
       return (
         // Underlined reference.
         tag(
           'w:r',
-          runProperties(assign({}, properties, styles.reference)) +
+          runProperties(Object.assign({}, properties, styles.reference)) +
           runText(text)
         ) +
         // Name of referenced section in parentheses.
         tag(
           'w:r',
-          runProperties(assign({}, properties, styles.referenceHeading)) +
+          runProperties(Object.assign({}, properties, styles.referenceHeading)) +
           runText(' (' + heading + ')')
         )
       )
@@ -98,36 +90,36 @@ module.exports = function run (
 
 function underlineFlag (underline) {
   if (typeof underline === 'string') {
-    return '<w:u w:val="' + underline + '"/>'
+    return `<w:u w:val="${underline}"/>`
   } else {
     return '<w:u w:val="none"/>'
   }
 }
 
 function highlightFlag (highlight) {
-  return '<w:highlight w:val="' + highlight + '"/>'
+  return `<w:highlight w:val="${highlight}"/>`
 }
 
 function flag (name, value) {
-  return value ? '<w:' + name + '/>' : ''
+  return value ? `<w:${name}/>` : ''
 }
 
-function runProperties (options) {
+function runProperties (style) {
   return tag('w:rPr',
     (
-      flag('b', options.bold || false) +
-      flag('i', options.italic || false) +
-      (options.highlight ? highlightFlag(options.highlight) : '') +
-      underlineFlag(options.underline || false) +
+      flag('b', style.bold || false) +
+      flag('i', style.italic || false) +
+      (style.highlight ? highlightFlag(style.highlight) : '') +
+      underlineFlag(style.underline || false) +
       (
-        options.monospaced
+        style.monospaced
           ? (
-            '<w:rFonts ' +
-            'w:ascii="Courier New" ' +
-            'w:hAnsi="Courier New" ' +
-            'w:cs="Courier New"/>' +
-            '<w:sz w:val="20"/>'
-          )
+              '<w:rFonts ' +
+              'w:ascii="Courier New" ' +
+              'w:hAnsi="Courier New" ' +
+              'w:cs="Courier New"/>' +
+              '<w:sz w:val="20"/>'
+            )
           : ''
       )
     )
@@ -135,5 +127,5 @@ function runProperties (options) {
 }
 
 function runText (text) {
-  return '<w:t xml:space="preserve">' + escape(text) + '</w:t>'
+  return `<w:t xml:space="preserve">${escape(text)}</w:t>`
 }

package/templates/tag.js

@@ -1,3 +1,3 @@
-module.exports = function (name, content) {
-  return '<' + name + '>' + content + '</' + name + '>'
+module.exports = (name, content) => {
+  return `<${name}>${content}</${name}>`
 }

package/templates/title.js

@@ -1,12 +1,11 @@
-var paragraph = require('./paragraph')
+const paragraph = require('./paragraph')
 
-module.exports = function (string, center, styles) {
-  var argument = {
-    alignment: 'left',
-    depth: 1,
+module.exports = (string, options) => {
+  const argument = {
     title: true,
+    alignment: 'center',
     content: [{ title: string }]
   }
-  if (center) argument.alignment = 'center'
-  return paragraph(argument, null, null, null, null, styles)
+  if (options.leftAlignTitle) argument.alignment = 'left'
+  return paragraph(argument, options)
 }

package/test.log

@@ -1,13 +1,13 @@
 
-> commonform-docx@5.5.1 pretest
+> commonform-docx@6.0.0 pretest
 > npm run prepublish
 
 
-> commonform-docx@5.5.1 prepublish
+> commonform-docx@6.0.0 prepublish
 > node build/scaffold.js data/scaffold.docx > data/scaffold.json
 
 
-> commonform-docx@5.5.1 test
+> commonform-docx@6.0.0 test
 > tape test.js
 
 TAP version 13
@@ -27,69 +27,72 @@ ok 9 term appears in output
 ok 10 no render error
 ok 11 no textract error
 ok 12 reference appears in output
-# omits period after heading ending w/ period
+# handles components without headings
 ok 13 no render error
-ok 14 no textract error
-ok 15 double period does not appear in output
+# handles components with substitutions
+ok 14 no render error
+# omits period after heading ending w/ period
+ok 15 no render error
+ok 16 no textract error
+ok 17 double period does not appear in output
 # adds space between heading and defined term
-ok 16 no render error
- 1 of 1 1. Heading. "Term" 
-ok 17 no textract error
-ok 18 space between heading and term
+ok 18 no render error
+ok 19 no textract error
+ok 20 space between heading and term
 # adds space between heading and text
-ok 19 no render error
-ok 20 no textract error
-ok 21 space between heading and text
+ok 21 no render error
+ok 22 no textract error
+ok 23 space between heading and text
 # renders broken references
-ok 22 no render error
-ok 23 no textract error
-ok 24 reference appears in output
+ok 24 no render error
+ok 25 no textract error
+ok 26 reference appears in output
 # fills blanks
-ok 25 no render error
-ok 26 no textract error
-ok 27 value appears in output
+ok 27 no render error
+ok 28 no textract error
+ok 29 value appears in output
 # custom blank text
-ok 28 no render error
-ok 29 no textract error
-ok 30 value appears in output
+ok 30 no render error
+ok 31 no textract error
+ok 32 value appears in output
 # renders empty blank placeholders
-ok 31 no render error
-ok 32 no textract error
-ok 33 placeholder appears in output
+ok 33 no render error
+ok 34 no textract error
+ok 35 placeholder appears in output
 # renders custom empty blank placeholders
-ok 34 no render error
-ok 35 no textract error
-ok 36 placeholder appears in output
+ok 36 no render error
+ok 37 no textract error
+ok 38 placeholder appears in output
 # renders custom empty blank placeholders
-ok 37 no render error
-ok 38 no textract error
-ok 39 placeholder appears in output
+ok 39 no render error
+ok 40 no textract error
+ok 41 placeholder appears in output
 # renders conspicuous text
-ok 40 no render error
-ok 41 no textract error
-ok 42 conspicuous text appears in output
+ok 42 no render error
+ok 43 no textract error
+ok 44 conspicuous text appears in output
 # renders titles
-ok 43 no render error
-ok 44 no textract error
-ok 45 title appears in output
+ok 45 no render error
+ok 46 no textract error
+ok 47 title appears in output
 # renders centered titles
-ok 46 no render error
-ok 47 no textract error
-ok 48 title appears in output
-# renders editions
-ok 49 no render error
-ok 50 no textract error
-ok 51 edition appears in output
+ok 48 no render error
+ok 49 no textract error
+ok 50 title appears in output
+# renders versions
+ok 51 no render error
+ok 52 no textract error
+ok 53 version appears in output
 # renders hashes
-ok 52 no render error
-ok 53 no textract error
-ok 54 hash symbol appears in output
+ok 54 no render error
+ok 55 no textract error
+ok 56 hash symbol appears in output
 # throws for invalid content
-ok 55 throw an error
+ok 57 throw an error
 
-1..55
-# tests 55
-# pass  55
+1..57
+# tests 57
+# pass  57
 
 # ok