@blocknote/core 0.9.6 → 0.10.0

package/src/api/exporters/markdown/__snapshots__/link/styled/markdown.md

@@ -0,0 +1 @@
+**[Web](https://www.website.com)**[site](https://www.website.com)

package/src/api/exporters/markdown/__snapshots__/mention/basic/markdown.md

@@ -0,0 +1 @@
+I enjoy working with @Matthew

package/src/api/exporters/markdown/__snapshots__/paragraph/basic/markdown.md

@@ -0,0 +1 @@
+Paragraph

package/src/api/exporters/markdown/__snapshots__/paragraph/nested/markdown.md

@@ -0,0 +1,5 @@
+Paragraph
+
+Nested Paragraph 1
+
+Nested Paragraph 2

package/src/api/exporters/markdown/__snapshots__/paragraph/styled/markdown.md

@@ -0,0 +1 @@
+Plain Red Text Blue Background Mixed Colors

package/src/api/exporters/markdown/__snapshots__/simpleCustomParagraph/basic/markdown.md

@@ -0,0 +1 @@
+Custom Paragraph

package/src/api/exporters/markdown/__snapshots__/simpleCustomParagraph/nested/markdown.md

@@ -0,0 +1,5 @@
+Custom Paragraph
+
+Nested Custom Paragraph 1
+
+Nested Custom Paragraph 2

package/src/api/exporters/markdown/__snapshots__/simpleCustomParagraph/styled/markdown.md

@@ -0,0 +1 @@
+Plain Red Text Blue Background Mixed Colors

package/src/api/exporters/markdown/__snapshots__/simpleImage/basic/markdown.md

@@ -0,0 +1 @@
+![placeholder](exampleURL)

package/src/api/exporters/markdown/__snapshots__/simpleImage/button/markdown.md

@@ -0,0 +1 @@
+![placeholder]()

package/src/api/exporters/markdown/__snapshots__/simpleImage/nested/markdown.md

@@ -0,0 +1,3 @@
+![placeholder](exampleURL)
+
+![placeholder](exampleURL)

package/src/api/exporters/markdown/__snapshots__/small/basic/markdown.md

@@ -0,0 +1 @@
+This is a small text

package/src/api/exporters/markdown/__snapshots__/tag/basic/markdown.md

@@ -0,0 +1 @@
+I love #BlockNote

package/src/api/exporters/markdown/markdownExporter.test.ts

@@ -0,0 +1,85 @@
+import fs from "node:fs";
+import path from "node:path";
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+import { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
+import { BlockSchema, PartialBlock } from "../../../schema/blocks/types";
+import { InlineContentSchema } from "../../../schema/inlineContent/types";
+import { StyleSchema } from "../../../schema/styles/types";
+import { partialBlocksToBlocksForTesting } from "../../testUtil/partialBlockTestUtil";
+import { customBlocksTestCases } from "../../testUtil/cases/customBlocks";
+import { customInlineContentTestCases } from "../../testUtil/cases/customInlineContent";
+import { customStylesTestCases } from "../../testUtil/cases/customStyles";
+import { defaultSchemaTestCases } from "../../testUtil/cases/defaultSchema";
+
+async function convertToMarkdownAndCompareSnapshots<
+  B extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<B, I, S>,
+  blocks: PartialBlock<B, I, S>[],
+  snapshotDirectory: string,
+  snapshotName: string
+) {
+  const fullBlocks = partialBlocksToBlocksForTesting(
+    editor.blockSchema,
+    blocks
+  );
+  const md = await editor.blocksToMarkdownLossy(fullBlocks);
+  const snapshotPath =
+    "./__snapshots__/" +
+    snapshotDirectory +
+    "/" +
+    snapshotName +
+    "/markdown.md";
+
+  // vitest empty snapshots are broken on CI. might be fixed on next vitest, use workaround for now
+  if (!md.length && process.env.CI) {
+    if (
+      fs.readFileSync(path.join(__dirname, snapshotPath), "utf8").length === 0
+    ) {
+      // both are empty, so it's fine
+      return;
+    }
+  }
+  expect(md).toMatchFileSnapshot(snapshotPath);
+}
+
+const testCases = [
+  defaultSchemaTestCases,
+  customBlocksTestCases,
+  customStylesTestCases,
+  customInlineContentTestCases,
+];
+
+describe("markdownExporter", () => {
+  for (const testCase of testCases) {
+    describe("Case: " + testCase.name, () => {
+      let editor: BlockNoteEditor<any, any, any>;
+
+      beforeEach(() => {
+        editor = testCase.createEditor();
+      });
+
+      afterEach(() => {
+        editor._tiptapEditor.destroy();
+        editor = undefined as any;
+
+        delete (window as Window & { __TEST_OPTIONS?: any }).__TEST_OPTIONS;
+      });
+
+      for (const document of testCase.documents) {
+        // eslint-disable-next-line no-loop-func
+        it("Convert " + document.name + " to HTML", async () => {
+          const nameSplit = document.name.split("/");
+          await convertToMarkdownAndCompareSnapshots(
+            editor,
+            document.blocks,
+            nameSplit[0],
+            nameSplit[1]
+          );
+        });
+      }
+    });
+  }
+});

package/src/api/exporters/markdown/markdownExporter.ts

@@ -0,0 +1,42 @@
+import { Schema } from "prosemirror-model";
+import rehypeParse from "rehype-parse";
+import rehypeRemark from "rehype-remark";
+import remarkGfm from "remark-gfm";
+import remarkStringify from "remark-stringify";
+import { unified } from "unified";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
+import {
+  Block,
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../schema";
+import { createExternalHTMLExporter } from "../html/externalHTMLExporter";
+import { removeUnderlines } from "./removeUnderlinesRehypePlugin";
+
+export function cleanHTMLToMarkdown(cleanHTMLString: string) {
+  const markdownString = unified()
+    .use(rehypeParse, { fragment: true })
+    .use(removeUnderlines)
+    .use(rehypeRemark)
+    .use(remarkGfm)
+    .use(remarkStringify)
+    .processSync(cleanHTMLString);
+
+  return markdownString.value as string;
+}
+
+export function blocksToMarkdown<
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  blocks: Block<BSchema, I, S>[],
+  schema: Schema,
+  editor: BlockNoteEditor<BSchema, I, S>
+): string {
+  const exporter = createExternalHTMLExporter(schema, editor);
+  const externalHTML = exporter.exportBlocks(blocks);
+
+  return cleanHTMLToMarkdown(externalHTML);
+}