@lowlighter/markdown 1.0.0 → 1.2.0

package/renderer.ts

@@ -32,9 +32,13 @@ export class Renderer {
    * @example
    * ```ts
    * import { Renderer } from "./renderer.ts"
-   * import pluginGfm from "./plugins/gfm.ts"
-   *
-   * const renderer = new Renderer({ plugins: [ pluginGfm ] })
+   * await Renderer.render("# Hello, world!")
+   * ```
+   * @example
+   * ```ts
+   * import { Renderer } from "./renderer.ts"
+   * import { gfm, highlighting, math, markers, wikilinks, sanitize  } from "./plugins/mod.ts"
+   * const renderer = new Renderer({ plugins: [ gfm, highlighting, math, markers, wikilinks, sanitize ] })
    * await renderer.render("# Hello, world!")
    * ```
    */
@@ -103,9 +107,19 @@ export class Renderer {
    * await renderer.render("# foo")
    * ```
    */
-  static async with({ plugins = [] }: { plugins: Array<Plugin | URL | string> }): Promise<Renderer> {
+  static async with({ plugins = [], throw: throws = true }: { plugins: Array<Plugin | URL | string>; throw?: boolean }): Promise<Renderer> {
     plugins = plugins.map((plugin) => plugin instanceof URL ? plugin.href : plugin)
-    const resolved = await Promise.all(plugins.map((plugin) => (typeof plugin === "string") ? import(plugin) : plugin))
+    const imported = await Promise.allSettled(plugins.map((plugin) => (typeof plugin === "string") ? import(plugin) : plugin))
+    const resolved = imported
+      .filter((result): result is PromiseFulfilledResult<Plugin> => result.status === "fulfilled")
+      .map(({ value }) => value)
+    if (throws && (imported.some(({ status }) => status === "rejected"))) {
+      const errors = imported
+        .filter((result): result is PromiseRejectedResult => result.status === "rejected")
+        .map(({ reason }) => reason)
+        .join(", ")
+      throw new ReferenceError(`Failed to import some plugins: ${errors}`)
+    }
     return new Renderer({ plugins: resolved })
   }
 }

package/renderer_test.ts

@@ -12,3 +12,8 @@ test("deno")("Renderer.with() instantiates a new customized renderer", async ()
   const markdown = await Renderer.with({ plugins: ["./plugins/gfm.ts", new URL("./plugins/gfm.ts", import.meta.url), pluginGfm] })
   await expect(markdown.render("# foo")).resolves.toBe("<h1>foo</h1>")
 })
+
+test("deno")("Renderer.with() honors throw option when creating a new customized renderer", async () => {
+  await expect(Renderer.with({ plugins: ["unknown"], throw: false })).resolves.toBeInstanceOf(Renderer)
+  await expect(Renderer.with({ plugins: ["unknown"], throw: true })).rejects.toThrow(ReferenceError)
+})