feat(logger): initial implementation

src/core/logger/CodefendLogger.ts

@@ -0,0 +1,19 @@
+import { ICodefendOptions } from "../options/ICodefendOptions";
+import { ICodefendLogger } from "./ICodefendLogger";
+
+export class CodefendLogger implements ICodefendLogger {
+  options: ICodefendOptions | undefined;
+
+  constructor(options: ICodefendOptions) {
+    this.setOptions(options);
+  }
+
+  setOptions(options: ICodefendOptions) {
+    this.options = options;
+  }
+
+  log(scope: string, type: string, message: unknown) {
+    if (!this.options?.debug) return;
+    console.log(`Codefend(${scope}):${type}:`, message);
+  }
+}

src/core/logger/ICodefendLogger.ts

@@ -0,0 +1,3 @@
+export interface ICodefendLogger {
+  log: (scope: string, type: string, message: unknown) => void;
+}

src/core/mapper/CodefendMapper.ts

@@ -1,3 +1,4 @@
+import { CodefendLogger } from "../logger/CodefendLogger";
 import {
   ICodefendOptions,
   ICodefendPredefinedWordOption,
@@ -7,9 +8,13 @@ import { ICodefendMapper } from "./ICodefendMapper";
 
 export class CodefendMapper implements ICodefendMapper {
   options: ICodefendOptions | undefined;
+  logger: CodefendLogger;
+  scope: string;
 
-  constructor(options: ICodefendOptions) {
+  constructor(options: ICodefendOptions, logger: CodefendLogger) {
     this.setOptions(options);
+    this.logger = logger;
+    this.scope = this.constructor.name.replace("Codefend", "");
   }
 
   setOptions(options: ICodefendOptions) {
@@ -26,6 +31,7 @@ export class CodefendMapper implements ICodefendMapper {
     words.forEach((word) => {
       if (map[word.value]) return;
       map[word.value] = `${prefix ?? ""}${sequence++}`;
+      this.logger.log(this.scope, "INFO", word.value);
     });
     return map;
   }

src/core/options/ICodefendOptions.ts

@@ -3,6 +3,7 @@ export interface ICodefendOptions {
   predefinedWords?: ICodefendPredefinedWordOption[];
   ignoredWords?: string[];
   regexList?: ICodefendRegexListOption[];
+  debug?: boolean;
 }
 
 export interface ICodefendPredefinedWordOption {
@@ -29,4 +30,5 @@ export const defaultOptions: ICodefendOptions = {
       value: /((cmp|lib)+(-[a-zA-Z]+)+)/g,
     },
   ],
+  debug: true,
 };

src/core/parser/CodefendParser.ts

@@ -1,3 +1,4 @@
+import { CodefendLogger } from "../logger/CodefendLogger";
 import {
   ICodefendOptions,
   ICodefendRegexListOption,
@@ -6,9 +7,11 @@ import { ICodefendParser, ICodefendParserWord } from "./ICodefendParser";
 
 export class CodefendParser implements ICodefendParser {
   options: ICodefendOptions | undefined;
+  logger: CodefendLogger;
 
-  constructor(options: ICodefendOptions) {
+  constructor(options: ICodefendOptions, logger: CodefendLogger) {
     this.setOptions(options);
+    this.logger = logger;
   }
 
   setOptions(options: ICodefendOptions) {

src/core/replacer/CodefendReplacer.ts

@@ -1,6 +1,12 @@
+import { CodefendLogger } from "../logger/CodefendLogger";
 import { ICodefendReplacer } from "./ICodefendReplacer";
 
 export class CodefendReplacer implements ICodefendReplacer {
+  logger: CodefendLogger;
+  constructor(logger: CodefendLogger) {
+    this.logger = logger;
+  }
+
   replace(code: string, map: Record<string, string>) {
     const words = Object.keys(map);
     if (!words.length) return code;

src/index.ts

@@ -1,3 +1,4 @@
+import { CodefendLogger } from "./core/logger/CodefendLogger";
 import { CodefendMapper } from "./core/mapper/CodefendMapper";
 import {
   ICodefendOptions,
@@ -6,10 +7,13 @@ import {
 import { CodefendParser } from "./core/parser/CodefendParser";
 import { CodefendReplacer } from "./core/replacer/CodefendReplacer";
 
+const logger = new CodefendLogger(defaultOptions);
+
 export const CodefendCore = {
-  parser: new CodefendParser(defaultOptions),
-  mapper: new CodefendMapper(defaultOptions),
-  replacer: new CodefendReplacer(),
+  parser: new CodefendParser(defaultOptions, logger),
+  mapper: new CodefendMapper(defaultOptions, logger),
+  replacer: new CodefendReplacer(logger),
+  logger: logger,
 };
 
 export function obfuscate(