Changes after review

Author: hatton

.gitignore

@@ -5,3 +5,4 @@ i18n/
 node_modules/
 version.json
 docs/
+yarn-error.log

docu-notion.config.ts

@@ -1,17 +1,19 @@
-import {
-  IDocuNotionConfig,
-  IPlugin,
-  NotionBlock,
-} from "./dist/config/configuration";
-import { verbose } from "./dist/log";
+/* This file is only used when testing docu-notion itself, not when it is used as a library.
+  E.g., if you run `yarn pull-test-tagged`, docu-notion will read this file and use it to configure itself,
+  using these example plugins.
+ */
+
+import { IDocuNotionConfig } from "./dist/config/configuration";
+import { IPlugin, Log } from "./dist";
+import { NotionBlock } from "./dist/types";
 
 const dummyBlockModifier: IPlugin = {
   name: "dummyBlockModifier",
 
   notionBlockModifications: [
     {
       modify: (block: NotionBlock) => {
-        verbose("dummyBlockModifier was called");
+        Log.verbose("dummyBlockModifier was called");
       },
     },
   ],

src/NotionPage.ts

@@ -26,24 +26,6 @@ export class NotionPage {
   public layoutContext: string; // where we found it in the hierarchy of the outline
   public foundDirectlyInOutline: boolean; // the page was found as a descendent of /outline instead of being linked to
 
-  // public constructor(
-  //   layoutContext: string,
-  //   pageId: string,
-  //   order: number,
-  //   metadata: GetPageResponse,
-  //   foundDirectlyInOutline: boolean
-  // ) {
-  //   this.layoutContext = layoutContext;
-  //   this.pageId = pageId;
-  //   this.order = order;
-  //   this.metadata = metadata;
-  //   this.foundDirectlyInOutline = foundDirectlyInOutline;
-
-  //   // review: this is expensive to learn as it takes another api call... I
-  //   // think? We can tell if it's a database because it has a "Name" instead of a
-  //   // "tile" and "parent": "type": "database_id". But do we need to differentiate
-  //   //this.type = PageType.Unknown;
-  // }
   public constructor(args: {
     layoutContext: string;
     pageId: string;

src/config/configuration.ts

@@ -2,7 +2,11 @@ import * as Cosmic from "cosmiconfig";
 import defaultConfig from "./default.docunotion.config";
 import { error, verbose } from "../log";
 import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
-import { IDocuNotionConfig, IPlugin } from "../plugins/pluginTypes";
+import { IPlugin } from "../plugins/pluginTypes";
+
+export type IDocuNotionConfig = {
+  plugins: IPlugin[];
+};
 
 // read the plugins from the config file
 // and add them to the map

src/config/default.docunotion.config.ts

@@ -13,8 +13,8 @@ import { standardEscapeHtmlBlockModifier } from "../plugins/EscapeHtmlBlockModif
 import { standardHeadingTransformer } from "../plugins/HeadingTransformer";
 import { standardNumberedListTransformer } from "../plugins/NumberedListTransformer";
 import { standardTableTransformer } from "../plugins/TableTransformer";
-import { IDocuNotionConfig } from "../plugins/pluginTypes";
 import { standardExternalLinkConversion } from "../plugins/externalLinks";
+import { IDocuNotionConfig } from "./configuration";
 
 const defaultConfig: IDocuNotionConfig = {
   plugins: [

src/index.ts

@@ -7,4 +7,5 @@ run();
 // for plugins to import
 
 export * as Log from "./log";
+export * from "./types";
 export * from "./plugins/pluginTypes";

src/plugins/CalloutTransformer.spec.ts

@@ -1,6 +1,6 @@
-import { NotionBlock } from "./pluginTypes";
+import { NotionBlock } from "../types";
 import { NotionPage } from "../NotionPage";
-import { blocksToMarkdown, makeSamplePageObject } from "../TestRun";
+import { blocksToMarkdown, makeSamplePageObject } from "./pluginTestRun";
 import { standardCalloutTransformer } from "./CalloutTransformer";
 import { standardExternalLinkConversion } from "./externalLinks";
 import { standardInternalLinkConversion } from "./internalLinks";

src/plugins/CalloutTransformer.ts

@@ -1,11 +1,6 @@
 import { NotionToMarkdown } from "notion-to-md";
-import {
-  ListBlockChildrenResponseResult,
-  ListBlockChildrenResponseResults,
-} from "notion-to-md/build/types";
-// import { Client } from "@notionhq/client";
-// import { getBlockChildren } from "./CustomTransformers";
-import { IPlugin, NotionBlock } from "./pluginTypes";
+import { NotionBlock } from "../types";
+import { IPlugin } from "./pluginTypes";
 
 // In Notion, you can make a callout and change its emoji. We map 5 of these
 // to the 5 Docusaurus admonition styles.
@@ -14,7 +9,7 @@ import { IPlugin, NotionBlock } from "./pluginTypes";
 // 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(
+async function notionCalloutToAdmonition(
   notionToMarkdown: NotionToMarkdown,
   getBlockChildren: (id: string) => Promise<NotionBlock[]>,
   block: NotionBlock

src/plugins/ColumnListTransformer.ts

@@ -1,7 +1,8 @@
 import { NotionToMarkdown } from "notion-to-md";
-import { IPlugin, NotionBlock } from "./pluginTypes";
+import { NotionBlock } from "../types";
+import { IPlugin } from "./pluginTypes";
 
-export async function notionColumnListToMarkdown(
+async function notionColumnListToMarkdown(
   notionToMarkdown: NotionToMarkdown,
   getBlockChildren: (id: string) => Promise<NotionBlock[]>,
   block: NotionBlock

src/plugins/ColumnTransformer.ts

@@ -19,7 +19,7 @@ export const standardColumnTransformer: IPlugin = {
 };
 
 // This runs when notion-to-md encounters a column block
-export async function notionColumnToMarkdown(
+async function notionColumnToMarkdown(
   notionToMarkdown: NotionToMarkdown,
   getBlockChildren: IGetBlockChildrenFn,
   block: ListBlockChildrenResponseResult