feat(RuntimeTypeError.formatMessage): add includeActualValues: false option

Author: jedwards1211

src/errorReporting/RuntimeTypeError.js.flow

@@ -5,7 +5,11 @@ import type RuntimeTypeErrorItem from './RuntimeTypeErrorItem'
 declare class RuntimeTypeError extends TypeError {
   +errors: RuntimeTypeErrorItem[];
   constructor(errors: RuntimeTypeErrorItem[]): void;
-  formatMessage(options?: { limit?: number, ... }): string;
+  formatMessage(options?: {
+    limit?: number,
+    includeActualValues?: boolean,
+    ...
+  }): string;
 }
 
 export default RuntimeTypeError

src/errorReporting/RuntimeTypeError.ts

@@ -16,7 +16,10 @@ export default class RuntimeTypeError extends TypeError {
     return this.formatMessage()
   }
 
-  formatMessage({ limit = 10000 }: { limit?: number } = {}): string {
+  formatMessage({
+    limit = 10000,
+    includeActualValues = true,
+  }: { limit?: number; includeActualValues?: boolean } = {}): string {
     const result = []
     let remaining =
       limit - delimiter.length + `... ${this.errors.length} more errors`.length
@@ -25,16 +28,23 @@ export default class RuntimeTypeError extends TypeError {
       if (result.length) remaining -= delimiter.length
       const stringified = error.toString()
       remaining -= stringified.length
-      const actualValuePart = `\n\nActual Value: ${stringifyValue(
-        error.valueAtPath,
-        { limit: remaining - `\n\nActual Value: `.length }
-      )}`
-      remaining -= actualValuePart.length
+      let actualValuePart
+      if (includeActualValues) {
+        actualValuePart = `\n\nActual Value: ${stringifyValue(
+          error.valueAtPath,
+          { limit: remaining - `\n\nActual Value: `.length }
+        )}`
+        remaining -= actualValuePart.length
+      }
       if (remaining < 0 && result.length) {
         result.push(`... ${this.errors.length - i} more errors`)
         break
       }
-      result.push(remaining < 0 ? stringified : stringified + actualValuePart)
+      result.push(
+        remaining < 0 || !actualValuePart
+          ? stringified
+          : stringified + actualValuePart
+      )
     }
     return result.join(delimiter)
   }

test/RuntimeTypeError.spec.ts

@@ -61,6 +61,29 @@ describe(`RuntimeTypeError`, function() {
         `
       )
     })
+    it(`includeActualValues: false`, function() {
+      const TestType = t.array(t.object({ foo: t.number() }))
+      const testValue = []
+      for (let i = 0; i < 2; i++) {
+        testValue.push({
+          foo: 'this is a long long long long long property name',
+        })
+      }
+
+      expect(
+        expectError(TestType, testValue).formatMessage({
+          includeActualValues: false,
+        })
+      ).to.equal(
+        dedent`
+          input[0].foo must be a number
+          
+          -------------------------------------------------
+          
+          input[1].foo must be a number
+        `
+      )
+    })
     it(`limit works on number of errors`, function() {
       const TestType = t.array(t.object({ foo: t.number() }))
       const testValue = []