Merge pull request #12 from vim-denops/fix-batch-error

Refactor and add tests for `BatchError`

Author: lambdalisue

deno.jsonc

@@ -11,6 +11,7 @@
     "update:commit": "deno task -q update --commit --pre-commit=fmt,lint"
   },
   "imports": {
+    "@std/assert": "jsr:@std/assert@^1.0.1",
     "jsr:@denops/core": "./mod.ts"
   }
 }

errors.ts

@@ -0,0 +1,27 @@
+/**
+ * This module provides error classes for [denops.vim].
+ *
+ * [denops.vim]: https://github.com/vim-denops/denops.vim
+ *
+ * @module
+ */
+
+/**
+ * Batch error raised when one of the functions fails during batch process.
+ */
+export class BatchError extends Error {
+  static {
+    this.prototype.name = "BatchError";
+  }
+
+  /**
+   * A result list that is successfully completed prior to the error.
+   */
+  readonly results: unknown[];
+
+  constructor(message: string, results: unknown[]) {
+    super(message);
+
+    this.results = results;
+  }
+}

errors_test.ts

@@ -0,0 +1,42 @@
+import {
+  assert,
+  assertEquals,
+  assertInstanceOf,
+  assertMatch,
+} from "@std/assert";
+
+import { BatchError } from "./errors.ts";
+
+Deno.test("BatchError", async (t) => {
+  await t.step(".constructor()", async (t) => {
+    await t.step("constructs an instance", () => {
+      const actual = new BatchError("foo", ["bar", 1, true]);
+      assertInstanceOf(actual, BatchError);
+    });
+  });
+  await t.step(".name getter", async (t) => {
+    await t.step("returns 'BatchError'", () => {
+      const actual = new BatchError("foo", ["bar", 1, true]);
+      assertEquals(actual.name, "BatchError");
+    });
+  });
+  await t.step(".message getter", async (t) => {
+    await t.step("returns an error message", () => {
+      const actual = new BatchError("foo", ["bar", 1, true]);
+      assertEquals(actual.message, "foo");
+    });
+  });
+  await t.step(".stack getter", async (t) => {
+    await t.step("returns an error stack trace", () => {
+      const actual = new BatchError("foo", ["bar", 1, true]);
+      assert(actual.stack);
+      assertMatch(actual.stack, /\bat .*errors_test\.ts:\d+:\d+\n/);
+    });
+  });
+  await t.step(".results getter", async (t) => {
+    await t.step("returns a results array", () => {
+      const actual = new BatchError("foo", ["bar", 1, true]);
+      assertEquals(actual.results, ["bar", 1, true]);
+    });
+  });
+});

mod.ts

@@ -23,11 +23,5 @@
  * @module
  */
 
-export { BatchError } from "./denops.ts";
-export type {
-  Context,
-  Denops,
-  Dispatcher,
-  Entrypoint,
-  Meta,
-} from "./denops.ts";
+export * from "./errors.ts";
+export type * from "./types.ts";

denops.ts renamed to types.ts

@@ -1,3 +1,11 @@
+/**
+ * This module provides type interfaces for [denops.vim].
+ *
+ * [denops.vim]: https://github.com/vim-denops/denops.vim
+ *
+ * @module
+ */
+
 /**
  * API dispatcher
  */
@@ -34,27 +42,6 @@ export interface Meta {
   readonly platform: "windows" | "mac" | "linux";
 }
 
-/**
- * Batch error raised when one of the functions fails during batch process.
- */
-export class BatchError extends Error {
-  /**
-   * A result list that is successfully completed prior to the error.
-   */
-  readonly results: unknown[];
-
-  constructor(message: string, results: unknown[]) {
-    super(message);
-
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, BatchError);
-    }
-
-    this.name = this.constructor.name;
-    this.results = results;
-  }
-}
-
 /**
  * Denops is a facade instance visible from each denops plugin.
  */