feat: better error messages

package.json

@@ -27,12 +27,20 @@
         "vitest": "^1.2.2"
     },
     "dependencies": {
+        "@babel/code-frame": "^7.23.5",
+        "@babel/runtime": "^7.23.9",
+        "@humanwhocodes/momoa": "^3.0.0",
+        "@readme/better-ajv-errors": "^1.6.0",
         "@types/node": "^20.11.10",
         "ajv": "^8.12.0",
         "ajv-draft-04": "^1.0.0",
         "ajv-formats": "^2.1.1",
+        "chalk": "^5.3.0",
         "glob": "^10.3.10",
         "js-yaml": "^4.1.0",
+        "json-to-ast": "^2.1.0",
+        "jsonpointer": "^5.0.1",
+        "leven": "^4.0.0",
         "openapi-types": "^12.1.3",
         "vite": "^5.0.12",
         "vite-node": "^1.2.2"

src/lib/index.ts

@@ -2,8 +2,14 @@ import Ajv04 from 'ajv-draft-04'
 import addFormats from 'ajv-formats'
 import Ajv2020 from 'ajv/dist/2020'
 import { JSON_SCHEMA, load } from 'js-yaml'
-import type { AjvOptions, Specification, ValidationResult } from '../types'
+import type {
+  AjvOptions,
+  Specification,
+  ValidationResult,
+  ValidateOptions,
+} from '../types'
 import { checkRefs, replaceRefs } from './resolve'
+import betterAjvErrors from '../utils/betterAjvErrors'
 
 const supportedVersions = new Set(['2.0', '3.0', '3.1'])
 
@@ -141,7 +147,10 @@ export class Validator {
     this.externalRefs[newUri] = spec
   }
 
-  async validate(data: string | object): Promise<ValidationResult> {
+  async validate(
+    data: string | object,
+    options?: ValidateOptions,
+  ): Promise<ValidationResult> {
     const specification = await getSpecFromData(data)
 
     this.specification = specification
@@ -185,7 +194,22 @@ export class Validator {
     }
 
     if (validateSchema.errors) {
-      result.errors = validateSchema.errors
+      if (typeof validateSchema.errors === 'string') {
+        result.errors = validateSchema.errors
+      } else {
+        result.errors = betterAjvErrors(
+          schemaResult,
+          {},
+          validateSchema.errors,
+          {
+            format: options?.format ?? 'js',
+            indent: options?.indent ?? 2,
+            colorize: false,
+          },
+        )
+      }
+
+      console.log(result.errors)
     }
 
     return result

src/types.ts

@@ -7,6 +7,11 @@ export type ValidationResult = {
   errors?: string | ErrorObject[]
 }
 
+export type ValidateOptions = {
+  format?: 'js' | 'cli'
+  indent?: number
+}
+
 export type ParseResult = OpenAPI.Document
 
 export type EmptyObject = Record<string, never>