Simplify labeling of plugins

Author: hatton

src/config/configuration.ts

@@ -1,10 +1,7 @@
 // an extension manager that uses cosmicconfig to get a list of plugin functions
 // and then runs them in sequence
 
-import {
-  ListBlockChildrenResponseResult,
-  ListBlockChildrenResponseResults,
-} from "notion-to-md/build/types";
+import { ListBlockChildrenResponseResult } from "notion-to-md/build/types";
 import * as Cosmic from "cosmiconfig";
 import { CosmiconfigResult } from "cosmiconfig/dist/types";
 import { NotionPage } from "../NotionPage";
@@ -27,7 +24,6 @@ export type IPlugin = {
   name: string;
   // operations on notion blocks before they are converted to markdown
   notionBlockModifications?: {
-    label: string;
     modify: (block: NotionBlock) => void;
   }[];
   // overrides for the default notion-to-markdown conversions
@@ -41,7 +37,6 @@ export type IPlugin = {
 
   // corrections to links after they are converted to markdown
   linkModifier?: {
-    label: string;
     match: RegExp; // does this plugin apply to this link?
     convert: linkConversionFunction;
   };
@@ -51,7 +46,6 @@ export type IPlugin = {
 };
 
 export type IRegexMarkdownModification = {
-  label: string;
   regex: RegExp;
   output: string;
   imports?: string[];
@@ -82,22 +76,12 @@ export type IDocuNotionContext = {
   relativeFilePathToFolderContainingPage: string;
   pages: NotionPage[];
   counts: ICounts;
-  // log: {
-  //   error(s: string): void;
-  //   warning(s: string): void;
-  //   info(s: string): void;
-  //   verbose(s: string): void;
-  //   debug(s: string): void;
-  // };
 };
 
-//let config: IDocuNotionConfig | undefined;
-
 // read the plugins from the config file
 // and add them to the map
 export function loadConfig(): IDocuNotionConfig {
   // return Cosmic.cosmiconfigSync("docunotion").search()
-  //   ?.config as IDocuNotionConfig;
 
   return defaultConfig;
 }

src/plugins/EscapeHtmlBlockModifier.ts

@@ -5,7 +5,6 @@ export const standardEscapeHtmlBlockModifier: IPlugin = {
 
   notionBlockModifications: [
     {
-      label: "standardEscapeHtmlBlockModifier",
       modify: (block: NotionBlock) => {
         escapeHtml(block);
       },

src/plugins/HeadingTransformer.ts

@@ -35,7 +35,6 @@ export const standardHeadingTransformer: IPlugin = {
   // result, to which we will append the block ID to enable heading links.
   notionBlockModifications: [
     {
-      label: "headingTransformer",
       modify: (block: NotionBlock) => {
         // "as any" needed because we're putting a value in that is not allowed by the real type
         (block as any).type = block.type.replace("heading", "DN_heading");

src/plugins/embedTweaks.ts

@@ -4,7 +4,6 @@ export const gifEmbed: IPlugin = {
   name: "gif",
   regexMarkdownModifications: [
     {
-      label: "gif",
       // I once saw a gif coming from Notion that wasn't a full
       // url, which wouldn't work, hence the "http" requirement
       regex: /\[.*\]\((http.*(\.(gif|GIF)))\)/gm,
@@ -17,7 +16,6 @@ export const imgurGifEmbed: IPlugin = {
   name: "imgur",
   regexMarkdownModifications: [
     {
-      label: "imgur",
       regex: /\[.*\]\((.*imgur\.com\/.*)\)/gm, // imgur.com
       // imgur links to gifs need a .gif at the end, but the url they give you doesn't have one.
       output: `![]($1.gif)`,
@@ -28,7 +26,6 @@ export const youtubeEmbed: IPlugin = {
   name: "youtube",
   regexMarkdownModifications: [
     {
-      label: "youtube",
       regex: /\[.*\]\((.*youtube\.com\/watch.*)\)/gm, //youtube.com/watch
       imports: [`import ReactPlayer from "react-player";`],
       output: `<ReactPlayer controls url="$1" />`,
@@ -39,7 +36,6 @@ export const vimeoEmbed: IPlugin = {
   name: "vimeo",
   regexMarkdownModifications: [
     {
-      label: "vimeo",
       regex: /\[.*\]\((https:\/\/.*vimeo.*)\)/gm,
       // we use to have the following, but the above should handle both the player an not-player urls.
       //regex: /\[.*\]\((.*player\.vimeo.*)\)/gm, // player.vimeo

src/plugins/externalLinks.ts

@@ -4,7 +4,6 @@ import { error, warning } from "../log";
 export const standardExternalLinkConversion: IPlugin = {
   name: "standard external link conversion",
   linkModifier: {
-    label: "standard external link conversion",
     match: /\[.*\]\(http.*\)/,
     convert: (context: IDocuNotionContext, markdownLink: string) => {
       const linkRegExp = /\[([^\]]+)?\]\((http.*)\)/;

src/plugins/internalLinks.ts

@@ -87,7 +87,6 @@ export function parseLinkId(fullLinkId: string): {
 export const standardInternalLinkConversion: IPlugin = {
   name: "standard internal link conversion",
   linkModifier: {
-    label: "standard internal link conversion",
     // from notion (or notion-md?) we get slightly different hrefs depending on whether the links is "inline"
     // (has some other text that's been turned into a link) or "raw".
     // Raw links come in without a leading slash, e.g. [link_to_page](4a6de8c0-b90b-444b-8a7b-d534d6ec71a4)

src/transform.ts

@@ -84,7 +84,12 @@ function doNotionBlockTransforms(
 function doTransformsOnMarkdown(config: IDocuNotionConfig, input: string) {
   const regexMods: IRegexMarkdownModification[] = config.plugins
     .filter(plugin => !!plugin.regexMarkdownModifications)
-    .map(plugin => plugin.regexMarkdownModifications!)
+    .map(plugin => {
+      const mods = plugin.regexMarkdownModifications!;
+      // stick the name of the plugin into each mode for logging
+      const modsWithNames = mods.map(m => ({ name: plugin.name, ...m }));
+      return modsWithNames;
+    })
     .flat();
 
   let body = input;
@@ -94,11 +99,13 @@ function doTransformsOnMarkdown(config: IDocuNotionConfig, input: string) {
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   regexMods.forEach(mod => {
-    //verbose(`Trying [${mod.label}]`);
+    //verbose(`Trying [${mod.name}]`);
     while ((match = mod.regex.exec(input)) !== null) {
       const string = match[0];
       const url = match[1];
-      verbose(`[${mod.label}] ${string} --> ${mod.output.replace("$1", url)}`);
+      verbose(
+        `[${(mod as any).name}] ${string} --> ${mod.output.replace("$1", url)}`
+      );
       body = body.replace(string, mod.output.replace("$1", url));
       // add any library imports
       mod.imports?.forEach(imp => imports.add(imp));