feat: add RuntimeTypeErrorItem.messageAtPath() method

Author: jedwards1211

src/errorReporting/InvalidKeyTypeErrorItem.ts

@@ -1,5 +1,5 @@
 import Type from '../types/Type'
-import { IdentifierPath, stringifyPath } from '../Validation'
+import { IdentifierPath } from '../Validation'
 import { keyToString } from './keyToString'
 import RuntimeTypeErrorItem from './RuntimeTypeErrorItem'
 
@@ -20,8 +20,8 @@ export default class InvalidKeyTypeErrorItem extends RuntimeTypeErrorItem {
     this.expectedKeyType = expectedKeyType
   }
 
-  toString(): string {
-    return `${stringifyPath(this.path)} has key of invalid type: ${keyToString(
+  messageAtPath(): string {
+    return `has key of invalid type: ${keyToString(
       this.key
     )}\n\nEach key must be ${this.expectedKeyType.toString({
       formatForMustBe: true,

src/errorReporting/InvalidLengthErrorItem.ts

@@ -18,9 +18,11 @@ export default class InvalidLengthErrorItem extends RuntimeTypeErrorItem {
     this.expectedLength = expectedLength
   }
 
+  messageAtPath(): string {
+    return `length must be ${this.expectedLength}, instead it is ${this.valueAtPath.length}`
+  }
+
   toString(): string {
-    return `${stringifyPath(this.path)}.length must be ${
-      this.expectedLength
-    }, instead it is ${this.valueAtPath.length}`
+    return `${stringifyPath(this.path)}.${this.messageAtPath()}`
   }
 }

src/errorReporting/InvalidTypeErrorItem.ts

@@ -1,5 +1,5 @@
 import Type from '../types/Type'
-import { IdentifierPath, stringifyPath } from '../Validation'
+import { IdentifierPath } from '../Validation'
 import RuntimeTypeErrorItem from './RuntimeTypeErrorItem'
 
 export default class InvalidTypeErrorItem extends RuntimeTypeErrorItem {
@@ -13,9 +13,9 @@ export default class InvalidTypeErrorItem extends RuntimeTypeErrorItem {
     super(path, valueAtPath, expectedTypeAtPath)
   }
 
-  toString(): string {
-    return `${stringifyPath(
-      this.path
-    )} must be ${this.expectedTypeAtPath.toString({ formatForMustBe: true })}`
+  messageAtPath(): string {
+    return `must be ${this.expectedTypeAtPath.toString({
+      formatForMustBe: true,
+    })}`
   }
 }

src/errorReporting/MissingPropertyErrorItem.ts

@@ -1,7 +1,7 @@
 import Type from '../types/Type'
 import ObjectTypeProperty from '../types/ObjectTypeProperty'
 import RuntimeTypeErrorItem from './RuntimeTypeErrorItem'
-import { IdentifierPath, stringifyPath } from '../Validation'
+import { IdentifierPath } from '../Validation'
 import { keyToString } from './keyToString'
 
 export default class MissingPropertyErrorItem extends RuntimeTypeErrorItem {
@@ -18,10 +18,8 @@ export default class MissingPropertyErrorItem extends RuntimeTypeErrorItem {
     this.propertyType = propertyType
   }
 
-  toString(): string {
-    return `${stringifyPath(
-      this.path
-    )} is missing required property ${keyToString(
+  messageAtPath(): string {
+    return `is missing required property ${keyToString(
       this.propertyType.key
     )}, which must be ${this.propertyType.value.toString({
       formatForMustBe: true,

src/errorReporting/RuntimeTypeErrorItem.ts

@@ -1,4 +1,4 @@
-import { IdentifierPath } from '../Validation'
+import { IdentifierPath, stringifyPath } from '../Validation'
 import Type from '../types/Type'
 
 export default abstract class RuntimeTypeErrorItem {
@@ -19,4 +19,10 @@ export default abstract class RuntimeTypeErrorItem {
     this.expectedTypeAtPath = expectedTypeAtPath
     this.depth = depth
   }
+
+  abstract messageAtPath(): string
+
+  toString(): string {
+    return `${stringifyPath(this.path)} ${this.messageAtPath()}`
+  }
 }

src/errorReporting/UnknownPropertyErrorItem.ts

@@ -1,6 +1,6 @@
 import Type from '../types/Type'
 import RuntimeTypeErrorItem from './RuntimeTypeErrorItem'
-import { IdentifierPath, stringifyPath } from '../Validation'
+import { IdentifierPath } from '../Validation'
 import { keyToString } from './keyToString'
 
 export default class UnknownPropertyErrorItem extends RuntimeTypeErrorItem {
@@ -17,9 +17,7 @@ export default class UnknownPropertyErrorItem extends RuntimeTypeErrorItem {
     this.key = key
   }
 
-  toString(): string {
-    return `${stringifyPath(this.path)} has unknown property: ${keyToString(
-      this.key
-    )}`
+  messageAtPath(): string {
+    return `has unknown property: ${keyToString(this.key)}`
   }
 }

src/errorReporting/ViolatedConstraintErrorItem.ts

@@ -1,5 +1,5 @@
 import Type from '../types/Type'
-import { IdentifierPath, stringifyPath } from '../Validation'
+import { IdentifierPath } from '../Validation'
 import RuntimeTypeErrorItem from './RuntimeTypeErrorItem'
 
 export default class ViolatedConstraintErrorItem extends RuntimeTypeErrorItem {
@@ -16,7 +16,7 @@ export default class ViolatedConstraintErrorItem extends RuntimeTypeErrorItem {
     this.constraintErrorMessage = constraintErrorMessage
   }
 
-  toString(): string {
-    return `${stringifyPath(this.path)} ${this.constraintErrorMessage}`
+  messageAtPath(): string {
+    return this.constraintErrorMessage
   }
 }