reorg a bit

Author: hatton

docu-notion.config.ts

@@ -17,32 +17,19 @@ const dummyBlockModifier: IPlugin = {
   ],
 };
 
-const dummyBlockModifier2: IPlugin = {
-  name: "dummyBlockModifier2",
+const dummyMarkdownModifier: IPlugin = {
+  name: "dummyMarkdownModifier",
 
-  notionBlockModifications: [
+  regexMarkdownModifications: [
     {
-      modify: (block: NotionBlock) => {
-        verbose("dummyBlockModifier2 was called");
-      },
+      regex: /aaa(.*)aaa/,
+      replacementPattern: "bbb$1bbb",
     },
   ],
 };
 
-const dummyBlockModifier2Plugin: IPlugin = {
-  name: "dummyBlockModifier2Plugin",
-
-  init: (p: IPlugin): Promise<void> => {
-    return new Promise((resolve, reject) => {
-      verbose("****dummyBlockModifier2Plugin init was called");
-      p.notionBlockModifications = dummyBlockModifier2.notionBlockModifications;
-      resolve();
-    });
-  },
-};
-
 const config: IDocuNotionConfig = {
-  plugins: [dummyBlockModifier, dummyBlockModifier2Plugin],
+  plugins: [dummyBlockModifier, dummyMarkdownModifier],
 };
 
 export default config;

src/TestRun.ts

@@ -6,7 +6,7 @@ import {
   IDocuNotionConfig,
   IDocuNotionContext,
   NotionBlock,
-} from "./config/configuration";
+} from "./plugins/pluginTypes";
 import { HierarchicalNamedLayoutStrategy } from "./HierarchicalNamedLayoutStrategy";
 import { error, logDebug, verbose, warning } from "./log";
 import { NotionPage } from "./NotionPage";

src/config/configuration.ts

@@ -1,93 +1,8 @@
-// an extension manager that uses cosmicconfig to get a list of plugin functions
-// and then runs them in sequence
-
-import { ListBlockChildrenResponseResult } from "notion-to-md/build/types";
 import * as Cosmic from "cosmiconfig";
-import { NotionPage } from "../NotionPage";
-import { NotionToMarkdown } from "notion-to-md";
-import { BlockObjectResponse } from "@notionhq/client/build/src/api-endpoints";
-import { DocuNotionOptions } from "../pull";
-import { LayoutStrategy } from "../LayoutStrategy";
 import defaultConfig from "./default.docunotion.config";
-import { error, info, logDebug, verbose } from "../log";
+import { error, verbose } from "../log";
 import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
-
-// wrap this into something with a bit better name than the raw thing
-export type NotionBlock = BlockObjectResponse;
-
-type linkConversionFunction = (
-  context: IDocuNotionContext,
-  markdownLink: string
-) => string;
-
-export type IPlugin = {
-  // this is just for display when debugging
-  name: string;
-  // operations on notion blocks before they are converted to markdown
-  notionBlockModifications?: {
-    modify: (block: NotionBlock) => void;
-  }[];
-  // overrides for the default notion-to-markdown conversions
-  notionToMarkdownTransforms?: {
-    type: string;
-    getStringFromBlock: (
-      context: IDocuNotionContext,
-      block: NotionBlock
-    ) => string | Promise<string>;
-  }[];
-
-  // corrections to links after they are converted to markdown
-  linkModifier?: {
-    match: RegExp; // does this plugin apply to this link?
-    convert: linkConversionFunction;
-  };
-
-  // simple regex replacements on the markdown output
-  regexMarkdownModifications?: IRegexMarkdownModification[];
-
-  // Allow a plugin to perform an async operation at the start of docu-notion.
-  // Notice that the plugin itself is given, so you can add things to it.
-  init?(plugin: IPlugin): Promise<void>;
-};
-
-export type IRegexMarkdownModification = {
-  // Should match on markdown that you want to replace
-  regex: RegExp;
-  // Based on that regex, the outputPattern will be used to replace the matched text
-  replacementPattern?: string;
-  // Instead of a pattern, you can use this if you have to ask a server somewhere for help in getting the new markdown
-  getReplacement?(s: string): Promise<string>;
-
-  // If the output is creating things like react elements, you can import their definitions here
-  imports?: string[];
-};
-
-export type IDocuNotionConfig = {
-  plugins: IPlugin[];
-};
-export type ICustomNotionToMarkdownConversion = (
-  block: ListBlockChildrenResponseResult,
-  context: IDocuNotionContext
-) => () => Promise<string>;
-
-export type ICounts = {
-  output_normally: number;
-  skipped_because_empty: number;
-  skipped_because_status: number;
-  skipped_because_level_cannot_have_content: number;
-};
-export type IGetBlockChildrenFn = (id: string) => Promise<NotionBlock[]>;
-
-export type IDocuNotionContext = {
-  layoutStrategy: LayoutStrategy;
-  options: DocuNotionOptions;
-  getBlockChildren: IGetBlockChildrenFn;
-  notionToMarkdown: NotionToMarkdown;
-  directoryContainingMarkdown: string;
-  relativeFilePathToFolderContainingPage: string;
-  pages: NotionPage[];
-  counts: ICounts;
-};
+import { IDocuNotionConfig, IPlugin } from "../plugins/pluginTypes";
 
 // read the plugins from the config file
 // and add them to the map
@@ -132,19 +47,3 @@ export async function loadConfigAsync(): Promise<IDocuNotionConfig> {
   verbose(`Active plugins: [${config.plugins.map(p => p.name).join(", ")}]`);
   return config;
 }
-
-// export function getMDConversions(): Array<{
-//   type: string;
-//   transformer: ICustomNotionToMarkdownConversion;
-// }> {
-//   if (!config || !config.plugins) {
-//     return [];
-//   }
-//   // for each plugin that has a markdownConversion property, return the array of conversions
-//   return config.plugins.reduce((acc, plugin) => {
-//     if (plugin.notionToMarkdownTransforms) {
-//       acc.push(...plugin.notionToMarkdownTransforms);
-//     }
-//     return acc;
-//   }, [] as Array<{ type: string; transformer: ICustomNotionToMarkdownConversion }>);
-// }

src/config/default.docunotion.config.ts

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

src/images.ts

@@ -5,7 +5,7 @@ import * as Path from "path";
 import { makeImagePersistencePlan } from "./MakeImagePersistencePlan";
 import { warning, logDebug, verbose, info } from "./log";
 import { ListBlockChildrenResponseResult } from "notion-to-md/build/types";
-import { IDocuNotionContext, IPlugin } from "./config/configuration";
+import { IDocuNotionContext, IPlugin } from "./plugins/pluginTypes";
 
 // We several things here:
 // 1) copy images locally instead of leaving them in Notion

src/index.ts

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

src/plugins/CalloutTransformer.spec.ts

@@ -1,4 +1,4 @@
-import { NotionBlock } from "../config/configuration";
+import { NotionBlock } from "./pluginTypes";
 import { NotionPage } from "../NotionPage";
 import { blocksToMarkdown, makeSamplePageObject } from "../TestRun";
 import { standardCalloutTransformer } from "./CalloutTransformer";

src/plugins/CalloutTransformer.ts

@@ -5,7 +5,7 @@ import {
 } from "notion-to-md/build/types";
 // import { Client } from "@notionhq/client";
 // import { getBlockChildren } from "./CustomTransformers";
-import { IPlugin, NotionBlock } from "../config/configuration";
+import { IPlugin, NotionBlock } from "./pluginTypes";
 
 // In Notion, you can make a callout and change its emoji. We map 5 of these
 // to the 5 Docusaurus admonition styles.

src/plugins/ColumnListTransformer.ts

@@ -1,5 +1,5 @@
 import { NotionToMarkdown } from "notion-to-md";
-import { IPlugin, NotionBlock } from "../config/configuration";
+import { IPlugin, NotionBlock } from "./pluginTypes";
 
 export async function notionColumnListToMarkdown(
   notionToMarkdown: NotionToMarkdown,

src/plugins/ColumnTransformer.ts

@@ -1,7 +1,7 @@
 import { NotionAPI } from "notion-client";
 import { NotionToMarkdown } from "notion-to-md";
 import { ListBlockChildrenResponseResult } from "notion-to-md/build/types";
-import { IGetBlockChildrenFn, IPlugin } from "../config/configuration";
+import { IGetBlockChildrenFn, IPlugin } from "./pluginTypes";
 
 export const standardColumnTransformer: IPlugin = {
   name: "standardColumnTransformer",