Include error codes

Author: P0lip

lib/index.d.ts

@@ -411,18 +411,39 @@ declare namespace $RefParser {
     set($ref: string, value: JSONSchema4Type | JSONSchema6Type): void
   }
 
+  export type JSONParserErrorType = "EUNKNOWN" | "EPARSER" | "EUNMATCHEDPARSER" | "ERESOLVER" | "EUNMATCHEDRESOLVER" | "EMISSINGPOINTER" | "EINVALIDPOINTER";
+
   export class JSONParserError extends Error {
+    readonly name: string;
     readonly message: string;
     readonly path: Array<string | number>;
     readonly source: string;
+    readonly code: JSONParserErrorType;
   }
 
-  export class ParserError extends JSONParserError {}
-  export class UnmatchedParserError extends JSONParserError {}
+  export class ParserError extends JSONParserError {
+    readonly name = "ParserError";
+    readonly code = "EPARSER";
+  }
+  export class UnmatchedParserError extends JSONParserError {
+    readonly name = "UnmatchedParserError";
+    readonly code ="EUNMATCHEDPARSER";
+  }
   export class ResolverError extends JSONParserError {
-    readonly code?: string;
+    readonly name = "ResolverError";
+    readonly code ="ERESOLVER";
+    readonly ioErrorCode?: string;
+  }
+  export class UnmatchedResolverError extends JSONParserError {
+    readonly name = "UnmatchedResolverError";
+    readonly code ="EUNMATCHEDRESOLVER";
+  }
+  export class MissingPointerError extends JSONParserError {
+    readonly name = "MissingPointerError";
+    readonly code ="EMISSINGPOINTER";
+  }
+  export class InvalidPointerError extends JSONParserError {
+    readonly name = "InvalidPointerError";
+    readonly code ="EINVALIDPOINTER";
   }
-  export class UnmatchedResolverError extends JSONParserError {}
-  export class MissingPointerError extends JSONParserError {}
-  export class InvalidPointerError extends JSONParserError {}
 }

lib/util/errors.js

@@ -8,6 +8,7 @@ const JSONParserError = exports.JSONParserError = class JSONParserError extends
   constructor (message, source) {
     super();
 
+    this.code = "EUNKNOWN";
     this.message = message;
     this.source = source;
     this.path = [];
@@ -22,6 +23,7 @@ const JSONParserErrorGroup = exports.JSONParserErrorGroup = class JSONParserErro
   constructor (errors, source) {
     super();
 
+    this.code = "EUNKNOWN";
     this._path = undefined;
     this._source = source;
     this.errors = errors;
@@ -62,6 +64,7 @@ exports.StoplightParserError = class StoplightParserError extends JSONParserErro
       return parserError;
     }));
 
+    this.code = "ESTOPLIGHTPARSER";
     this.message = `Error parsing ${source}`;
   }
 
@@ -77,6 +80,8 @@ exports.StoplightParserError = class StoplightParserError extends JSONParserErro
 const ParserError = exports.ParserError = class ParserError extends JSONParserError {
   constructor (message, source) {
     super(`Error parsing ${source}: ${message}`, source);
+
+    this.code = "EPARSER";
   }
 };
 
@@ -85,6 +90,8 @@ setErrorName(ParserError);
 const UnmatchedParserError = exports.UnmatchedParserError = class UnmatchedParserError extends JSONParserError {
   constructor (source) {
     super(`Could not find parser for "${source}"`, source);
+
+    this.code = "EUNMATCHEDPARSER";
   }
 };
 
@@ -93,8 +100,11 @@ setErrorName(UnmatchedParserError);
 const ResolverError = exports.ResolverError = class ResolverError extends JSONParserError {
   constructor (ex, source) {
     super(ex.message || `Error reading file "${source}"`, source);
+
+    this.code = "ERESOLVER";
+
     if ("code" in ex) {
-      this.code = String(ex.code);
+      this.ioErrorCode = String(ex.code);
     }
   }
 };
@@ -104,6 +114,8 @@ setErrorName(ResolverError);
 const UnmatchedResolverError = exports.UnmatchedResolverError = class UnmatchedResolverError extends JSONParserError {
   constructor (source) {
     super(`Could not find resolver for "${source}"`, source);
+
+    this.code = "EUNMATCHEDRESOLVER";
   }
 };
 
@@ -112,6 +124,8 @@ setErrorName(UnmatchedResolverError);
 const MissingPointerError = exports.MissingPointerError = class MissingPointerError extends JSONParserError {
   constructor (token, path) {
     super(`Token "${token}" does not exist.`, stripHash(path));
+
+    this.code = "EMISSINGPOINTER";
   }
 };
 
@@ -120,6 +134,8 @@ setErrorName(MissingPointerError);
 const InvalidPointerError = exports.InvalidPointerError = class InvalidPointerError extends JSONParserError {
   constructor (pointer, path) {
     super(`Invalid $ref pointer "${pointer}". Pointers must begin with "#/"`, stripHash(path));
+
+    this.code = "EINVALIDPOINTER";
   }
 };
 

test/specs/invalid/invalid.spec.js

@@ -20,7 +20,7 @@ describe("Invalid syntax", () => {
       catch (err) {
         expect(err).to.be.an.instanceOf(ResolverError);
         if (host.node) {
-          expect(err.code).to.equal("ENOENT");
+          expect(err.ioErrorCode).to.equal("ENOENT");
           expect(err.message).to.contain("Error opening file ");
         }
       }