@travetto/log 3.4.4 → 4.0.0-rc.0

package/README.md

@@ -16,7 +16,7 @@ yarn add @travetto/log
 This module provides logging functionality, building upon [ConsoleManager](https://github.com/travetto/travetto/tree/main/module/base/src/console.ts) in the [Base](https://github.com/travetto/travetto/tree/main/module/base#readme "Environment config and common utilities for travetto applications.") module.  This is all ultimately built upon [console](https://nodejs.org/api/console.html) operations. The logging infrastructure is built upon the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") system, and so new loggers can be created that rely upon dependency injected services and sources.
 
 ## Extending the Common Logger
-By default, the system ships with the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L11), and by default will leverage the [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L36) and the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7). The configuration [CommonLoggerConfig](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L11) provides two configuration variables that allows for switching out [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L36) for the [JsonLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/json.ts#L16), depending on the value of `CommonLoggerConfig.format`.  Additionally the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7) can be swapped out for the [FileLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/file.ts#L10) depending on the value of `CommonLoggerConfig.output`.
+By default, the system ships with the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12), and by default will leverage the [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L36) and the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7). The configuration [CommonLoggerConfig](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) provides two configuration variables that allows for switching out [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L36) for the [JsonLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/json.ts#L15), depending on the value of `CommonLoggerConfig.format`.  Additionally the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7) can be swapped out for the [FileLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/file.ts#L11) depending on the value of `CommonLoggerConfig.output`.
 
 **Code: Standard Logging Config**
 ```typescript
@@ -29,7 +29,7 @@ export class CommonLoggerConfig {
 }
 ```
 
-In addition to these simple overrides, the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L11) can be extended by providing an implementation of either a [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L38) or [LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L30), with the declared symbol of `LogCommonⲐ`.
+In addition to these simple overrides, the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) can be extended by providing an implementation of either a [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L38) or [LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L30), with the declared symbol of `LogCommonⲐ`.
 
 **Code: Sample Common Formatter**
 ```typescript
@@ -125,7 +125,7 @@ export interface LogDecorator {
 
 **Code: Custom Logger**
 ```typescript
-import os from 'os';
+import os from 'node:os';
 
 import { Injectable } from '@travetto/di';
 import { LogDecorator, LogEvent } from '@travetto/log';

package/__index__.ts

@@ -1,3 +1,4 @@
+/// <reference path="./src/trv.d.ts" />
 export * from './src/service';
 export * from './src/formatter/json';
 export * from './src/formatter/line';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/log",
-  "version": "3.4.4",
+  "version": "4.0.0-rc.0",
   "description": "Logging framework that integrates at the console.log level.",
   "keywords": [
     "typescript",
@@ -23,9 +23,9 @@
     "directory": "module/log"
   },
   "dependencies": {
-    "@travetto/config": "^3.4.4",
-    "@travetto/di": "^3.4.2",
-    "@travetto/terminal": "^3.4.0"
+    "@travetto/config": "^4.0.0-rc.0",
+    "@travetto/di": "^4.0.0-rc.0",
+    "@travetto/terminal": "^4.0.0-rc.0"
   },
   "travetto": {
     "displayName": "Logging"

package/src/appender/file.ts

@@ -1,21 +1,22 @@
-import { createWriteStream, WriteStream, mkdirSync, openSync, appendFileSync } from 'fs';
+import { createWriteStream, WriteStream, mkdirSync, openSync, appendFileSync } from 'node:fs';
 
+import { Env } from '@travetto/base';
 import { Injectable } from '@travetto/di';
 import { Config, EnvVar } from '@travetto/config';
-import { ManifestFileUtil, path, RootIndex } from '@travetto/manifest';
+import { ManifestFileUtil, path, RuntimeIndex } from '@travetto/manifest';
 
 import { LogAppender, LogEvent } from '../types';
 
 @Config('log')
 export class FileLogAppenderConfig {
-  @EnvVar('TRV_LOG_OUTPUT')
+  @EnvVar(Env.TRV_LOG_OUTPUT.key)
   output?: 'file' | string;
 
   writeSync = false;
 
   postConstruct(): void {
     if (!this.output || this.output === 'file' || this.output === 'console') {
-      this.output = ManifestFileUtil.toolPath(RootIndex, 'output.log', true);
+      this.output = ManifestFileUtil.toolPath(RuntimeIndex, 'output.log', true);
     }
   }
 }

package/src/common.ts

@@ -1,3 +1,4 @@
+import { Env } from '@travetto/base';
 import { Config, EnvVar } from '@travetto/config';
 import { DependencyRegistry, Inject, Injectable } from '@travetto/di';
 
@@ -9,10 +10,10 @@ import { LogAppender, LogFormatter, LogEvent, LogCommonⲐ, Logger } from './typ
 
 @Config('log')
 export class CommonLoggerConfig {
-  @EnvVar('TRV_LOG_FORMAT')
+  @EnvVar(Env.TRV_LOG_FORMAT.key)
   format: 'line' | 'json' = 'line';
 
-  @EnvVar('TRV_LOG_OUTPUT')
+  @EnvVar(Env.TRV_LOG_OUTPUT.key)
   output: 'console' | 'file' | string = 'console';
 }
 

package/src/formatter/google.ts

@@ -1,4 +1,4 @@
-import util from 'util';
+import util from 'node:util';
 
 import { Injectable } from '@travetto/di';
 

package/src/formatter/json.ts

@@ -1,11 +1,10 @@
 import { Injectable } from '@travetto/di';
-import { Config, EnvVar } from '@travetto/config';
+import { Config } from '@travetto/config';
 
 import { LogEvent, LogFormatter } from '../types';
 
 @Config('log')
 export class JSONLogFormatterConfig {
-  @EnvVar('TRV_LOG_JSON_INDENT')
   jsonIndent?: number;
 }
 

package/src/formatter/line.ts

@@ -1,23 +1,23 @@
-import util from 'util';
+import util from 'node:util';
 
-import { GlobalTerminal } from '@travetto/terminal';
+import { Env } from '@travetto/base';
 import { Injectable } from '@travetto/di';
 import { Config, EnvVar } from '@travetto/config';
-import { GlobalEnv } from '@travetto/base';
 import { Ignore } from '@travetto/schema';
+import { StyleUtil } from '@travetto/terminal';
 
 import { LogEvent, LogFormatter } from '../types';
 
 /**
  * Level coloring
  */
-export const STYLES = GlobalTerminal.palette({
-  info: ['yellow', 'goldenrod'],
-  debug: ['lightGray', '#555555'],
-  warn: ['darkOrange', 'brightMagenta'],
-  error: ['darkRed', { text: 'brightCyan', inverse: true }],
-  timestamp: ['white', 'black'],
-  location: ['lightBlue', 'purple']
+export const STYLES = StyleUtil.getPalette({
+  info: ['#ffff00', '#ff5733'], // Yellow / goldenrod
+  debug: ['#d3d3d3', '#555555'], // Light gray / dark gray
+  warn: ['#ff8c00', '#ff00ff'], // Dark orange / bright magenta
+  error: ['#8b0000', { text: '#00ffff', inverse: true }], // Dark red / bright cyan inverted
+  timestamp: ['#e5e5e5', '#000000'], // White /black
+  location: ['#add8e6', '#800080'] // Light blue / purple
 });
 
 /**
@@ -34,10 +34,10 @@ export interface LineFormatterOpts {
 
 @Config('log')
 export class LineLogFormatterConfig {
-  @EnvVar('TRV_LOG_PLAIN')
+  @EnvVar(Env.TRV_LOG_PLAIN.key)
   plain?: boolean;
 
-  @EnvVar('TRV_LOG_TIME')
+  @EnvVar(Env.TRV_LOG_TIME.key)
   time?: 's' | 'ms' | string;
 
   colorize?: boolean;
@@ -49,12 +49,8 @@ export class LineLogFormatterConfig {
   timestamp?: 's' | 'ms';
 
   postConstruct(): void {
-    if (GlobalEnv.test) {
-      this.plain = true;
-      this.time = undefined;
-    }
     this.time ??= (!this.plain ? 'ms' : undefined);
-    this.plain ??= GlobalTerminal.colorLevel === 0;
+    this.plain ??= !StyleUtil.enabled;
     this.colorize ??= !this.plain;
     this.location ??= !this.plain;
     this.level ??= !this.plain;
@@ -62,6 +58,10 @@ export class LineLogFormatterConfig {
     if (this.time !== undefined && this.time === 'ms' || this.time === 's') {
       this.timestamp = this.time;
     }
+    Object.assign(util.inspect.defaultOptions, {
+      breakLength: Math.max(util.inspect.defaultOptions.breakLength ?? 0, 100),
+      depth: Math.max(util.inspect.defaultOptions.depth ?? 0, 4)
+    });
   }
 }
 
@@ -80,9 +80,7 @@ export class LineLogFormatter implements LogFormatter {
   pretty(ev: LogEvent, o: unknown): string {
     return util.inspect(o, {
       showHidden: ev.level === 'debug',
-      depth: 4,
       colors: this.opts.colorize !== false,
-      breakLength: 100
     });
   }
 

package/src/service.ts

@@ -1,6 +1,5 @@
 import { ObjectUtil, ConsoleListener, ConsoleManager, ConsoleEvent } from '@travetto/base';
 import { AutoCreate, DependencyRegistry, Injectable } from '@travetto/di';
-import { GlobalTerminal } from '@travetto/terminal';
 
 import { LogDecorator, LogEvent, Logger } from './types';
 import { LogDecoratorTarget, LoggerTarget } from './internal/types';
@@ -23,8 +22,6 @@ export class LogService implements ConsoleListener, AutoCreate {
   #decorators: LogDecorator[] = [];
 
   async postConstruct(): Promise<void> {
-    await GlobalTerminal.init();
-
     this.#listeners = await DependencyRegistry.getCandidateInstances<Logger>(LoggerTarget, c => c.class !== CommonLogger);
     if (!this.#listeners.length) {
       this.#listeners = [await DependencyRegistry.getInstance(CommonLogger)];

package/src/trv.d.ts

@@ -0,0 +1,26 @@
+import '@travetto/base';
+
+declare global {
+  interface TravettoEnv {
+    /** 
+     * Determines whether or not to augment console log information
+     * @default false
+     */
+    TRV_LOG_PLAIN: boolean;
+    /** 
+     * Determines if we should log time when logging, 
+     * @default ms
+     */
+    TRV_LOG_TIME: false | 'ms' | 's';
+    /** 
+     * Determines desired log format 
+     * @default text
+     */
+    TRV_LOG_FORMAT: 'json' | 'text';
+    /**
+     * Log output location
+     * @default console
+     */
+    TRV_LOG_OUTPUT: 'console' | 'file' | string;
+  }
+}

package/src/types.ts

@@ -17,7 +17,7 @@ export interface LogEvent extends ConsoleEvent {
 }
 
 /**
- * @concrete ./internal/types:LogDecoratorTarget
+ * @concrete ./internal/types#LogDecoratorTarget
  */
 export interface LogDecorator {
   decorate(ev: LogEvent): LogEvent;
@@ -25,7 +25,7 @@ export interface LogDecorator {
 
 /**
  * Output appender for the logger
- * @concrete ./internal/types:LogAppenderTarget
+ * @concrete ./internal/types#LogAppenderTarget
  */
 export interface LogAppender {
   append(ev: LogEvent, formatted: string): void;
@@ -33,14 +33,14 @@ export interface LogAppender {
 
 /**
  * Output formatter
- * @concrete ./internal/types:LogFormatterTarget
+ * @concrete ./internal/types#LogFormatterTarget
  */
 export interface LogFormatter {
   format(e: LogEvent): string;
 }
 
 /**
- * @concrete ./internal/types:LoggerTarget
+ * @concrete ./internal/types#LoggerTarget
  */
 export interface Logger {
   onLog(ev: LogEvent): unknown;