feat: adds pruneProperties option for deep cleanup

Author: pateketrueke

docs/README.md

@@ -107,6 +107,7 @@ jsf.locate('faker');
 
 - `defaultInvalidTypeProduct` — If `failOnInvalidTypes` is disabled this value will be returned on any invalid `type` given (default: `null`)
 - `defaultRandExpMax` — Setup default value directly as `RandExp.prototype.max` (default: `10`)
+- `pruneProperties` — Remove given properties from generated objects (default: `[]`)
 - `ignoreProperties` — Skip given properties from being generated (default: `[]`)
 - `ignoreMissingRefs` — If enabled, it will resolve to `{}` for unknown references (default: `false`)
 - `failOnInvalidTypes` — If enabled, it will throw an `Error` for unknown types (default: `true`)

src/lib/api/defaults.js

@@ -5,6 +5,7 @@ export default defaults;
 defaults.defaultInvalidTypeProduct = undefined;
 defaults.defaultRandExpMax = 10;
 
+defaults.pruneProperties = [];
 defaults.ignoreProperties = [];
 defaults.ignoreMissingRefs = false;
 defaults.failOnInvalidTypes = true;

src/lib/core/traverse.js

@@ -164,7 +164,10 @@ function traverse(schema, path, resolve, rootSchema) {
     valueCopy = [];
   }
 
+  const pruneProperties = optionAPI('pruneProperties') || [];
+
   Object.keys(schema).forEach(prop => {
+    if (pruneProperties.includes(prop)) return;
     if (typeof schema[prop] === 'object' && prop !== 'definitions') {
       const { value, context: innerContext } = traverse(schema[prop], path.concat([prop]), resolve, valueCopy);
       valueCopy[prop] = utils.clean(value, schema[prop], false);

tests/schema/core/option/pruneProperties.json

@@ -0,0 +1,27 @@
+[
+  {
+    "description": "pruneProperties option",
+    "tests": [
+      {
+        "description": "should remove nested keys from pruneProperties",
+        "schema": {
+          "properties": {
+            "test": {
+              "nestedProp": {
+                "foo": "bar"
+              },
+              "otherProp": true
+            }
+          },
+          "required": [
+            "test"
+          ]
+        },
+        "equal": { "test": {} },
+        "set": {
+          "pruneProperties": ["nestedProp", "otherProp"]
+        }
+      }
+    ]
+  }
+]