refactor: force all logging through the context-sensitive abstraction

Author: JohannesRudolph

src/DatabasePageRenderer.ts

@@ -4,7 +4,7 @@ import { Page } from '@notionhq/client/build/src/api-types';
 
 import { AssetWriter } from './AssetWriter';
 import { FrontmatterRenderer } from './FrontmatterRenderer';
-import { logger, RenderingLoggingContext } from './logger';
+import { RenderingLoggingContext } from './logger';
 import { PropertiesParser } from './PropertiesParser';
 import { RecursiveBodyRenderer } from './RecursiveBodyRenderer';
 import { RenderDatabasePageTask as RenderDatabasePageTask } from './RenderDatabasePageTask';
@@ -24,10 +24,6 @@ export class DatabasePageRenderer {
     page: Page,
     config: DatabaseConfigRenderPages
   ): Promise<RenderDatabasePageTask> {
-    if (page.archived) {
-      logger.warn(`rendering archived page ${page.url}`);
-    }
-
     const props = await this.propertiesParser.parsePageProperties(page, config);
 
     const categorySlug = slugify(props.meta.category);
@@ -47,15 +43,23 @@ export class DatabasePageRenderer {
       render: async () => {
         const context = new RenderingLoggingContext(page.url, file);
 
+        if (page.archived) {
+          context.warn(`page is arvhied`);
+        }
+
         try {
           const assetWriter = new AssetWriter(destDir);
 
           const frontmatter = this.frontmatterRenderer.renderFrontmatter(props);
-          const body = await this.bodyRenderer.renderBody(page, assetWriter, context);
-  
+          const body = await this.bodyRenderer.renderBody(
+            page,
+            assetWriter,
+            context
+          );
+
           await fs.mkdir(destDir, { recursive: true });
           await fs.writeFile(file, frontmatter + body);
-  
+
           context.complete();
         } catch (error) {
           // While catch-log-throw is usually an antipattern, it is the renderes job to orchestrate the rendering

src/DeferredRenderer.ts

@@ -4,7 +4,6 @@ import { ChildDatabaseRenderer } from './ChildDatabaseRenderer';
 import { Database } from './Database';
 import { DatabaseEntryRenderer } from './DatabaseEntryRenderer';
 import { DatabasePageRenderer } from './DatabasePageRenderer';
-import { logger } from './logger';
 import { RenderDatabaseEntryTask } from './RenderDatabaseEntryTask';
 import { RenderDatabasePageTask as RenderDatabasePageTask } from './RenderDatabasePageTask';
 import { RenderedDatabaseEntry } from './RenderedDatabaseEntry';
@@ -93,8 +92,6 @@ export class DeferredRenderer {
       const promises = batch.map((fn) => fn());
       await Promise.all(promises);
     }
-
-    logger.success("sync complete");
   }
 
   public getRenderedPages(): (RenderedDatabasePage | RenderedDatabaseEntry)[] {

src/logger.ts

@@ -5,14 +5,6 @@ const info = (...args: any[]): void => {
   console.log(chalk.cyan("info"), ...args);
 };
 
-const tip = (...args: any[]): void => {
-  console.log(chalk.blue("tip"), ...args);
-};
-
-const success = (...args: any[]): void => {
-  console.log(chalk.green("success"), ...args);
-};
-
 const warn = (...args: any[]): void => {
   console.warn(chalk.yellow("warning"), ...args);
 };
@@ -21,10 +13,8 @@ const error = (...args: any[]): void => {
   console.error(chalk.red("error"), ...args);
 };
 
-export const logger = {
+const logger = {
   info,
-  tip,
-  success,
   warn,
   error,
 };