Merge pull request #25 from sillsdev/RefactorTransformers

Refactor transformers

Author: andrew-polk

src/CustomTranformers.ts

@@ -11,7 +11,7 @@ import {
 } from "./images";
 
 import { tweakForDocusaurus } from "./DocusaurusTweaks";
-import { setupCustomTransformers } from "./CustomTranformers";
+import { setupCustomTransformers } from "./transformers/CustomTransformers";
 import * as Path from "path";
 import { error, heading, info, logDebug, verbose, warning } from "./log";
 import { convertInternalLinks } from "./links";
@@ -235,7 +235,7 @@ async function outputPage(page: NotionPage) {
   );
 
   // One half of a horrible hack to make heading links work.
-  // See the other half and explanation in CustomTransformers.ts => headingCustomTransformer.
+  // See the other half and explanation in HeadingTransformer.ts.
   for (const block_t of blocks) {
     const block = block_t as any;
     if (block.type.startsWith("heading"))

src/pull.ts

@@ -1,8 +1,15 @@
 import { NotionToMarkdown } from "notion-to-md";
 import { ListBlockChildrenResponseResult } from "notion-to-md/build/types";
 import { Client } from "@notionhq/client";
-import { getBlockChildren } from "./CustomTranformers";
+import { getBlockChildren } from "./CustomTransformers";
 
+// In Notion, you can make a callout and change its emoji. We map 5 of these
+// to the 5 Docusaurus admonition styles.
+// This is mostly a copy of the callout code from notion-to-md. The change is to output docusaurus
+// admonitions instead of emulating a callout with markdown > syntax.
+// Note: I haven't yet tested this with any emoji except "💡"/"tip", nor the case where the
+// callout has-children. Not even sure what that would mean, since the document I was testing
+// with has quite complex markup inside the callout, but still takes the no-children branch.
 export async function notionCalloutToAdmonition(
   notionToMarkdown: NotionToMarkdown,
   notionClient: Client,

src/CalloutTransformer.ts src/transformers/CalloutTransformer.tssrc/CalloutTransformer.ts renamed to src/transformers/CalloutTransformer.ts

@@ -0,0 +1,26 @@
+import { Client } from "@notionhq/client";
+import { NotionToMarkdown } from "notion-to-md";
+import { ListBlockChildrenResponseResult } from "notion-to-md/build/types";
+import { getBlockChildren } from "./CustomTransformers";
+
+export async function notionColumnListToMarkdown(
+  notionToMarkdown: NotionToMarkdown,
+  notionClient: Client,
+  block: ListBlockChildrenResponseResult
+): Promise<string> {
+  // Enhance: The @notionhq/client, which uses the official API, cannot yet get at column formatting information (column_ratio)
+  // However https://github1s.com/NotionX/react-notion-x/blob/master/packages/react-notion-x/src/block.tsx#L528 can get it.
+  const { id, has_children } = block as any; // "any" because the notion api type system is complex with a union that don't know how to help TS to cope with
+
+  if (!has_children) return "";
+
+  const column_list_children = await getBlockChildren(notionClient, id, 100);
+
+  const column_list_promise = column_list_children.map(
+    async column => await notionToMarkdown.blockToMarkdown(column)
+  );
+
+  const columns: string[] = await Promise.all(column_list_promise);
+
+  return `<div class='notion-row'>\n${columns.join("\n\n")}\n</div>`;
+}

src/transformers/ColumnListTransformer.ts

@@ -0,0 +1,29 @@
+import { Client } from "@notionhq/client";
+import { NotionToMarkdown } from "notion-to-md";
+import { ListBlockChildrenResponseResult } from "notion-to-md/build/types";
+import { getBlockChildren } from "./CustomTransformers";
+
+export async function notionColumnToMarkdown(
+  notionToMarkdown: NotionToMarkdown,
+  notionClient: Client,
+  block: ListBlockChildrenResponseResult
+): Promise<string> {
+  //console.log(JSON.stringify(block));
+  const { id, has_children } = block as any; // "any" because the notion api type system is complex with a union that don't know how to help TS to cope with
+
+  if (!has_children) return "";
+
+  const children = await getBlockChildren(notionClient, id, 100);
+
+  const childrenPromise = children.map(
+    async column => await notionToMarkdown.blockToMarkdown(column)
+  );
+
+  const childrenStrings: string[] = await Promise.all(childrenPromise);
+
+  // note: it would look better in the markup with \n, but that
+  // causes notion-to-md to give us ":::A" instead of \n for some reason.
+  return `<div class='notion-column'>\n\n${childrenStrings.join(
+    "\n\n"
+  )}\n\n</div>`;
+}