commonform-docx 9.3.0 → 10.1.0

package/README.md

@@ -24,4 +24,6 @@ It may contain:
 
 4. a `markFilled` property whose value is `true` or `false`
 
+5. other properties you can find in function exported from `index.js`
+
 The function returns a [JSZip](https://npmjs.com/packages/jszip) Object primed with `.docx` document data.

package/bin.js

@@ -20,6 +20,8 @@ const usage = [
   '  --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',
+  '  --font NAME                         Default font family name',
+  '  --font-size POINTS                  Default font size in points',
   '  -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',
@@ -105,6 +107,9 @@ if (parsed['--blank-text']) options.blanks = parsed['--blank-text']
 
 if (parsed['--mark-filled']) options.markFilled = true
 
+if (parsed['--font']) options.font = parsed['--font']
+if (parsed['--font-size']) options.fontSize = parsed['--font-size']
+
 options.loadedComponentStyle = parsed['--component-style']
 if (parsed['--quote-component-text']) options.quoteComponentText = parsed['--quote-component-text']
 options.incorporateComponentText = parsed['--incorporate-component-text']

package/index.js

@@ -25,10 +25,8 @@ function defaultStyles (smart) {
   }
 }
 
-module.exports = (
-  form,
-  values = [],
-  {
+module.exports = (form, values = [], options = {}) => {
+  let {
     a4 = false,
     after = '',
     blanks = { text: '[•]', highlight: 'yellow' },
@@ -39,15 +37,21 @@ module.exports = (
     leftAlignTitle = false,
     loadedComponentStyle = 'inline',
     markFilled = false,
+    fontSize = 12,
+    font = 'Times New Roman',
     complete = false,
     numberStyle = decimalNumbering,
     quoteComponentText = 'Quoting for convenience, with any conflicts resolved in favor of the standard:',
     smart,
     styles,
     title,
-    version
+    version,
+    ...rest
+  } = options
+  const extraKeys = Object.keys(rest)
+  if (extraKeys.length !== 0) {
+    throw new Error(`Unsupported Options: ${extraKeys.join(', ')}`)
   }
-) => {
   styles = styles
     ? Object.assign({}, defaultStyles(smart), styles)
     : defaultStyles(smart)
@@ -80,6 +84,26 @@ module.exports = (
   const clone = Object.assign({}, scaffold)
   clone.word['document.xml'] = result.xml
   clone.word._rels['document.xml.rels'] = docRels(result.hrefs)
+  // Set default font size.  We need to replace <w:sz> and <w:szCs>
+  // elements both in <w:docDefaults> and in the default style.
+  const fontSizeInHalfPoints = Math.floor(fontSize * 2)
+  clone.word['styles.xml'] = clone.word['styles.xml']
+    .replaceAll(
+      /<w:sz w:val="[0-9]+"\/>/g,
+      `<w:sz w:val="${fontSizeInHalfPoints}"/>`
+    )
+    .replaceAll(
+      /<w:szCs w:val="[0-9]+"\/>/g,
+      `<w:szCs w:val="${fontSizeInHalfPoints}"/>`
+    )
+  // Set font family the same way.
+  if (font !== 'Times New Roman') {
+    clone.word['styles.xml'] = clone.word['styles.xml']
+      .replaceAll(
+        '<w:rFonts w:ascii="Times New Roman" w:hAnsi="Times New Roman"/>',
+        `<w:rFonts w:ascii="${font}" w:hAnsi="${font}"/>`
+      )
+  }
   const zip = new JSZip()
   zipObject(zip, clone)
   return zip

package/package.json

@@ -1,9 +1,18 @@
 {
   "name": "commonform-docx",
   "description": "render Common Forms in Office Open XML (Microsoft Word .docx format)",
-  "version": "9.3.0",
+  "version": "10.1.0",
   "author": "Kyle E. Mitchell <kyle@kemitchell.com> (http://kemitchell.com)",
   "bin": "bin.js",
+  "files": [
+    "bin.js",
+    "data/scaffold.json",
+    "escape.js",
+    "index.js",
+    "LICENSE.md",
+    "README.md",
+    "templates"
+  ],
   "dependencies": {
     "@kemitchell/docopt": "^1.0.0",
     "agreement-schedules-exhibits-numbering": "^3.0.0",

package/templates/paragraph.js

@@ -1,4 +1,3 @@
-const escape = require('../escape')
 const has = require('has')
 const hyperlink = require('./hyperlink')
 const numberToWords = require('number-to-words-en')

package/lint.log

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

package/test.log

@@ -1,98 +0,0 @@
-
-> commonform-docx@9.2.0 pretest
-> npm run prepublishOnly
-
-
-> commonform-docx@9.2.0 prepublishOnly
-> node build/scaffold.js data/scaffold.docx > data/scaffold.json
-
-
-> commonform-docx@9.2.0 test
-> tape test.js
-
-TAP version 13
-# renders text
-ok 1 no render error
-ok 2 no textract error
-ok 3 text appears in output
-# renders definitions
-ok 4 no render error
-ok 5 no textract error
-ok 6 defined term appears in output
-# renders uses
-ok 7 no render error
-ok 8 no textract error
-ok 9 term appears in output
-# renders references
-ok 10 no render error
-ok 11 no textract error
-ok 12 reference appears in output
-# handles components without headings
-ok 13 no render error
-# 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 18 no render error
-ok 19 no textract error
-ok 20 space between heading and term
-# adds 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 24 no render error
-ok 25 no textract error
-ok 26 reference appears in output
-# fills blanks
-ok 27 no render error
-ok 28 no textract error
-ok 29 value appears in output
-# custom blank text
-ok 30 no render error
-ok 31 no textract error
-ok 32 value appears in output
-# renders empty blank placeholders
-ok 33 no render error
-ok 34 no textract error
-ok 35 placeholder appears in output
-# renders custom empty blank placeholders
-ok 36 no render error
-ok 37 no textract error
-ok 38 placeholder appears in output
-# renders custom empty blank placeholders
-ok 39 no render error
-ok 40 no textract error
-ok 41 placeholder appears in output
-# renders conspicuous text
-ok 42 no render error
-ok 43 no textract error
-ok 44 conspicuous text appears in output
-# renders titles
-ok 45 no render error
-ok 46 no textract error
-ok 47 title appears in output
-# renders centered titles
-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 54 no render error
-ok 55 no textract error
-ok 56 hash symbol appears in output
-# throws for invalid content
-ok 57 throw an error
-
-1..57
-# tests 57
-# pass  57
-
-# ok
-