@wdio/reporter - npm Package Compare versions

Comparing version 6.11.0 to 7.0.0-beta.0

build/index.d.ts

 /// <reference types="node" />
-import { WriteStream } from 'fs';
+import type { WriteStream } from 'fs';
 import { EventEmitter } from 'events';
+import type { Reporters } from '@wdio/types';
 import SuiteStats from './stats/suite';
@@ -9,16 +10,8 @@ import HookStats from './stats/hook';
 import { AfterCommandArgs, BeforeCommandArgs, CommandArgs, Tag } from './types';
-export interface WDIOReporterBaseOptions {
-    outputDir?: string;
-}
-export interface WDIOReporterOptionsFromStdout extends WDIOReporterBaseOptions {
-    stdout: boolean;
-    writeStream: WriteStream;
-}
-export interface WDIOReporterOptionsFromLogFile extends WDIOReporterBaseOptions {
-    logFile: string;
-}
-export declare type WDIOReporterOptions = WDIOReporterOptionsFromLogFile & WDIOReporterOptionsFromStdout;
+declare type CustomWriteStream = {
+    write: (content: any) => boolean;
+};
 export default class WDIOReporter extends EventEmitter {
-    options: Partial<WDIOReporterOptions>;
-    outputStream: WriteStream;
+    options: Partial<Reporters.Options>;
+    outputStream: WriteStream | CustomWriteStream;
     failures: number;
@@ -40,3 +33,3 @@ suites: Record<string, SuiteStats>;
     isContentPresent: boolean;
-    constructor(options: Partial<WDIOReporterOptions>);
+    constructor(options: Partial<Reporters.Options>);
     get isSynchronised(): boolean;
@@ -43,0 +36,0 @@ write(content: any): void;

build/index.js

@@ -41,3 +41,3 @@ "use strict";
         }
-        this.outputStream = this.options.stdout || !this.options.logFile
+        this.outputStream = (this.options.stdout || !this.options.logFile) && this.options.writeStream
             ? this.options.writeStream
@@ -44,0 +44,0 @@ : fs_extra_1.createWriteStream(this.options.logFile);

build/stats/runner.d.ts

@@ -1,11 +0,10 @@
-/// <reference types="webdriver" />
+import type { Capabilities, Options } from '@wdio/types';
 import RunnableStats from './runnable';
-import { WDIOReporterOptions } from '..';
 export interface Runner {
     cid: string;
     specs: string[];
-    config: WDIOReporterOptions;
+    config: Options.Testrunner;
     isMultiremote: boolean;
     sessionId?: string;
-    capabilities: WebDriver.DesiredCapabilities;
+    capabilities: Capabilities.Capabilities;
     retry?: number;
@@ -17,5 +16,5 @@ failures?: number;
     cid: string;
-    capabilities: WebDriver.DesiredCapabilities;
+    capabilities: Capabilities.Capabilities;
     sanitizedCapabilities: string;
-    config: WDIOReporterOptions;
+    config: Options.Testrunner;
     specs: string[];
@@ -22,0 +21,0 @@ sessionId?: string;

build/utils.d.ts

@@ -1,4 +0,4 @@
-/// <reference types="webdriver" />
+import { Capabilities } from '@wdio/types';
 export declare function sanitizeString(str?: string): string;
-export declare function sanitizeCaps(caps?: WebDriver.DesiredCapabilities): string;
+export declare function sanitizeCaps(caps?: Capabilities.DesiredCapabilities): string;
 export declare function getErrorsFromEvent(e: {
@@ -5,0 +5,0 @@ errors?: any;

package.json

 {
   "name": "@wdio/reporter",
-  "version": "6.11.0",
+  "version": "7.0.0-beta.0",
   "description": "A WebdriverIO utility to help reporting all events",
   "author": "Christian Bromann <[e-mail]>",
-  "homepage": "https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-reporter",
+  "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-reporter",
   "license": "MIT",
   "main": "./build/index",
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=12.0.0"
   },
@@ -34,6 +34,7 @@ "repository": {
     "@types/cucumber": "^6.0.1",
+    "@wdio/types": "7.0.0-beta.0",
     "fs-extra": "^9.0.0"
   },
   "types": "./build/index.d.ts",
-  "gitHead": "5fba2c2f136f280a0370ac5b76394478e5db3339"
+  "gitHead": "bf31660d60ad4dacf04d11ff1590e794dd377dc0"
 }

README.md

@@ -122,3 +122,3 @@ WebdriverIO Reporter
 
-If your reporter needs to do some async computation after the test (e.g. upload logs to a server) you can overwrite the `isSynchronised` getter method to manage this. By default this property always returns true as most of the reporters don't require to do any async work. However in case you need to handle this overwrite the getter method with an custom implementation (e.g. [wdio-sumologic-reporter](https://github.com/webdriverio/webdriverio/tree/master/packages/wdio-sumologic-reporter)).
+If your reporter needs to do some async computation after the test (e.g. upload logs to a server) you can overwrite the `isSynchronised` getter method to manage this. By default this property always returns true as most of the reporters don't require to do any async work. However in case you need to handle this overwrite the getter method with an custom implementation (e.g. [wdio-sumologic-reporter](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sumologic-reporter)).
 
@@ -125,0 +125,0 @@ ```js

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

38626

decreased by-0.67%

Dependency count

3

increased by50%

Lines of code

590

decreased by-1.34%

Number of low quality alerts

1

increased byInfinity%

Dependency changes

• + Added@wdio/types@7.0.0-beta.0

• + Added@sindresorhus/is@4.6.0(transitive)

• + Added@szmarczak/http-timer@4.0.6(transitive)

• + Added@types/cacheable-request@6.0.3(transitive)

• + Added@types/http-cache-semantics@4.0.4(transitive)

• + Added@types/keyv@3.1.4(transitive)

• + Added@types/node@22.13.1(transitive)

• + Added@types/responselike@1.0.3(transitive)

• + Added@wdio/types@7.0.0-beta.0(transitive)

• + Addedcacheable-lookup@5.0.4(transitive)

• + Addedcacheable-request@7.0.4(transitive)

• + Addedclone-response@1.0.3(transitive)

• + Addeddecompress-response@6.0.0(transitive)

• + Addeddefer-to-connect@2.0.1(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedget-stream@5.2.0(transitive)

• + Addedgot@11.8.6(transitive)

• + Addedhttp-cache-semantics@4.1.1(transitive)

• + Addedhttp2-wrapper@1.0.3(transitive)

• + Addedjson-buffer@3.0.1(transitive)

• + Addedkeyv@4.5.4(transitive)

• + Addedlowercase-keys@2.0.0(transitive)

• + Addedmimic-response@1.0.13.1.0(transitive)

• + Addednormalize-url@6.1.0(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedp-cancelable@2.1.1(transitive)

• + Addedpump@3.0.2(transitive)

• + Addedquick-lru@5.1.1(transitive)

• + Addedresolve-alpn@1.2.1(transitive)

• + Addedresponselike@2.0.1(transitive)

• + Addedundici-types@6.20.0(transitive)

• + Addedwrappy@1.0.2(transitive)