json-log-line 1.0.4 → 1.0.5

package/README.md

@@ -107,14 +107,16 @@ A special key that contains the rest of the log object fields which were both in
 
 #### Multi keys
 
-You can map a single formatter to multiple keys by separating them with a pipe (`|`). Each key is resolved independently (dot notation is supported) and rendered in order. Every matched value is passed through the same formatter, and each consumed key is removed from the remaining `extraFields` payload.
+You can map a single formatter to multiple keys using either commas (`,`) or pipes (`|`). Dot notation works for both. Do **not** mix `,` and `|` in the same formatter key.
+
+- `|` (take one): evaluate keys in order and format the first one that exists, then stop.
+- `,` (take all): evaluate every listed key and format each one in order.
 
 ```javascript
+// Take one: stop after the first matching value for each formatter key
 const lineFormatter = logLineFactory({
   format: {
-    // Applies to both top-level keys
     'foo|baz': (value) => `!${value}`,
-    // Works with nested keys, too
     'nested.a|other.a': (value) => `:${value}:`,
   },
 });
@@ -129,6 +131,27 @@ console.log(
     }),
   ),
 );
+// => !bar :x:
+//    {"baz":"buz","nested":{"b":"y"},"other":{}}
+
+// Take all: format every listed key
+const takeAllFormatter = logLineFactory({
+  format: {
+    'foo,baz': (value) => `!${value}`,
+    'nested.a,other.a': (value) => `:${value}:`,
+  },
+});
+
+console.log(
+  takeAllFormatter(
+    JSON.stringify({
+      foo: 'bar',
+      baz: 'buz',
+      nested: {a: 'x', b: 'y'},
+      other: {a: 'z'},
+    }),
+  ),
+);
 // => !bar !buz :x: :z:
 //    {"nested":{"b":"y"},"other":{}}
 ```

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CACb,MAAM,EACN,CAAC,KAAK,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,GAAG,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,KAAK,MAAM,CACpE,CAAC;CACH,CAAC;AAMF,wBAAgB,cAAc,CAAC;AAC7B;;GAEG;AACH,OAAY;AACZ;;GAEG;AACH,OAAY;AACZ;;GAEG;AACH,MAAW,GACZ,GAAE,OAAY,IASI,WAAW,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,MAAM,CA0FtE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CACb,MAAM,EACN,CAAC,KAAK,EAAE,GAAG,EAAE,eAAe,CAAC,EAAE,GAAG,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,KAAK,MAAM,CACpE,CAAC;CACH,CAAC;AAMF,wBAAgB,cAAc,CAAC;AAC7B;;GAEG;AACH,OAAY;AACZ;;GAEG;AACH,OAAY;AACZ;;GAEG;AACH,MAAW,GACZ,GAAE,OAAY,IASI,WAAW,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,MAAM,CAgGtE"}

package/dist/index.js

@@ -20,7 +20,7 @@ include = [],
  */
 format = {}, } = {}) {
     const logLineKeys = Object.keys(format);
-    const splitLogLineKeys = logLineKeys.flatMap((key) => key.split('|'));
+    const splitLogLineKeys = logLineKeys.flatMap((key) => key.split(/\||,/));
     format.extraFields ||= (object) => JSON.stringify(object) + nl;
     /**
      * @param inputData - The input data to be formatted can be a JSON stringified object or a plain object
@@ -57,7 +57,8 @@ format = {}, } = {}) {
             object = deepMerge()(object, whiteListObject);
             const output = [];
             for (const _key of logLineKeys) {
-                const keys = _key.split('|');
+                const isTakeOne = _key.includes('|');
+                const keys = _key.split(/\||,/);
                 for (const key of keys) {
                     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                     const value = get(object, key);
@@ -68,6 +69,9 @@ format = {}, } = {}) {
                     if (formatter) {
                         output.push(formatter(value, object));
                     }
+                    if (isTakeOne) {
+                        break;
+                    }
                 }
             }
             // remove the properties that were used to create the log-line

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-log-line",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A utility for building awesome log lines from JSON",
   "homepage": "https://github.com/spence-s/json-log-line",
   "bugs": {