Adding support for const in properties.

lib/renderer-markdown.js

@@ -8,13 +8,17 @@ const readFile = util.promisify(fs.readFile);
 
 let refLinkBasePath = "";
 
+const upperCaseFirstCharacter = (value) => {
+  return value.substr(0, 1).toUpperCase() + value.substr(1);
+};
+
 const typeToLinkLabel = (label, x) => {
   if (Array.isArray(label)) {
     label = label.join(", ");
     label = `[${label}]`;
   } else {
     label = label || "";
-    label = label.substr(0, 1).toUpperCase() + label.substr(1);
+    label = upperCaseFirstCharacter(label);
     label = label.replace(".md", "html");
   }
   return label;
@@ -106,6 +110,13 @@ const attributeRow = (name, property, parentKey) => {
     href = parentKey.toLowerCase();
   }
   href += name.toLowerCase();
+
+  let typeLabel;
+  if (property.const) {
+    typeLabel = `${upperCaseFirstCharacter(property.type)}=${property.const}`;
+  } else {
+    typeLabel = jsonSchemaType(property);
+  }
   let html =
     "<tr>" +
     '<td colspan="2"><a href="#' +
@@ -114,7 +125,7 @@ const attributeRow = (name, property, parentKey) => {
     name +
     "</a></td>" +
     "<td>" +
-    jsonSchemaType(property) +
+    typeLabel +
     "</td>" +
     "</tr>";
 

package.json

@@ -27,8 +27,8 @@
     "extend": "^3.0.2",
     "fast-glob": "^3.2.12",
     "handlebars": "^4.7.7",
-    "jsonpointer": "^5.0.1",
     "json-schema-ref-parser": "^9.0.9",
+    "jsonpointer": "^5.0.1",
     "lodash": ">=4.17.21",
     "make-dir": "^3.1.0",
     "mkdirp": "^1.0.4",

templates/schema.hbs

@@ -94,6 +94,10 @@
     </tr>
     {{/if}}
     {{propertyTypeRow this }}
+    {{#if this.const}}<tr>
+      <td>Const</td>
+      <td colspan="2">{{this.const}}</td>
+    </tr>{{/if}}
     {{#if this.enum}}<tr>
       <td>Enum</td>
       <td colspan="2">{{enumValues this.enum}}</td>

tests/renderer-markdown.test.js

@@ -34,6 +34,18 @@ let defaultMergedSchema = {
     },
   },
 };
+const defaultMergedSchemaWithConst = {
+  schema: {
+    title: "My Schema",
+    properties: {
+      property1: {
+        title: "Property 1",
+        type: "string",
+        const: "foo",
+      },
+    },
+  },
+};
 let mergedSchema = {};
 
 const removeFormatting = (value) => {
@@ -61,16 +73,35 @@ test("renders attributes", async () => {
   let result = rendererMarkdown.renderSchema(mergedSchema);
 
   result = result.match(/## Properties(.*\n)*/)[0];
+  result = removeFormatting(result);
 
   let expectedText =
-    "## Properties\n\n" +
+    "## Properties" +
     '<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead>' +
     '<tr><td colspan="2"><a href="#property1">property1</a></td><td>String</td></tr>' +
     '<tr><td colspan="2"><a href="#property2">property2</a></td><td>[string, integer]</td></tr>' +
     '<tr><td colspan="2"><a href="#property3">property3</a></td><td>Array [<a href="property3.html">Property3.html</a>]</td></tr>' +
     "</tbody></table>";
 
-  expect(result).toEqual(expect.stringContaining(expectedText));
+  expect(result).toContain(expectedText);
+});
+
+test("renders attributes with const", async () => {
+  expect.assertions(1);
+  rendererMarkdown = new RendererMarkdown(defaultTemplatePath);
+  await rendererMarkdown.setup();
+  let result = rendererMarkdown.renderSchema(defaultMergedSchemaWithConst);
+
+  result = result.match(/## Properties(.*\n)*/)[0];
+  result = removeFormatting(result);
+
+  let expectedText =
+    "## Properties" +
+    '<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead>' +
+    '<tr><td colspan="2"><a href="#property1">property1</a></td><td>String=foo</td></tr>' +
+    "</tbody></table>";
+
+  expect(result).toContain(expectedText);
 });
 
 test("renders string property enums", async () => {
@@ -83,12 +114,30 @@ test("renders string property enums", async () => {
   result = removeFormatting(result);
 
   let expectedText =
-    "" + '<tr><td>Title</td><td colspan="2">Property 1</td></tr>';
-  +'<tr><td>Required</td><td colspan="2">Yes</td></tr>' +
+    '<tr><td>Title</td><td colspan="2">Property 1</td></tr>' +
+    '<tr><td>Required</td><td colspan="2">Yes</td></tr>' +
     '<tr><td>Type</td><td colspan="2">String</td></tr>' +
     '<tr><td>Enum</td><td colspan="2"><ul><li>foo</li><li>bar</li><li>42</li><li>null</li></ul></td></tr>';
 
-  expect(result).toEqual(expect.stringContaining(expectedText));
+  expect(result).toContain(expectedText);
+});
+
+test("renders string property with const", async () => {
+  expect.assertions(1);
+  mergedSchema = _.cloneDeep(defaultMergedSchemaWithConst);
+  rendererMarkdown = new RendererMarkdown(defaultTemplatePath);
+  await rendererMarkdown.setup();
+  let result = rendererMarkdown.renderSchema(mergedSchema);
+
+  result = result.match(/## property1(.*\n)*/)[0];
+  result = removeFormatting(result);
+
+  let expectedText =
+    '<tr><td>Title</td><td colspan="2">Property 1</td></tr>' +
+    '<tr><td>Type</td><td colspan="2">String</td></tr>' +
+    '<tr><td>Const</td><td colspan="2">foo</td></tr>';
+
+  expect(result).toContain(expectedText);
 });
 
 test("renders array property types", async () => {
@@ -106,5 +155,5 @@ test("renders array property types", async () => {
   let expectedType =
     '<tr><td>Type</td><td colspan="2">Array [<a href="property3.html">Property3.html</a>]</td></tr>';
 
-  expect(result).toEqual(expect.stringContaining(expectedType));
+  expect(result).toContain(expectedType);
 });