@genesislcap/foundation-logger 14.203.0 → 14.203.2

package/README.md

@@ -3,7 +3,7 @@
 [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
 [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
 
-`foundation-logger` provides a logging utility that currently wraps [consola](https://github.com/unjs/consola).
+`foundation-logger` provides a logging utility that currently wraps version 2 of [consola](https://github.com/unjs/consola).
 
 ## Installation
 
@@ -23,6 +23,39 @@ To enable this module in your application, follow the steps below.
 }
 ```
 
+2. Create a logger in my-package/utils/logger.ts for example.
+
+```ts
+import { createLogger } from '@genesislcap/foundation-logger';
+export const logger = createLogger('my-package');
+```
+
+The logger will be set to `LogLevel.Debug` by default, however you can pass options as the second parameter to tailor this.
+
+```ts
+export const logger = createLogger('my-package', { level: LogLevel.Debug, ... });
+```
+
+`LoggerOptions` type extends the `ConsolaOptions` type.
+
+3. Use the logger in your package.
+
+```ts
+import { logger } from '../utils';
+...
+logger.debug('Checks complete');
+```
+
+4. Explicitly set the log level of an imported foundation package when needed.
+
+```ts
+import { logger as commsLogger } from '@genesislcap/foundation-comms';
+import { logger as storeLogger } from '@genesislcap/foundation-store';
+import { LogLevel } from '@genesislcap/foundation-logger';
+commsLogger.level = LogLevel.Warn;
+storeLogger.level = LogLevel.Silent;
+```
+
 ## [API Docs](./docs/api/index.md)
 
 ## License
@@ -30,4 +63,4 @@ To enable this module in your application, follow the steps below.
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
-Genesis low-code platform
+Genesis low-code platform

package/dist/dts/logger.d.ts

@@ -77,6 +77,13 @@ export declare const defaultLoggerOptions: LoggerOptions;
  * logger.warn('Not available in this browser.');
  * ```
  *
+ * @example Explicitly set the level of an imported package.
+ * ```ts
+ * import { logger as commsLogger } from '@genesislcap/foundation-comms';
+ * import { LogLevel } from '@genesislcap/foundation-logger';
+ * commsLogger.level = LogLevel.Warn;
+ * ```
+ *
  * @param name - The name to give the logger.
  * @param options - The options to use when creating the logger.
  * @returns The resulting logger.

package/dist/dts/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAY,MAAM,SAAS,CAAC;AAG5D;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;CAAG;AAExD;;;;;;;GAOG;AACH,MAAM,WAAW,MAAO,SAAQ,OAAO;IACrC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvF;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,OAAO;CAAG;AAE1C;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,aAElC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,aAAoC,GAAG,MAAM,CAgBhG"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAY,MAAM,SAAS,CAAC;AAG5D;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5C;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,cAAc;CAAG;AAExD;;;;;;;GAOG;AACH,MAAM,WAAW,MAAO,SAAQ,OAAO;IACrC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvF;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,OAAO;CAAG;AAE1C;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,aAElC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,aAAoC,GAAG,MAAM,CAmBhG"}

package/dist/esm/logger.js

@@ -37,15 +37,22 @@ export const defaultLoggerOptions = {
  * logger.warn('Not available in this browser.');
  * ```
  *
+ * @example Explicitly set the level of an imported package.
+ * ```ts
+ * import { logger as commsLogger } from '@genesislcap/foundation-comms';
+ * import { LogLevel } from '@genesislcap/foundation-logger';
+ * commsLogger.level = LogLevel.Warn;
+ * ```
+ *
  * @param name - The name to give the logger.
  * @param options - The options to use when creating the logger.
  * @returns The resulting logger.
  * @public
  */
 export function createLogger(name, options = defaultLoggerOptions) {
-    const baseLogger = consola.create(options);
-    const logger = baseLogger.withTag(name);
-    return Object.assign(Object.assign({}, logger), { deprecated: (symbol, instruction = 'Consult docs for better alternative.', removalVersionTarget) => {
-            logger.warn(`Deprecated symbol used '${symbol}'. ${instruction}`, `${removalVersionTarget ? `Will be removed in version ${removalVersionTarget}.` : ''}`);
-        } });
+    const logger = consola.create(Object.assign(Object.assign({}, options), { defaults: Object.assign(Object.assign({}, (options.defaults || {})), { tag: name }) }));
+    logger.deprecated = (symbol, instruction = 'Consult docs for better alternative.', removalVersionTarget) => {
+        logger.warn(`Deprecated symbol used '${symbol}'. ${instruction}`, `${removalVersionTarget ? `Will be removed in version ${removalVersionTarget}.` : ''}`);
+    };
+    return logger;
 }

package/dist/foundation-logger.api.json

@@ -175,7 +175,7 @@
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-logger!createLogger:function(1)",
-          "docComment": "/**\n * Creates a logger with the given name and options.\n *\n * @param name - The name to give the logger.\n *\n * @param options - The options to use when creating the logger.\n *\n * @returns The resulting logger.\n *\n * @example\n *\n * Create a logger in my-package/utils.\n * ```ts\n * import { createLogger } from '@genesislcap/foundation-logger';\n * export const logger = createLogger('my-package');\n * ```\n *\n * @example\n *\n * Using the logger within my-package.\n * ```ts\n * import { logger } from '../utils';\n * logger.debug(`Data retrieved from ${resourceName}`);\n * logger.info(this.toggled ? 'On' : 'Off');\n * logger.warn('Not available in this browser.');\n * ```\n *\n * @public\n */\n",
+          "docComment": "/**\n * Creates a logger with the given name and options.\n *\n * @param name - The name to give the logger.\n *\n * @param options - The options to use when creating the logger.\n *\n * @returns The resulting logger.\n *\n * @example\n *\n * Create a logger in my-package/utils.\n * ```ts\n * import { createLogger } from '@genesislcap/foundation-logger';\n * export const logger = createLogger('my-package');\n * ```\n *\n * @example\n *\n * Using the logger within my-package.\n * ```ts\n * import { logger } from '../utils';\n * logger.debug(`Data retrieved from ${resourceName}`);\n * logger.info(this.toggled ? 'On' : 'Off');\n * logger.warn('Not available in this browser.');\n * ```\n *\n * @example\n *\n * Explicitly set the level of an imported package.\n * ```ts\n * import { logger as commsLogger } from '@genesislcap/foundation-comms';\n * import { LogLevel } from '@genesislcap/foundation-logger';\n * commsLogger.level = LogLevel.Warn;\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/foundation-logger.d.ts

@@ -20,6 +20,13 @@ import { logType } from 'consola';
  * logger.warn('Not available in this browser.');
  * ```
  *
+ * @example Explicitly set the level of an imported package.
+ * ```ts
+ * import { logger as commsLogger } from '@genesislcap/foundation-comms';
+ * import { LogLevel } from '@genesislcap/foundation-logger';
+ * commsLogger.level = LogLevel.Warn;
+ * ```
+ *
  * @param name - The name to give the logger.
  * @param options - The options to use when creating the logger.
  * @returns The resulting logger.

package/docs/api/foundation-logger.createlogger.md

@@ -45,3 +45,13 @@ logger.info(this.toggled ? 'On' : 'Off');
 logger.warn('Not available in this browser.');
 ```
 
+## Example 3
+
+Explicitly set the level of an imported package.
+
+```ts
+import { logger as commsLogger } from '@genesislcap/foundation-comms';
+import { LogLevel } from '@genesislcap/foundation-logger';
+commsLogger.level = LogLevel.Warn;
+```
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-logger",
   "description": "Genesis Foundation Logger",
-  "version": "14.203.0",
+  "version": "14.203.2",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3f779b9e65169135dc8fea0605f21d0d65ce263b"
+  "gitHead": "8a31c5b68f7b0eecff3e23762c63c3d869ae25bb"
 }