feat: Locate position column

unlight · Feb 18, 2021 · 8186240 · 8186240
1 parent 880cc0a
commit 8186240
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ export class AppModule {}
 
 ```ts
 /**
- * Limit context to this number of chars.
+ * Limit of context message.
  */
 contextLimit: 13,
 /**
@@ -36,6 +36,21 @@ contextLimit: 13,
  * If -1 disable
  */
 messageColumnWidth: 0,
+/**
+ * Alternative locate. Default ololog's locate add callee info to the last non-empty string
+ * Custom locate add callee info on next new line.
+ */
+customLocate: undefined as undefined | boolean | typeof customLocateDefault,
+/**
+ * Place of callee info.
+ * 'bottom' - next on new line (default)
+ * 'column' - between tag and message columnized
+ */
+customLocatePosition: 'bottom' as 'bottom' | 'column',
+/**
+ * Limit callee info length in case of customLocatePosition = 'column'
+ */
+customLocateColumnLimit: 30,
 ```
 
 ## Use as the main Nest Logger

diff --git a/src/index.spec.ts b/src/index.spec.ts
@@ -2,25 +2,49 @@ import ansicolor from 'ansicolor';
 import expect from 'expect';
 
 import { messageColumnWidth } from './message-column-width';
-import { nestologOptionsDefaults } from './nestolog-options';
+import { NestologOptions, nestologOptionsDefaults } from './nestolog-options';
 import { NestoLogger } from './nestologger.service';
 
-it('messageColumnWidth', () => {
-    const result = messageColumnWidth(nestologOptionsDefaults);
-    expect(result).not.toBeUndefined();
-});
-
-it('custom locate', () => {
+function createOutput(
+    options: Partial<NestologOptions & { message?: string; context?: string }> = {},
+) {
     let output = '';
+    const message = options.message ?? 'Test Message';
+    const context = options.context ?? 'Context';
     const logger = new NestoLogger({
         ...nestologOptionsDefaults,
-        customLocate: true,
+        ...options,
         render: (input: string) => {
             output = ansicolor.strip(input);
         },
     });
-    logger.log('Test message', 'Contex');
+    logger.log(message, context);
+    return output;
+}
+
+it('messageColumnWidth', () => {
+    const result = messageColumnWidth(nestologOptionsDefaults);
+    expect(result).not.toBeUndefined();
+});
+
+it('custom locate bottom', () => {
+    const output = createOutput({
+        customLocate: true,
+        customLocatePosition: 'bottom',
+    });
     const lines = output.split('\n');
     expect(lines).toHaveLength(2);
-    expect(lines[0]!.indexOf('Test message')).toEqual(lines[1]?.indexOf('<anonymous>'));
+    expect(lines[0]!.indexOf('Test Message')).toEqual(
+        lines[1]?.indexOf('createOutput'),
+    );
+});
+
+it('custom locate column', () => {
+    const output = createOutput({
+        customLocate: true,
+        customLocatePosition: 'column',
+    });
+    const lines = output.split('\n');
+    expect(lines).toHaveLength(1);
+    expect(output).toContain('Context       index.spec.ts');
 });
diff --git a/src/nestolog-options.ts b/src/nestolog-options.ts
@@ -4,10 +4,16 @@ import { Entry } from './types';
 
 export const NESTOLOG_OPTIONS = Symbol('NESTOLOG_OPTIONS');
 
+export type NestologOptions = typeof nestologOptionsDefaults &
+    Parameters<typeof ololog.configure>[0];
+
 export const nestologOptionsDefaults = {
     time: true,
     locate: true,
     tag: true,
+    /**
+     * Limit of context message.
+     */
     contextLimit: 13,
     /**
      * Word wrap width for message.
@@ -20,9 +26,23 @@ export const nestologOptionsDefaults = {
      * Custom locate add callee info on next new line.
      */
     customLocate: undefined as undefined | boolean | typeof customLocateDefault,
+    /**
+     * Place of callee info.
+     * 'bottom' - next on new line (default)
+     * 'column' - between tag and message columnized
+     */
+    customLocatePosition: 'bottom' as 'bottom' | 'column',
+    /**
+     * Limit callee info length in case of customLocatePosition = 'column'
+     */
+    customLocateColumnLimit: 30,
 };
 
-export function customLocateDefault({ calleeShort, fileName, line }: Entry): string {
+export function customLocateDefault(
+    { calleeShort, fileName, line }: Entry,
+    options: NestologOptions,
+): string {
+    const { customLocatePosition, customLocateColumnLimit } = options;
     let result = '';
     if (calleeShort) {
         result += calleeShort;
@@ -35,8 +55,13 @@ export function customLocateDefault({ calleeShort, fileName, line }: Entry): str
         result += ':';
         result += line;
     }
+    if (
+        customLocatePosition === 'column' &&
+        result.length > customLocateColumnLimit &&
+        fileName &&
+        line
+    ) {
+        result = `${fileName}:${line}`;
+    }
     return result;
 }
-
-export type NestologOptions = typeof nestologOptionsDefaults &
-    Parameters<typeof ololog.configure>[0];
diff --git a/src/nestologger.service.ts b/src/nestologger.service.ts
@@ -95,22 +95,33 @@ export class NestoLogger implements LoggerService {
     }
 
     private concatContext({ context, where }: { context?: string; where?: Entry }) {
-        const { contextLimit } = this.options;
+        const {
+            contextLimit,
+            customLocatePosition,
+            customLocateColumnLimit,
+        } = this.options;
         const customLocate =
             this.options.customLocate === true
                 ? customLocateDefault
                 : this.options.customLocate;
         return (lines: string[]) => {
             if (where && customLocate) {
-                lines.push(ansicolor.darkGray(customLocate(where)));
+                let calleeInfo = customLocate(where, this.options);
+                if (customLocatePosition === 'column') {
+                    calleeInfo = calleeInfo.padEnd(customLocateColumnLimit);
+                    calleeInfo = stringify.limit(calleeInfo, customLocateColumnLimit);
+                    lines = bullet(ansicolor.darkGray(calleeInfo) + ' ', lines);
+                } else {
+                    lines.push(ansicolor.darkGray(calleeInfo));
+                }
             }
             if (context) {
                 if (contextLimit > 0) {
                     context = stringify
                         .limit(context, contextLimit)
                         .padEnd(contextLimit);
                 }
-                return bullet(ansicolor.yellow(context + ' '), lines);
+                lines = bullet(ansicolor.yellow(context + ' '), lines);
             }
             return lines;
         };