feat(log): configurable logging verbosity; fixes #134

Author: singerla

README.md

@@ -175,6 +175,10 @@ const automizer = new Automizer({
 
   // use a callback function to track pptx generation process.
   // statusTracker: myStatusTracker,
+  
+  // Use 1 to show warnings or 2 for detailed information
+  // 0 disables logging
+  verbosity: 1
 });
 
 // Now we can start and load a pptx template.

__tests__/add-slide-master.test.ts

@@ -5,6 +5,7 @@ test('Append and modify slideMastes and use slideLayouts', async () => {
   const automizer = new Automizer({
     templateDir: `${__dirname}/pptx-templates`,
     outputDir: `${__dirname}/pptx-output`,
+    verbosity: 2,
   });
 
   const pres = await automizer

src/automizer.ts

@@ -13,7 +13,7 @@ import { PresTemplate } from './interfaces/pres-template';
 import { RootPresTemplate } from './interfaces/root-pres-template';
 import { Template } from './classes/template';
 import { ModifyXmlCallback, TemplateInfo } from './types/xml-types';
-import { GeneralHelper, vd } from './helper/general-helper';
+import { GeneralHelper, log, Logger } from './helper/general-helper';
 import { Master } from './classes/master';
 import path from 'path';
 import * as fs from 'fs';
@@ -112,11 +112,15 @@ export default class Automizer implements IPresentationProps {
         this.templates.push(newTemplate);
       });
     }
+
+    if (params.verbosity) {
+      Logger.verbosity = params.verbosity;
+    }
   }
 
   setStatusTracker(statusTracker: StatusTracker['next']): void {
     const defaultStatusTracker = (status: StatusTracker) => {
-      console.log(status.info + ' (' + status.share + '%)');
+      log(status.info + ' (' + status.share + '%)', 2);
     };
 
     this.status = {
@@ -570,13 +574,13 @@ export default class Automizer implements IPresentationProps {
           return this.templateFallbackDir + location;
         } else {
           if (typeof location === 'string') {
-            vd('No file matches "' + location + '"');
+            log('No file matches "' + location + '"', 0);
           } else {
-            vd('Invalid filename');
+            log('Invalid filename', 0);
           }
 
-          vd('@templateDir: ' + this.templateDir);
-          vd('@templateFallbackDir: ' + this.templateFallbackDir);
+          log('@templateDir: ' + this.templateDir, 2);
+          log('@templateFallbackDir: ' + this.templateFallbackDir, 2);
         }
         break;
       case 'output':

src/classes/layout.ts

@@ -4,15 +4,10 @@ import { ShapeTargetType, SourceIdentifier, Target } from '../types/types';
 import { IPresentationProps } from '../interfaces/ipresentation-props';
 import { PresTemplate } from '../interfaces/pres-template';
 import { RootPresTemplate } from '../interfaces/root-pres-template';
-import { HelperElement } from '../types/xml-types';
-import IArchive from '../interfaces/iarchive';
-import { IMaster } from '../interfaces/imaster';
 import { XmlRelationshipHelper } from '../helper/xml-relationship-helper';
 import HasShapes from './has-shapes';
 import { ILayout } from '../interfaces/ilayout';
-import { Chart } from '../shapes/chart';
-import { Image } from '../shapes/image';
-import { vd } from '../helper/general-helper';
+import { log } from '../helper/general-helper';
 
 export class Layout extends HasShapes implements ILayout {
   targetType: ShapeTargetType = 'slideLayout';
@@ -48,7 +43,7 @@ export class Layout extends HasShapes implements ILayout {
     this.targetRelsPath = `ppt/slideLayouts/_rels/slideLayout${this.targetNumber}.xml.rels`;
     this.sourceArchive = await this.sourceTemplate.archive;
 
-    console.log('Importing slideLayout ' + this.targetNumber);
+    log('Importing slideLayout ' + this.targetNumber, 2);
 
     await this.copySlideLayoutFiles();
     await this.copyRelatedContent();

src/classes/master.ts

@@ -1,20 +1,16 @@
 import { FileHelper } from '../helper/file-helper';
 import { XmlHelper } from '../helper/xml-helper';
-import {
-  ShapeTargetType,
-  SlideModificationCallback,
-  SourceIdentifier,
-  Target,
-} from '../types/types';
+import { ShapeTargetType, SourceIdentifier, Target } from '../types/types';
 import { IPresentationProps } from '../interfaces/ipresentation-props';
 import { PresTemplate } from '../interfaces/pres-template';
 import { RootPresTemplate } from '../interfaces/root-pres-template';
-import { HelperElement, XmlElement } from '../types/xml-types';
+import { XmlElement } from '../types/xml-types';
 import IArchive from '../interfaces/iarchive';
 import { IMaster } from '../interfaces/imaster';
 import { XmlRelationshipHelper } from '../helper/xml-relationship-helper';
 import HasShapes from './has-shapes';
 import { Layout } from './layout';
+import { log } from '../helper/general-helper';
 
 export class Master extends HasShapes implements IMaster {
   targetType: ShapeTargetType = 'slideMaster';
@@ -60,7 +56,7 @@ export class Master extends HasShapes implements IMaster {
     this.targetRelsPath = `ppt/slideMasters/_rels/slideMaster${this.targetNumber}.xml.rels`;
     this.sourceArchive = await this.sourceTemplate.archive;
 
-    console.log('Importing slideMaster ' + this.targetNumber);
+    log('Importing slideMaster ' + this.targetNumber, 2);
 
     await this.copySlideMasterFiles();
     await this.copyRelatedLayouts();

src/helper/general-helper.ts

@@ -26,3 +26,42 @@ export const vd = (v: any, keys?: boolean): void => {
 };
 
 export const last = <T>(arr: T[]): T => arr[arr.length - 1];
+
+export interface Logger {
+  verbosity: 0 | 1 | 2;
+  target: 'console' | 'file';
+  log: (
+    message: string,
+    verbosity: Logger['verbosity'],
+    showStack?: boolean,
+    target?: Logger['target'],
+  ) => void;
+}
+
+export const Logger = <Logger>{
+  verbosity: 1,
+  target: 'console',
+  log: (message, verbosity, showStack?, target?) => {
+    if (verbosity > Logger.verbosity) {
+      return;
+    }
+    target = target || Logger.target;
+    if (target === 'console') {
+      if (showStack) {
+        vd(message);
+      } else {
+        console.log(message);
+      }
+    } else {
+      // TODO: append message to a logfile
+    }
+  },
+};
+
+export const log = (message: string, verbosity: Logger['verbosity']) => {
+  Logger.log(message, verbosity);
+};
+
+export const logDebug = (message: string, verbosity: Logger['verbosity']) => {
+  Logger.log(message, verbosity, true);
+};

src/helper/xml-helper.ts

@@ -11,14 +11,13 @@ import {
 import { TargetByRelIdMap } from '../constants/constants';
 import { XmlPrettyPrint } from './xml-pretty-print';
 import { GetRelationshipsCallback, Target } from '../types/types';
-import { vd } from './general-helper';
+import { log } from './general-helper';
 import { contentTracker } from './content-tracker';
 import IArchive from '../interfaces/iarchive';
 import {
   ContentTypeExtension,
   ContentTypeMap,
 } from '../enums/content-type-map';
-import XmlElements from './xml-elements';
 
 export class XmlHelper {
   static async modifyXmlInArchive(
@@ -166,7 +165,9 @@ export class XmlHelper {
   }
 
   static async getRelationshipTargetsByPrefix(
-archive: IArchive, path: string, prefix: string | string[]
+    archive: IArchive,
+    path: string,
+    prefix: string | string[],
   ): Promise<Target[]> {
     const prefixes = typeof prefix === 'string' ? [prefix] : prefix;
     return XmlHelper.getRelationshipItems(
@@ -573,7 +574,7 @@ archive: IArchive, path: string, prefix: string | string[]
     const parent = collection[0].parentNode;
     order.forEach((index, i) => {
       if (!collection[index]) {
-        vd('sortCollection index not found' + index);
+        log('sortCollection index not found' + index, 1);
         return;
       }
 

src/types/types.ts

@@ -10,6 +10,7 @@ import {
 import IArchive, { ArchiveMode } from '../interfaces/iarchive';
 import { ContentTypeExtension } from '../enums/content-type-map';
 import PptxGenJS from 'pptxgenjs';
+import { Logger } from '../helper/general-helper';
 
 export type ShapeTargetType = 'slide' | 'slideMaster' | 'slideLayout';
 export type SourceIdentifier = number | string;
@@ -109,6 +110,13 @@ export type AutomizerParams = {
    * You can e.g. attach a custom callback to a progress bar.
    */
   statusTracker?: StatusTracker['next'];
+  /**
+   * Set logging verbosity.
+   * 0: no logging at all
+   * 1: show warnings
+   * 2: show info (e.g. on import & append)
+   */
+  verbosity?: Logger['verbosity'];
 };
 export type StatusTracker = {
   current: number;