Merge pull request #76 from tomcollins/allow-enum-meta-in-strict-mode

Allow meta:enum to be used in strict mode.

Author: tomcollins

README.md

@@ -28,16 +28,31 @@ const JsonSchemaStaticDocs = require('json-schema-static-docs');
 
 ## Describing Enums
 
-Json-schema allows a set of enumeration values to be defined for a string property but does not allow descriptions to be defined for each value. Descriptions within documentation ca.n be very useful
+Json-schema allows a set of enumeration values to be defined for a string property but does not allow descriptions to be defined for each value. Descriptions within documentation can be very useful.
 
 This library supports the `meta:enum` convention (inspired by [adobe/jsonschema2md](https://github.com/adobe/jsonschema2md) to allow descriptions to be defined for enums.
 
+You will need to enable this feature using the `enableMetaEnum` option:
+
+```javascript
+let jsonSchemaStaticDocs = new JsonSchemaStaticDocs({
+  inputPath: "./schema",
+  outputPath: "./docs",
+  enableMetaEnum: true,
+});
+await jsonSchemaStaticDocs.generate();
+```
+
+_This allows the `meta:enum` keyword to be used when applying strict validation._
+
+And then define the `meta:enum` descriptions adjacent to your `enum` e.g.
+
 ```yml
-property1: {
+property1:
   title: "Property 1",
   type: "string",
   enum: ["foo", 42],
-  meta:enum: {
+  meta:enum:
     foo: Description for foo
     42: Description for 42
 ```

lib/json-schema-static-docs.js

@@ -18,6 +18,7 @@ const defaultOptions = {
   linkBasePath: "./",
   skipTemplates: false,
   ajvOptions: {},
+  enableMetaEnum: false,
 };
 
 var JsonSchemaStaticDocs = function (options) {
@@ -46,6 +47,10 @@ JsonSchemaStaticDocs.prototype.generate = async function () {
   });
   const validator = new Validator(schemas, this._options.ajvOptions);
 
+  if (this._options.enableMetaEnum) {
+    validator.addMetaEnum();
+  }
+
   unresolvedSchemas.forEach((schema) => {
     try {
       validator.validateSchema(schema.data);

lib/validator.js

@@ -9,13 +9,20 @@ let Validator = function (schemas, ajvOptions) {
   addFormats(this._ajv);
 };
 
+Validator.prototype.addMetaEnum = function () {
+  // @todo this should really perform validation to ensure that the input is safe
+  this._ajv.addKeyword({
+    keyword: "meta:enum",
+    errors: false,
+  });
+};
+
 Validator.prototype.validateSchema = function (schema) {
   let validate = this._ajv.compile(schema);
   return true;
 };
 
 Validator.prototype.validateSchemaAndData = function (schema, data) {
-  // let ajv = new Ajv(options);
   var valid = this._ajv.validate(schema, data);
   if (!valid) {
     throw this._ajv.errors;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-schema-static-docs",
-  "version": "0.17.0",
+  "version": "0.17.1",
   "description": "",
   "main": "lib/json-schema-static-docs.js",
   "bin": {