@wdio/logger 8.11.0 → 8.16.17

package/README.md

@@ -31,3 +31,42 @@ log.info('some logs')
 ```
 
 For more info see [`loglevel`](https://www.npmjs.com/package/loglevel) package on NPM.
+
+## Custom Log Levels
+
+This package extends the log levels available in [`loglevel`](https://www.npmjs.com/package/loglevel) by introducing a new level called `progress`.
+
+The `progress` level is particularly useful when you need to dynamically update a specific line in the terminal. For example, it can be utilized to display the download progress of browsers or drivers.
+
+Notably, the `progress` level is equivalent to the `info` level. Therefore, if you set the log level to `error` or `silent`, any `progress` logs will be suppressed.
+
+It's important to mention that `progress` writes directly to `process.stdout`, and these logs won't be captured in any log files.
+
+To ensure consistent formatting with subsequent logs while using `progress`, it's essential to clear it at the end. To do so, simply call `progress` with an empty string, which will clear the last line:
+
+```
+log.progress('')
+```
+
+### Illustrative Usage of Progress
+
+```javascript
+import logger from '@wdio/logger';
+
+const log = logger('internal');
+
+const totalSize = 100;
+let uploadedSize = 0;
+
+const uploadInterval = setInterval(() => {
+	const chunkSize = 10;
+	uploadedSize += chunkSize;
+	const data = `Progress: ${(uploadedSize * 100) / totalSize}%`;
+	log.progress(data);
+	if (uploadedSize >= totalSize) {
+		clearInterval(uploadInterval);
+		log.progress(''); // Called at the end to maintain the alignment of subsequent logs.
+		console.log('Upload complete.');
+	}
+}, 100);
+```

package/build/node.d.ts

@@ -1,5 +1,8 @@
 import log from 'loglevel';
-declare function getLogger(name: string): log.Logger;
+interface LoggerInterface extends log.Logger {
+    progress(...msg: any[]): void;
+}
+declare function getLogger(name: string): LoggerInterface;
 declare namespace getLogger {
     var waitForBuffer: () => Promise<void>;
     var setLevel: (name: string, level: log.LogLevelDesc) => void;
@@ -7,5 +10,5 @@ declare namespace getLogger {
     var setLogLevelsConfig: (logLevels?: Record<string, log.LogLevelDesc>, wdioLogLevel?: log.LogLevelDesc) => void;
 }
 export default getLogger;
-export type Logger = log.Logger;
+export type Logger = LoggerInterface;
 //# sourceMappingURL=node.d.ts.map

package/build/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAGA,OAAO,GAAG,MAAM,UAAU,CAAA;AA8G1B,iBAAwB,SAAS,CAAE,IAAI,EAAE,MAAM,cAwB9C;kBAxBuB,SAAS;;;;;;eAAT,SAAS;AAgFjC,MAAM,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAA"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAGA,OAAO,GAAG,MAAM,UAAU,CAAA;AAsD1B,UAAU,eAAgB,SAAQ,GAAG,CAAC,MAAM;IACxC,QAAQ,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;CACjC;AA2ED,iBAAwB,SAAS,CAAE,IAAI,EAAE,MAAM,mBAyB9C;kBAzBuB,SAAS;;;;;;eAAT,SAAS;AAiFjC,MAAM,MAAM,MAAM,GAAG,eAAe,CAAA"}

package/build/node.js

@@ -13,7 +13,8 @@ const COLORS = {
     warn: 'yellow',
     info: 'cyanBright',
     debug: 'green',
-    trace: 'cyan'
+    trace: 'cyan',
+    progress: 'magenta'
 };
 const matches = {
     COMMAND: 'COMMAND',
@@ -97,6 +98,17 @@ const wdioLoggerMethodFactory = function (methodName, logLevel, loggerName) {
         rawMethod(...args);
     };
 };
+const progress = function (data) {
+    if (process.stdout.isTTY && this.getLevel() <= log.levels.INFO) {
+        const level = 'progress';
+        const timestampFormatter = chalk.gray(new Date().toISOString());
+        const levelFormatter = chalk[COLORS[level]](level.toUpperCase());
+        const nameFormatter = chalk.whiteBright(this.name);
+        const _data = data.length > 0 ? `${timestampFormatter} ${levelFormatter} ${nameFormatter}: ${data}` : '\r\x1b[K';
+        process.stdout.write('\u001B[?25l'); // Disable cursor in terminal
+        process.stdout.write(`${_data}\r`);
+    }
+};
 export default function getLogger(name) {
     /**
      * check if logger was already initiated
@@ -112,6 +124,7 @@ export default function getLogger(name) {
     loggers[name] = log.getLogger(name);
     loggers[name].setLevel(logLevel);
     loggers[name].methodFactory = wdioLoggerMethodFactory;
+    loggers[name].progress = progress;
     prefix.apply(loggers[name], {
         template: '%t %l %n:',
         timestampFormatter: (date) => chalk.gray(date.toISOString()),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/logger",
-  "version": "8.11.0",
+  "version": "8.16.17",
   "description": "A helper utility for logging of WebdriverIO packages",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-logger",
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6fa7ae486537cbd3f6dd9e3bcc1812eb0acc6262"
+  "gitHead": "5bb4539c96e11a7ece83630b30c0a54903b55c0e"
 }