Skip to content

Commit fdb2774

Browse files
P0lipP0lip
committed
Rename GenericError to JSONParserError
1 parent 9c57f22 commit fdb2774

File tree

5 files changed

+27
-27
lines changed

5 files changed

+27
-27
lines changed

‎lib/index.d.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ declare class $RefParser {
3030
*
3131
* See https://github.com/APIDevTools/json-schema-ref-parser/blob/master/docs/ref-parser.md#errors
3232
*/
33-
errors: Array<$RefParser.GenericError | $RefParser.InvalidPointerError | $RefParser.ResolverError | $RefParser.ParserError | $RefParser.MissingPointerError | $RefParser.UnmatchedParserError | $RefParser.UnmatchedResolverError>;
33+
errors: Array<$RefParser.JSONParserError | $RefParser.InvalidPointerError | $RefParser.ResolverError | $RefParser.ParserError | $RefParser.MissingPointerError | $RefParser.UnmatchedParserError | $RefParser.UnmatchedResolverError>;
3434

3535
/**
3636
* Dereferences all `$ref` pointers in the JSON Schema, replacing each reference with its resolved value. This results in a schema object that does not contain any `$ref` pointers. Instead, it's a normal JavaScript object tree that can easily be crawled and used just like any other JavaScript object. This is great for programmatic usage, especially when using tools that don't understand JSON references.
@@ -411,18 +411,18 @@ declare namespace $RefParser {
411411
set($ref: string, value: JSONSchema4Type | JSONSchema6Type): void
412412
}
413413

414-
export class GenericError extends Error {
414+
export class JSONParserError extends Error {
415415
readonly message: string;
416416
readonly path: Array<string | number>;
417417
readonly source: string;
418418
}
419419

420-
export class ParserError extends GenericError {}
421-
export class UnmatchedParserError extends GenericError {}
422-
export class ResolverError extends GenericError {
420+
export class ParserError extends JSONParserError {}
421+
export class UnmatchedParserError extends JSONParserError {}
422+
export class ResolverError extends JSONParserError {
423423
readonly code?: string;
424424
}
425-
export class UnmatchedResolverError extends GenericError {}
426-
export class MissingPointerError extends GenericError {}
427-
export class InvalidPointerError extends GenericError {}
425+
export class UnmatchedResolverError extends JSONParserError {}
426+
export class MissingPointerError extends JSONParserError {}
427+
export class InvalidPointerError extends JSONParserError {}
428428
}

‎lib/index.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ const resolveExternal = require("./resolve-external");
88
const bundle = require("./bundle");
99
const dereference = require("./dereference");
1010
const url = require("./util/url");
11-
const { GenericError, InvalidPointerError, MissingPointerError, ResolverError, ParserError, UnmatchedParserError, UnmatchedResolverError, isHandledError } = require("./util/errors");
11+
const { JSONParserError, InvalidPointerError, MissingPointerError, ResolverError, ParserError, UnmatchedParserError, UnmatchedResolverError, isHandledError } = require("./util/errors");
1212
const maybe = require("call-me-maybe");
1313
const { ono } = require("@jsdevtools/ono");
1414

1515
module.exports = $RefParser;
1616
module.exports.YAML = require("./util/yaml");
17-
module.exports.GenericError = GenericError;
17+
module.exports.JSONParserError = JSONParserError;
1818
module.exports.InvalidPointerError = InvalidPointerError;
1919
module.exports.MissingPointerError = MissingPointerError;
2020
module.exports.ResolverError = ResolverError;
@@ -48,7 +48,7 @@ function $RefParser () {
4848

4949
/**
5050
* List of all errors
51-
* @type {Array<GenericError | ResolverError | ParserError | MissingPointerError | UnmatchedResolverError | UnmatchedResolverError>}
51+
* @type {Array<JSONParserError | ResolverError | ParserError | MissingPointerError | UnmatchedResolverError | UnmatchedResolverError>}
5252
*/
5353
Object.defineProperty($RefParser.prototype, "errors", {
5454
get () {

‎lib/pointer.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ module.exports = Pointer;
44

55
const $Ref = require("./ref");
66
const url = require("./util/url");
7-
const { GenericError, InvalidPointerError, MissingPointerError, isHandledError } = require("./util/errors");
7+
const { JSONParserError, InvalidPointerError, MissingPointerError, isHandledError } = require("./util/errors");
88
const slashes = /\//g;
99
const tildes = /~/g;
1010
const escapedSlash = /~1/g;
@@ -268,7 +268,7 @@ function setValue (pointer, token, value) {
268268
}
269269
}
270270
else {
271-
throw new GenericError(`Error assigning $ref pointer "${pointer.path}". \nCannot set "${token}" of a non-object.`);
271+
throw new JSONParserError(`Error assigning $ref pointer "${pointer.path}". \nCannot set "${token}" of a non-object.`);
272272
}
273273
return value;
274274
}

‎lib/ref.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
module.exports = $Ref;
44

55
const Pointer = require("./pointer");
6-
const { GenericError, GenericErrorGroup, ParserError, MissingPointerError, ResolverError, isHandledError } = require("./util/errors");
6+
const { JSONParserError, JSONParserErrorGroup, ParserError, MissingPointerError, ResolverError, isHandledError } = require("./util/errors");
77
const { safePointerToPath } = require("./util/url");
88

99
/**
@@ -45,15 +45,15 @@ function $Ref () {
4545

4646
/**
4747
* List of all errors. Undefined if no errors.
48-
* @type {Array<GenericError | ResolverError | ParserError | MissingPointerError>}
48+
* @type {Array<JSONParserError | ResolverError | ParserError | MissingPointerError>}
4949
*/
5050
this.errors = undefined;
5151
}
5252

5353
/**
5454
* Pushes an error to errors array.
5555
*
56-
* @param {Array<GenericError | GenericErrorGroup>} error - The error to be pushed
56+
* @param {Array<JSONParserError | JSONParserErrorGroup>} error - The error to be pushed
5757
* @returns {void}
5858
*/
5959
$Ref.prototype.addError = function (err) {

‎lib/util/errors.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const { Ono } = require("@jsdevtools/ono");
44

55
const { stripHash } = require("./url");
66

7-
const GenericError = exports.GenericError = class GenericError extends Error {
7+
const JSONParserError = exports.JSONParserError = class JSONParserError extends Error {
88
constructor (message, source) {
99
super();
1010

@@ -16,9 +16,9 @@ const GenericError = exports.GenericError = class GenericError extends Error {
1616
}
1717
};
1818

19-
setErrorName(GenericError);
19+
setErrorName(JSONParserError);
2020

21-
const GenericErrorGroup = exports.GenericErrorGroup = class GenericErrorGroup extends Error {
21+
const JSONParserErrorGroup = exports.JSONParserErrorGroup = class JSONParserErrorGroup extends Error {
2222
constructor (errors, source) {
2323
super();
2424

@@ -54,7 +54,7 @@ const GenericErrorGroup = exports.GenericErrorGroup = class GenericErrorGroup ex
5454
}
5555
};
5656

57-
exports.StoplightParserError = class StoplightParserError extends GenericErrorGroup {
57+
exports.StoplightParserError = class StoplightParserError extends JSONParserErrorGroup {
5858
constructor (diagnostics, source) {
5959
super(diagnostics.filter(StoplightParserError.pickError).map(error => {
6060
let parserError = new ParserError(error.message, source);
@@ -74,23 +74,23 @@ exports.StoplightParserError = class StoplightParserError extends GenericErrorGr
7474
}
7575
};
7676

77-
const ParserError = exports.ParserError = class ParserError extends GenericError {
77+
const ParserError = exports.ParserError = class ParserError extends JSONParserError {
7878
constructor (message, source) {
7979
super(`Error parsing ${source}: ${message}`, source);
8080
}
8181
};
8282

8383
setErrorName(ParserError);
8484

85-
const UnmatchedParserError = exports.UnmatchedParserError = class UnmatchedParserError extends GenericError {
85+
const UnmatchedParserError = exports.UnmatchedParserError = class UnmatchedParserError extends JSONParserError {
8686
constructor (source) {
8787
super(`Could not find parser for "${source}"`, source);
8888
}
8989
};
9090

9191
setErrorName(UnmatchedParserError);
9292

93-
const ResolverError = exports.ResolverError = class ResolverError extends GenericError {
93+
const ResolverError = exports.ResolverError = class ResolverError extends JSONParserError {
9494
constructor (ex, source) {
9595
super(ex.message || `Error reading file "${source}"`, source);
9696
if ("code" in ex) {
@@ -101,23 +101,23 @@ const ResolverError = exports.ResolverError = class ResolverError extends Generi
101101

102102
setErrorName(ResolverError);
103103

104-
const UnmatchedResolverError = exports.UnmatchedResolverError = class UnmatchedResolverError extends GenericError {
104+
const UnmatchedResolverError = exports.UnmatchedResolverError = class UnmatchedResolverError extends JSONParserError {
105105
constructor (source) {
106106
super(`Could not find resolver for "${source}"`, source);
107107
}
108108
};
109109

110110
setErrorName(UnmatchedResolverError);
111111

112-
const MissingPointerError = exports.MissingPointerError = class MissingPointerError extends GenericError {
112+
const MissingPointerError = exports.MissingPointerError = class MissingPointerError extends JSONParserError {
113113
constructor (token, path) {
114114
super(`Token "${token}" does not exist.`, stripHash(path));
115115
}
116116
};
117117

118118
setErrorName(MissingPointerError);
119119

120-
const InvalidPointerError = exports.InvalidPointerError = class InvalidPointerError extends GenericError {
120+
const InvalidPointerError = exports.InvalidPointerError = class InvalidPointerError extends JSONParserError {
121121
constructor (pointer, path) {
122122
super(`Invalid $ref pointer "${pointer}". Pointers must begin with "#/"`, stripHash(path));
123123
}
@@ -133,5 +133,5 @@ function setErrorName (err) {
133133
}
134134

135135
exports.isHandledError = function (err) {
136-
return err instanceof GenericError || err instanceof GenericErrorGroup;
136+
return err instanceof JSONParserError || err instanceof JSONParserErrorGroup;
137137
};

0 commit comments

Comments
 (0)