feat: indicate errors, warnings, and debug for github actions

Author: hatton

src/MakeImagePersistencePlan.ts

@@ -1,6 +1,7 @@
 import { ImageSet } from "./images";
 import * as Path from "path";
 import { error } from "./log";
+import { exit } from "process";
 
 export function makeImagePersistencePlan(
   imageSet: ImageSet,
@@ -34,6 +35,7 @@ export function makeImagePersistencePlan(
       error(
         "imageOutputPath was declared, but one or more localizedUrls were found too. If you are going to localize screenshots, then you can't declare an imageOutputPath."
       );
+      exit(1);
     }
 
     imageSet.filePathToUseInMarkdown =
@@ -44,6 +46,7 @@ export function makeImagePersistencePlan(
     error(
       `Something wrong with the filetype extension on the blob we got from ${imageSet.primaryUrl}`
     );
+    exit(1);
   }
 }
 

src/NotionPage.ts

@@ -1,13 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
-import {
-  GetPageResponse,
-  ListBlockChildrenResponse,
-} from "@notionhq/client/build/src/api-endpoints";
-import { Client } from "@notionhq/client";
-import { logDebug } from "./log";
+import { GetPageResponse } from "@notionhq/client/build/src/api-endpoints";
 import { parseLinkId } from "./plugins/internalLinks";
-import { info } from "console";
 import { ListBlockChildrenResponseResults } from "notion-to-md/build/types";
 
 // Notion has 2 kinds of pages: a normal one which is just content, and what I'm calling a "database page", which has whatever properties you put on it.

src/config/configuration.ts

@@ -3,6 +3,7 @@ import defaultConfig from "./default.docunotion.config";
 import { error, verbose } from "../log";
 import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
 import { IPlugin } from "../plugins/pluginTypes";
+import { exit } from "process";
 
 export type IDocuNotionConfig = {
   plugins: IPlugin[];
@@ -47,6 +48,7 @@ export async function loadConfigAsync(): Promise<IDocuNotionConfig> {
     };
   } catch (e: any) {
     error(e.message);
+    exit(1);
   }
   verbose(`Active plugins: [${config.plugins.map(p => p.name).join(", ")}]`);
   return config;

src/log.ts

@@ -1,15 +1,15 @@
 import chalk from "chalk";
-
+chalk;
 type levels = "info" | "verbose" | "debug";
 let logLevel: levels;
 export function setLogLevel(l: levels): void {
   logLevel = l;
 }
 export function error(s: string): void {
-  console.error(chalk.red(s));
+  console.error(chalk.red(wrapForCI(s, "error")));
 }
 export function warning(s: string): void {
-  console.log(chalk.hex("#FFA500")(s));
+  console.log(chalk.hex("#FFA500")(wrapForCI(s, "warning")));
 }
 export function info(s: string): void {
   console.log(s);
@@ -23,7 +23,14 @@ export function verbose(s: string): void {
 }
 export function logDebug(label: string, info: string): void {
   if (logLevel === "debug") {
-    console.log(chalk.dim("[" + label + "]"));
-    console.log(chalk.dim(info));
+    console.log(chalk.dim(wrapForCI(`[${label}]`, "debug")));
+    console.log(chalk.dim(wrapForCI(info, "debug")));
   }
 }
+
+function wrapForCI(s: string, githubActionsPrefix: string): string {
+  // for now, we only know about github actions, but submit a PR if you want to add more
+  return process.env["GITHUB_ACTIONS"] === "true"
+    ? `::${githubActionsPrefix}::${s}`
+    : s;
+}

src/plugins/internalLinks.ts

@@ -1,5 +1,5 @@
 import { IDocuNotionContext, IPlugin } from "./pluginTypes";
-import { error } from "../log";
+import { error, warning } from "../log";
 import { NotionPage } from "../NotionPage";
 
 function convertInternalLink(
@@ -9,7 +9,7 @@ function convertInternalLink(
   const linkRegExp = /\[([^\]]+)?\]\(\/?([^),^/]+)\)/g;
   const match = linkRegExp.exec(markdownLink);
   if (match === null) {
-    error(
+    warning(
       `[standardInternalLinkConversion] Could not parse link ${markdownLink}`
     );
     return markdownLink;
@@ -30,7 +30,7 @@ function convertInternalLink(
 
   if (!targetPage) {
     // About this situation. See https://github.com/sillsdev/docu-notion/issues/9
-    error(
+    warning(
       `[standardInternalLinkConversion] Could not find the target of this link. Note that links to outline sections are not supported. ${markdownLink}. https://github.com/sillsdev/docu-notion/issues/9`
     );
     return "**[Problem Internal Link]**";

src/pull.ts

@@ -253,7 +253,7 @@ async function getPageMetadata(id: string): Promise<GetPageResponse> {
 
 async function rateLimit() {
   if (notionLimiter.getTokensRemaining() < 1) {
-    logDebug("", "*** delaying for rate limit");
+    logDebug("rateLimit", "*** delaying for rate limit");
   }
   await notionLimiter.removeTokens(1);
 }

src/transform.ts

@@ -3,7 +3,7 @@ import {
   IDocuNotionContext,
   IRegexMarkdownModification,
 } from "./plugins/pluginTypes";
-import { info, logDebug, verbose } from "./log";
+import { error, info, logDebug, verbose, warning } from "./log";
 import { NotionPage } from "./NotionPage";
 import { IDocuNotionConfig } from "./config/configuration";
 import { NotionBlock } from "./types";
@@ -136,7 +136,7 @@ async function doTransformsOnMarkdown(
       }
     }
   }
-  console.log("body after regex: " + body);
+  logDebug("doTransformsOnMarkdown", "body after regex: " + body);
   const uniqueImports = [...new Set(imports)];
   return { body, imports: [...uniqueImports].join("\n") };
 }