@travetto/log 2.1.2 → 2.2.0

package/README.md

@@ -48,8 +48,8 @@ export function work() {
 
   try {
     1 / 0;
-  } catch (e) {
-    console.error('Divide by zero', { error: e });
+  } catch (err) {
+    console.error('Divide by zero', { error: err });
   }
   console.debug('End Work');
 }
@@ -65,8 +65,8 @@ function work() {
     try {
         1 / 0;
     }
-    catch (e) {
-        ᚕlg("error", { file: ᚕsrc(__filename), line: 7, scope: "work" }, 'Divide by zero', { error: e });
+    catch (err) {
+        ᚕlg("error", { file: ᚕsrc(__filename), line: 7, scope: "work" }, 'Divide by zero', { error: err });
     }
     ᚕlg("debug", { file: ᚕsrc(__filename), line: 9, scope: "work" }, 'End Work');
 }
@@ -85,8 +85,8 @@ function work() {
     try {
         1 / 0;
     }
-    catch (e) {
-        ᚕlg("error", { file: ᚕsrc(__filename), line: 5, scope: "work" }, 'Divide by Zero', { error: e });
+    catch (err) {
+        ᚕlg("error", { file: ᚕsrc(__filename), line: 5, scope: "work" }, 'Divide by Zero', { error: err });
     }
 }
 exports.work = work;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/log",
   "displayName": "Logging",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "Logging framework that integrates at the console.log level.",
   "keywords": [
     "typescript",
@@ -27,8 +27,8 @@
     "directory": "module/log"
   },
   "dependencies": {
-    "@travetto/base": "^2.1.2",
-    "@travetto/transformer": "^2.1.2"
+    "@travetto/base": "^2.2.0",
+    "@travetto/transformer": "^2.2.0"
   },
   "publishConfig": {
     "access": "public"

package/src/appender/console.ts

@@ -13,7 +13,7 @@ export interface ConsoleAppenderOpts {
 export class ConsoleAppender implements Appender {
   constructor(opts: ConsoleAppenderOpts = {}) { }
 
-  append(level: LogLevel, message: string) {
+  append(level: LogLevel, message: string): void {
     console![level](message);
   }
 }

package/src/appender/file.ts

@@ -22,7 +22,7 @@ export class FileAppender implements Appender {
     });
   }
 
-  append(level: LogLevel, message: string) {
+  append(level: LogLevel, message: string): void {
     this.stream.write(`${message}\n`);
   }
 }

package/src/formatter/json.ts

@@ -17,7 +17,7 @@ export class JsonFormatter implements Formatter {
     this.#opts = opts;
   }
 
-  format(ev: LogEvent) {
+  format(ev: LogEvent): string {
     return JSON.stringify(ev, null, this.#opts.depth);
   }
 }

package/src/formatter/line.ts

@@ -43,7 +43,7 @@ export class LineFormatter implements Formatter {
     };
   }
 
-  pretty(ev: LogEvent, o: unknown) {
+  pretty(ev: LogEvent, o: unknown): string {
     return util.inspect(o, {
       showHidden: ev.level === 'debug',
       depth: 4,
@@ -55,7 +55,7 @@ export class LineFormatter implements Formatter {
   /**
    * Format an event into a single line
    */
-  format(ev: LogEvent) {
+  format(ev: LogEvent): string {
     const opts = this.#opts;
     const out = [];
 

package/src/service.ts

@@ -21,6 +21,7 @@ class $Logger {
   /**
    * Should we enrich the console by default
    */
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   readonly #logFormat: 'line' | 'json' = EnvUtil.get('TRV_LOG_FORMAT', 'line') as 'line';
 
   readonly #logFile?: string = EnvUtil.get('TRV_LOG_FILE');
@@ -46,7 +47,7 @@ class $Logger {
   /**
    * Initialize
    */
-  init() {
+  init(): void {
     if (AppManifest.env.debug.status !== false) {
       delete this.#exclude.debug;
       const filter = LogUtil.buildFilter(AppManifest.env.debug.value ?? '@app');
@@ -71,7 +72,7 @@ class $Logger {
   /**
    * Add log event listener
    */
-  listen(key: string | symbol, handler: (ev: LogEvent) => void) {
+  listen(key: string | symbol, handler: (ev: LogEvent) => void): void {
     this.removeListener(key);
     this.#listenerMap.set(key, handler);
     this.#listeners.push(handler);
@@ -82,14 +83,14 @@ class $Logger {
    * @param formatter
    * @param appender Defaults to console appender unless specified
    */
-  listenDefault(formatter: Formatter, appender?: Appender) {
+  listenDefault(formatter: Formatter, appender?: Appender): void {
     this.listen(DefaultLoggerⲐ, LogUtil.buildListener(formatter, appender ?? new ConsoleAppender()));
   }
 
   /**
    * Clear all listeners
    */
-  removeAll() {
+  removeAll(): void {
     this.#listenerMap.clear();
     this.#listeners = [];
   }
@@ -97,7 +98,7 @@ class $Logger {
   /**
    * Remove specific listener
    */
-  removeListener(key: string | symbol) {
+  removeListener(key: string | symbol): void {
     const handler = this.#listenerMap.get(key);
     if (handler) {
       this.#listenerMap.delete(key);

package/src/types.ts

@@ -31,7 +31,7 @@ export interface LogEvent {
    */
   line: number;
   /**
-   * Categorization of file into a readible name
+   * Categorization of file into a readable name
    */
   category: string;
   /**

package/src/util.ts

@@ -9,7 +9,7 @@ export class LogUtil {
   /**
    * Produce an event listener
    */
-  static buildListener(formatter: Formatter, appender: Appender, filter?: (ev: LogEvent) => boolean) {
+  static buildListener(formatter: Formatter, appender: Appender, filter?: (ev: LogEvent) => boolean): (ev: LogEvent) => void {
     if (filter) {
       return (ev: LogEvent) => {
         if (filter(ev)) {
@@ -24,7 +24,7 @@ export class LogUtil {
   /**
    * Build a filter element
    */
-  static buildFilterPart(p: string) {
+  static buildFilterPart(p: string): { key: 'exc' | 'inc', filter: string[] } {
     const [, neg, prop] = p.match(/(-|[+])?(.*)/)!;
     const cleaned = (/^.*:[^\/]*[^*]$/.test(prop) ? `${prop}/*` : prop).replace(/([\/.])/g, a => `\\${a}`);
     const key: 'exc' | 'inc' = neg ? 'exc' : 'inc';
@@ -46,8 +46,8 @@ export class LogUtil {
   /**
    * Convert filter into test function for filtering
    */
-  static buildFilter(v: string) {
-    const config = { inc: [] as string[], exc: [] as string[] };
+  static buildFilter(v: string): ((file: string) => boolean) | undefined {
+    const config: { inc: string[], exc: string[] } = { inc: [], exc: [] };
     const { inc, exc } = config;
 
     for (const p of v.split(/\s*,\s*/)) {

package/support/phase.init.ts

@@ -5,7 +5,7 @@ export const init = {
   key: '@trv:log/init',
   after: ['@trv:base/init'],
   before: ['@trv:config/init'],
-  action: async () => {
+  action: async (): Promise<void> => {
     const { Logger } = await import('../src/service');
     Logger.init();
   }

package/support/transformer.logger.ts

@@ -18,25 +18,25 @@ export class LoggerTransformer {
 
   static [TransformerId] = '@trv:log';
 
-  static initState(state: CustomState) {
+  static initState(state: CustomState): void {
     state.scope = state.scope ?? [];
   }
 
   @OnClass()
-  static onClass(state: CustomState, node: ts.ClassDeclaration) {
+  static onClass(state: CustomState, node: ts.ClassDeclaration): typeof node {
     this.initState(state);
     state.scope.push({ type: 'class', name: node.name?.text ?? 'unknown' });
     return node;
   }
 
   @AfterClass()
-  static afterClass(state: CustomState, node: ts.ClassDeclaration) {
+  static afterClass(state: CustomState, node: ts.ClassDeclaration): typeof node {
     state.scope.pop();
     return node;
   }
 
   @OnMethod()
-  static onMethod(state: CustomState, node: ts.MethodDeclaration) {
+  static onMethod(state: CustomState, node: ts.MethodDeclaration): typeof node {
     this.initState(state);
     let name = 'unknown';
     if (ts.isIdentifier(node.name)) {
@@ -47,33 +47,37 @@ export class LoggerTransformer {
   }
 
   @AfterMethod()
-  static afterMethod(state: CustomState, node: ts.MethodDeclaration) {
+  static afterMethod(state: CustomState, node: ts.MethodDeclaration): typeof node {
     state.scope.pop();
     return node;
   }
 
   @OnFunction()
-  static onFunction(state: CustomState, node: ts.FunctionDeclaration | ts.FunctionExpression) {
+  static onFunction(state: CustomState, node: ts.FunctionDeclaration | ts.FunctionExpression): typeof node {
     this.initState(state);
     state.scope.push({ type: 'function', name: node.name?.text ?? 'unknown' });
     return node;
   }
 
   @AfterFunction()
-  static afterFunction(state: CustomState, node: ts.FunctionDeclaration | ts.FunctionExpression) {
+  static afterFunction(state: CustomState, node: ts.FunctionDeclaration | ts.FunctionExpression): typeof node {
     state.scope.pop();
     return node;
   }
 
   @OnCall()
-  static onDebugCall(state: CustomState, node: ts.CallExpression) {
+  static onDebugCall(state: CustomState, node: ts.CallExpression): typeof node | ts.Identifier {
     if (!ts.isIdentifier(node.expression) || node.expression.text !== ConsoleManager.key) {
       return node;
     }
     const arg = CoreUtil.getArgument(node);
     if (arg) {
       // Okay since we create the object ourselves in ConsoleManager
-      const level = LiteralUtil.toLiteral(arg, false) as string;
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      if (!ts.isStringLiteral(arg)) {
+        return node;
+      }
+      const level = LiteralUtil.toLiteral(arg, false);
       if (AppManifest.prod && level === 'debug') {
         return state.createIdentifier('undefined'); // Lose debug logging if in prod
       } else {