Add a commandline option for the **MUST** keyword.

README.md

@@ -114,6 +114,7 @@ There's also a version [published on npm](https://www.npmjs.com/package/wetzel).
 
 * The `-l` option specifies the starting header level.
 * The `-c` option lets you specify a custom symbol to place in front of required properties.
+* The `-k` option replaces the word `must` with a specified keyword, such as `**MUST**`.
 * The `-p` option lets you specify the relative path that should be used when referencing the schema, relative to where you store the documentation.
 * The `-s` option lets you specify the path string that should be used when loading the schema reference paths.
 * The `-e` option writes an additional output file that embeds the full text of JSON schemas (AsciiDoctor mode only).

bin/wetzel.js

@@ -12,11 +12,12 @@ if (!defined(argv._[0]) || defined(argv.h) || defined(argv.help)) {
     var help = 'Usage: node ' + path.basename(__filename) + ' [path-to-json-schema-file] [OPTIONS]\n' +
         '  -l,  --headerLevel        Top-level header. Default: 1\n' +
         '  -c,  --checkmark          Symbol for required properties. Default: ✓\n' +
+        '  -k,  --keyword            Use a particular keyword in place of "must", for example "**MUST**".\n' +
         '  -p,  --schemaPath         The path string that should be used when generating the schema reference paths.\n' +
         '  -s,  --searchPath         The path string that should be used when loading the schema reference paths.\n' +
         '  -e,  --embedOutput        The output path for a document that embeds JSON schemas directly (AsciiDoctor only).\n' +
-        '  -m,  --outputMode         The output mode, Markdown (the default) or AsciiDoctor (a).' +
-        '  -n,  --noTOC              Skip writing the Table of Contents.' +
+        '  -m,  --outputMode         The output mode, Markdown (the default) or AsciiDoctor (a).\n' +
+        '  -n,  --noTOC              Skip writing the Table of Contents.\n' +
         '  -a,  --autoLink           Aggressively auto-inter-link types referenced in descriptions.\n' +
         '                                Add =cqo to auto-link types that are in code-quotes only.\n' +
         '  -i                        An array of schema filenames (no paths) that should not get their own\n' +
@@ -73,6 +74,7 @@ var options = {
     writeTOC: !defaultValue(defaultValue(argv.n, argv.noTOC), false),
     headerLevel: defaultValue(defaultValue(argv.l, argv.headerLevel), 1),
     checkmark: defaultValue(defaultValue(argv.c, argv.checkmark), null),
+    mustKeyword: defaultValue(defaultValue(argv.k, argv.keyword), null),
     schemaRelativeBasePath: defaultValue(defaultValue(argv.p, argv.schemaPath), null),
     embedMode: enums.embedMode.none,
     debug: defaultValue(defaultValue(argv.d, argv.debug), null),

lib/generateMarkdown.js

@@ -30,6 +30,10 @@ function generateMarkdown(options) {
         style.setCheckmark(options.checkmark);
     }
 
+    if (defined(options.mustKeyword)) {
+        style.setMustKeyword(options.mustKeyword);
+    }
+
     // Verify JSON Schema version
     var schemaRef = schema.$schema;
     var resolved = null;
@@ -278,9 +282,11 @@ function createPropertiesDetails(schema, title, headerLevel, knownTypes, autoLin
 
             md += style.bulletItem(style.propertyDetails('Type') + ': ' + summary.formattedType, 0);
 
+            var eachElementInTheArrayMust = 'Each element in the array' + style.mustKeyword;
+
             var uniqueItems = property.uniqueItems;
             if (defined(uniqueItems) && uniqueItems) {
-                md += style.bulletItem('Each element in the array must be unique.', 1);
+                md += style.bulletItem(eachElementInTheArrayMust + 'be unique.', 1);
             }
 
             // TODO: items is a full schema
@@ -293,21 +299,21 @@ function createPropertiesDetails(schema, title, headerLevel, knownTypes, autoLin
                 var maxString = itemsExclusiveMaximum ? 'less than' : 'less than or equal to';
 
                 if (defined(items.minimum) && defined(items.maximum)) {
-                    md += style.bulletItem('Each element in the array must be ' + minString + ' ' +
+                    md += style.bulletItem(eachElementInTheArrayMust + 'be ' + minString + ' ' +
                         style.minMax(items.minimum) + ' and ' + maxString + ' ' + style.minMax(items.maximum) + '.', 1);
                 } else if (defined(items.minimum)) {
-                    md += style.bulletItem('Each element in the array must be ' + minString + ' ' + style.minMax(items.minimum) + '.', 1);
+                    md += style.bulletItem(eachElementInTheArrayMust + 'be ' + minString + ' ' + style.minMax(items.minimum) + '.', 1);
                 } else if (defined(items.maximum)) {
-                    md += style.bulletItem('Each element in the array must be ' + maxString + ' ' + style.minMax(items.maximum) + '.', 1);
+                    md += style.bulletItem(eachElementInTheArrayMust + 'be ' + maxString + ' ' + style.minMax(items.maximum) + '.', 1);
                 }
 
                 if (defined(items.minLength) && defined(items.maxLength)) {
-                    md += style.bulletItem('Each element in the array must have length between ' + style.minMax(items.minLength) +
+                    md += style.bulletItem(eachElementInTheArrayMust + 'have length between ' + style.minMax(items.minLength) +
                         ' and ' + style.minMax(items.maxLength) + '.', 1);
                 } else if (defined(items.minLength)) {
-                    md += style.bulletItem('Each element in the array must have length greater than or equal to ' + style.minMax(items.minLength) + '.', 1);
+                    md += style.bulletItem(eachElementInTheArrayMust + 'have length greater than or equal to ' + style.minMax(items.minLength) + '.', 1);
                 } else if (defined(items.maxLength)) {
-                    md += style.bulletItem('Each element in the array must have length less than or equal to ' + style.minMax(items.maxLength) + '.', 1);
+                    md += style.bulletItem(eachElementInTheArrayMust + 'have length less than or equal to ' + style.minMax(items.maxLength) + '.', 1);
                 }
 
                 var itemsString = getEnumString(items, type, 2);

lib/style.js

@@ -10,6 +10,8 @@ module.exports = {
 
     setCheckmark: setCheckmark,
 
+    setMustKeyword: setMustKeyword,
+
     getHeaderMarkdown: getHeaderMarkdown,
 
     getSectionMarkdown: getSectionMarkdown,
@@ -123,9 +125,14 @@ module.exports = {
     embedJsonSchema: embedJsonSchema,
 
     /**
-    * @property {string} The markdown string used for displaying the icon used to indicate a value is required.
+    * @property {string} requiredIcon - The markdown string used for displaying the icon used to indicate a value is required.
     */
-    requiredIcon: ' ✓ '
+    requiredIcon: ' ✓ ',
+
+    /**
+     * @property {string} mustKeyword - The keyword used when a condition must be true.
+     */
+    mustKeyword: ' must ',
 };
 
 const REFERENCE = "reference-";
@@ -160,6 +167,19 @@ function setCheckmark(checkmark) {
     }
 }
 
+/**
+ * @function setMustKeyword
+ * Set the keyword used in place of the word "must".
+ * @param {string} mustKeyword The keyword used when a condition must be true.
+ */
+function setMustKeyword(mustKeyword) {
+    if (mustKeyword.length > 0) {
+        module.exports.mustKeyword = ' ' + mustKeyword + ' ';
+    } else {
+        module.exports.mustKeyword = ' must ';
+    }
+}
+
 /**
 * @function getHeaderMarkdown
 * Gets the markdown syntax for the start of a header.

test/test-golden/example-keyword.md

@@ -0,0 +1,43 @@
+# Objects
+* [`example`](#reference-example) (root object)
+
+
+---------------------------------------
+<a name="reference-example"></a>
+## example
+
+Example description.
+
+**`example` Properties**
+
+|   |Type|Description|Required|
+|---|---|---|---|
+|**byteOffset**|`integer`|The offset relative to the start of the buffer in bytes.|No, default: `0`|
+|**type**|`string`|Specifies if the elements are scalars, vectors, or matrices.| &#10003; Yes|
+
+Additional properties are not allowed.
+
+### example.byteOffset
+
+The offset relative to the start of the buffer in bytes.
+
+* **Type**: `integer`
+* **Required**: No, default: `0`
+* **Minimum**: ` >= 0`
+
+### example.type
+
+Specifies if the elements are scalars, vectors, or matrices.
+
+* **Type**: `string`
+* **Required**:  &#10003; Yes
+* **Allowed values**:
+   * `"SCALAR"`
+   * `"VEC2"`
+   * `"VEC3"`
+   * `"VEC4"`
+   * `"MAT2"`
+   * `"MAT3"`
+   * `"MAT4"`
+
+