refactor(yaml): rename YAMLError to YamlError (#5149)

BREAKING(yaml): rename `YAMLError` to `YamlError`
denoland · Jun 27, 2024 · ef4231e · ef4231e
1 parent 5811712
commit ef4231e
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 24 deletions.
diff --git a/yaml/_dumper/dumper.ts b/yaml/_dumper/dumper.ts
@@ -3,7 +3,7 @@
 // Copyright 2011-2015 by Vitaly Puzrin. All rights reserved. MIT license.
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
-import { YAMLError } from "../_error.ts";
+import { YamlError } from "../_error.ts";
 import type { RepresentFn } from "../type.ts";
 import * as common from "../_utils.ts";
 import { DumperState, type DumperStateOptions } from "./dumper_state.ts";
@@ -89,7 +89,7 @@ function encodeHex(character: number): string {
     handle = "U";
     length = 8;
   } else {
-    throw new YAMLError(
+    throw new YamlError(
       "code point within a string may not be greater than 0xFFFFFFFF",
     );
   }
@@ -497,7 +497,7 @@ function writeScalar(
       case STYLE_DOUBLE:
         return `"${escapeString(string)}"`;
       default:
-        throw new YAMLError("impossible error: invalid scalar style");
+        throw new YamlError("impossible error: invalid scalar style");
     }
   })();
 }
@@ -611,7 +611,7 @@ function writeBlockMapping(
     objectKeyList.sort(state.sortKeys);
   } else if (state.sortKeys) {
     // Something is wrong
-    throw new YAMLError("sortKeys must be a boolean or a function");
+    throw new YamlError("sortKeys must be a boolean or a function");
   }
 
   for (const [index, objectKey] of objectKeyList.entries()) {
@@ -693,7 +693,7 @@ function detectType(
             style,
           );
         } else {
-          throw new YAMLError(
+          throw new YamlError(
             `!<${type.tag}> tag resolver accepts not "${style}" style`,
           );
         }
@@ -786,7 +786,7 @@ function writeNode(
       }
     } else {
       if (state.skipInvalid) return false;
-      throw new YAMLError(`unacceptable kind of an object to dump ${type}`);
+      throw new YamlError(`unacceptable kind of an object to dump ${type}`);
     }
 
     if (state.tag !== null && state.tag !== "?") {

diff --git a/yaml/_error.ts b/yaml/_error.ts
@@ -5,7 +5,7 @@
 
 import type { Mark } from "./_mark.ts";
 
-export class YAMLError extends Error {
+export class YamlError extends Error {
   constructor(
     message = "(unknown reason)",
     protected mark: Mark | string = "",

diff --git a/yaml/_loader/loader.ts b/yaml/_loader/loader.ts
@@ -3,7 +3,7 @@
 // Copyright 2011-2015 by Vitaly Puzrin. All rights reserved. MIT license.
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
-import { YAMLError } from "../_error.ts";
+import { YamlError } from "../_error.ts";
 import { Mark } from "../_mark.ts";
 import type { Type } from "../type.ts";
 import * as common from "../_utils.ts";
@@ -161,8 +161,8 @@ for (let i = 0; i < 256; i++) {
   simpleEscapeMap[i] = simpleEscapeSequence(i);
 }
 
-function generateError(state: LoaderState, message: string): YAMLError {
-  return new YAMLError(
+function generateError(state: LoaderState, message: string): YamlError {
+  return new YamlError(
     message,
     new Mark(
       state.filename as string,
@@ -1797,7 +1797,7 @@ export function load(input: string, options?: LoaderStateOptions): unknown {
   if (documents.length === 1) {
     return documents[0];
   }
-  throw new YAMLError(
+  throw new YamlError(
     "expected a single document in the stream, but found more",
   );
 }
diff --git a/yaml/_loader/loader_state.ts b/yaml/_loader/loader_state.ts
@@ -3,7 +3,7 @@
 // Copyright 2011-2015 by Vitaly Puzrin. All rights reserved. MIT license.
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 
-import type { YAMLError } from "../_error.ts";
+import type { YamlError } from "../_error.ts";
 import type { Schema, SchemaDefinition, TypeMap } from "../schema.ts";
 import { State } from "../_state.ts";
 import type { Type } from "../type.ts";
@@ -19,7 +19,7 @@ export interface LoaderStateOptions {
   /** compatibility with JSON.parse behaviour. */
   json?: boolean;
   /** function to call on warning messages. */
-  onWarning?(this: null, e?: YAMLError): void;
+  onWarning?(this: null, e?: YamlError): void;
 }
 
 // deno-lint-ignore no-explicit-any

diff --git a/yaml/parse.ts b/yaml/parse.ts
@@ -49,7 +49,7 @@ export interface ParseOptions {
  * assertEquals(data, { id: 1, name: "Alice" });
  * ```
  *
- * @throws {YAMLError} Throws error on invalid YAML.
+ * @throws {YamlError} Throws error on invalid YAML.
  * @param content YAML string to parse.
  * @param options Parsing options.
  * @returns Parsed document.

diff --git a/yaml/parse_test.ts b/yaml/parse_test.ts
@@ -6,7 +6,7 @@
 import { parse, parseAll } from "./parse.ts";
 import { assert, assertEquals, assertThrows } from "@std/assert";
 import { DEFAULT_SCHEMA, EXTENDED_SCHEMA } from "./schema/mod.ts";
-import { YAMLError } from "./_error.ts";
+import { YamlError } from "./_error.ts";
 import { Type } from "./type.ts";
 
 Deno.test({
@@ -62,7 +62,7 @@ Deno.test({
   name: "parse() throws with `!!js/*` yaml types with default schemas",
   fn() {
     const yaml = `undefined: !!js/undefined ~`;
-    assertThrows(() => parse(yaml), YAMLError, "unknown tag !");
+    assertThrows(() => parse(yaml), YamlError, "unknown tag !");
   },
 });
 
@@ -291,25 +291,25 @@ Deno.test({
     // map entry is not an object
     assertThrows(
       () => parse("--- !!omap\n- 1"),
-      YAMLError,
+      YamlError,
       "cannot resolve a node with !<tag:yaml.org,2002:omap> explicit tag",
     );
     // map entry is empty object
     assertThrows(
       () => parse("--- !!omap\n- {}"),
-      YAMLError,
+      YamlError,
       "cannot resolve a node with !<tag:yaml.org,2002:omap> explicit tag",
     );
     // map entry is an object with multiple keys
     assertThrows(
       () => parse("--- !!omap\n- foo: 1\n  bar: 2"),
-      YAMLError,
+      YamlError,
       "cannot resolve a node with !<tag:yaml.org,2002:omap> explicit tag",
     );
     // 2 map entries have the same key
     assertThrows(
       () => parse("--- !!omap\n- foo: 1\n- foo: 2"),
-      YAMLError,
+      YamlError,
       "cannot resolve a node with !<tag:yaml.org,2002:omap> explicit tag",
     );
   },

diff --git a/yaml/schema.ts b/yaml/schema.ts
@@ -4,7 +4,7 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 // This module is browser compatible.
 
-import { YAMLError } from "./_error.ts";
+import { YamlError } from "./_error.ts";
 import type { KindType, Type } from "./type.ts";
 import type { Any, ArrayObject } from "./_utils.ts";
 
@@ -72,7 +72,7 @@ export class Schema implements SchemaDefinition {
 
     for (const type of this.implicit) {
       if (type.loadKind && type.loadKind !== "scalar") {
-        throw new YAMLError(
+        throw new YamlError(
           "There is a non-scalar type in the implicit list of a schema. Implicit resolving of such types is not supported.",
         );
       }

diff --git a/yaml/stringify_test.ts b/yaml/stringify_test.ts
@@ -5,7 +5,7 @@
 
 import { assertEquals, assertThrows } from "@std/assert";
 import { stringify } from "./stringify.ts";
-import { YAMLError } from "./_error.ts";
+import { YamlError } from "./_error.ts";
 import { DEFAULT_SCHEMA, EXTENDED_SCHEMA } from "./schema/mod.ts";
 import { Type } from "./type.ts";
 
@@ -95,7 +95,7 @@ Deno.test({
     const object = { undefined: undefined };
     assertThrows(
       () => stringify(object),
-      YAMLError,
+      YamlError,
       "unacceptable kind of an object to dump",
     );
   },