commonform-html/bin.js at main · commonform/commonform-html · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
import yargs from 'yargs'
import html from './index.js'
import prepareBlanks from 'commonform-prepare-blanks'
import { readFileSync } from 'node:fs'
import { normalize } from 'node:path'

export default function bin (stdin, stdout, stderr, argv, done) {
  const args = yargs()
    .scriptName('commonform-html')
    .option('html5', {
      describe: 'output HTML5',
      type: 'boolean'
    })
    .option('lists', {
      alias: 'l',
      describe: 'output lists',
      type: 'boolean'
    })
    .option('complete', {
      alias: 'c',
      describe: 'throw an error if a blank does not have a value',
      type: 'boolean'
    })
    .option('ids', {
      alias: 'i',
      describe: 'output headings with IDs',
      type: 'boolean'
    })
    .option('title', {
      alias: 't',
      describe: 'form title',
      type: 'string'
    })
    .option('form-version', {
      alias: 'e',
      describe: 'form version',
      type: 'string'
    })
    .option('values', {
      alias: 'v',
      describe: 'JSON file with blank values',
      coerce: readJSON,
      demandOption: false
    })
    .option('directions', {
      alias: 'd',
      describe: 'JSON file with directions',
      coerce: readJSON,
      demandOption: false
    })
    .implies('directions', 'values')
    .option('smartify', {
      describe: 'output Unicode punctuation',
      type: 'boolean'
    })
    .options('component-style', {
      describe: 'how to render components',
      default: 'both',
      choices: ['copy', 'reference', 'both']
    })
    .option('quote-component-text', {
      description: 'text before quoted component contents'
    })
    .option('incorporate-component-text', {
      description: 'text before component references',
      default: 'Incorporate'
    })
    .version()
    .help()
    .alias('h', 'help')
    .parse(argv)

  // Prepare fill-in-the-blank values.
  const blanks = (args.values && args.directions)
    ? prepareBlanks( args.values, args.directions)
    : []

  // Prepare rendering options.
  const options = {
    loadedComponentStyle: args['component-style']
  }
  if (args['form-version']) options.version = args['form-version']
  if (args.title) options.title = args.title
  if (args.html5) options.html5 = true
  if (args.lists) options.lists = true
  if (args.complete) options.complete = true
  if (args.ids) options.ids = true
  if (args.smartify) options.smartify = true
  if (args['quote-component-text']) options.quoteComponentText = args['quote-component-text']
  if (args['incorporate-component-text']) options.incorporateComponentText = args['incorporate-component-text']

  // Read the form to be rendered.
  const chunks = []
  stdin
    .on('data', function (chunk) {
      chunks.push(chunk)
    })
    .once('error', function (error) {
      return fail(error)
    })
    .once('end', function () {
      const buffer = Buffer.concat(chunks)
      let form
      try {
        form = JSON.parse(buffer)
      } catch (error) {
        return fail(error)
      }

      // Render.
      let rendered
      try {
        rendered = html(form, blanks, options)
      } catch (error) {
        return fail(error)
      }
      stdout.write(rendered + '\n')
      return done(0)
    })

  function fail (error) {
    stderr.write(error.toString() + '\n')
    done(1)
  }
}

function readJSON (file) {
  return JSON.parse(
    readFileSync(
      normalize(file)
    )
  )
}