@serenity-js/console-reporter 3.0.0-rc.9 → 3.0.1

package/src/stage/crew/console-reporter/SummaryFormatter.ts

@@ -1,12 +1,4 @@
-import {
-    ExecutionCompromised,
-    ExecutionFailedWithAssertionError,
-    ExecutionFailedWithError,
-    ExecutionIgnored,
-    ExecutionSkipped,
-    ExecutionSuccessful,
-    ImplementationPending,
-} from '@serenity-js/core/lib/model';
+import { ExecutionCompromised, ExecutionFailedWithAssertionError, ExecutionFailedWithError, ExecutionIgnored, ExecutionSkipped, ImplementationPending } from '@serenity-js/core/lib/model';
 
 import { AggregatedCategories, AggregatedCategory } from './Summary';
 import { TerminalTheme } from './themes';
@@ -36,6 +28,7 @@ export class SummaryFormatter {
             }),
             ``,
             `Total time: ${ this.theme.heading(aggregatedCategories.totalTime) }`,
+            `Real time: ${ this.theme.heading(aggregatedCategories.realTime) }`,
             `Scenarios:  ${ this.theme.heading(aggregatedCategories.numberOfScenarios) }`,
             '',
         ].join('\n');
@@ -68,7 +61,9 @@ export class SummaryFormatter {
             case ImplementationPending.name:                return 'pending';
             case ExecutionSkipped.name:                     return 'skipped';
             case ExecutionIgnored.name:                     return 'ignored';
-            case ExecutionSuccessful.name:                  return 'successful';
+            // case ExecutionSuccessful.name:
+            default:
+                return 'successful';
         }
     }
 }

package/src/stage/crew/console-reporter/index.ts

@@ -1 +1,2 @@
 export * from './ConsoleReporter';
+export * from './ConsoleReporterConfig';

package/src/stage/crew/console-reporter/themes/TerminalTheme.ts

@@ -1,4 +1,3 @@
-import { AssertionReportDiffer } from '@serenity-js/core/lib/io';
 import { Outcome } from '@serenity-js/core/lib/model';
 
 /**
@@ -10,16 +9,9 @@ import { Outcome } from '@serenity-js/core/lib/model';
  * @abstract
  */
 export abstract class TerminalTheme {
-    /**
-     * @param {@serenity-js/core/lib/io~AssertionReportDiffer} differ
-     */
-    constructor(protected readonly differ: AssertionReportDiffer) {
-    }
-
     abstract heading(...parts: any[]): string;
     abstract outcome(outcome: Outcome | string, ...parts: any[]): string;
     abstract separator(pattern: string): string;
-    abstract diff(expected: string, actual: string): string;
     abstract log(...parts: any[]): string;
 
     /**

package/src/stage/crew/console-reporter/themes/ThemeForColourTerminals.ts

@@ -1,23 +1,13 @@
 /* istanbul ignore file */
 
-import { AssertionReportDiffer } from '@serenity-js/core/lib/io';
-import {
-    ExecutionCompromised,
-    ExecutionFailedWithAssertionError,
-    ExecutionFailedWithError,
-    ExecutionIgnored,
-    ExecutionSkipped,
-    ExecutionSuccessful,
-    ImplementationPending,
-    Outcome,
-} from '@serenity-js/core/lib/model';
-import { Chalk } from 'chalk';  // eslint-disable-line unicorn/import-style
+import { ExecutionCompromised, ExecutionFailedWithAssertionError, ExecutionFailedWithError, ExecutionIgnored, ExecutionSkipped, ImplementationPending, Outcome } from '@serenity-js/core/lib/model';
+import { Chalk } from 'chalk'; // eslint-disable-line unicorn/import-style
 
 import { TerminalTheme } from './TerminalTheme';
 
 /**
  * @desc
- *  Base class for {@link TerminalTheme} implementations intended
+ *  Base class for {@apilink TerminalTheme} implementations intended
  *  to print to terminals that support colour output.
  *
  * @extends {TerminalTheme}
@@ -33,26 +23,19 @@ export abstract class ThemeForColourTerminals extends TerminalTheme {
      * @see https://www.npmjs.com/package/chalk
      */
     constructor(protected readonly chalk: Chalk) {
-        super(new AssertionReportDiffer({
-            expected: line => this.chalk.green(`+ ${ line }`),
-            actual:   line => this.chalk.red(`- ${ line }`),
-            matching: line => `  ${ line }`,
-        }));
+        super();
     }
 
     /**
-     * @desc
-     *  Joins the `parts` into a single string and decorates it
-     *  using a colour appropriate for a given {@link @serenity-js/core/lib/model~Outcome}.
+     * Joins the `parts` into a single string and decorates it
+     * using a colour appropriate for a given {@apilink Outcome}.
      *
-     * @param {@serenity-js/core/lib/model~Outcome | string} outcome
-     *  an instance of an {@link @serenity-js/core/lib/model~Outcome}
+     * @param outcome
+     *  an instance of an {@apilink @serenity-js/core/lib/model~Outcome}
      *  or a string class name of one of its implementations.
      *
-     * @param {...any[]} parts
+     * @param parts
      *  the parts of the message to be decorated
-     *
-     * @returns {string}
      */
     outcome(outcome: Outcome | string, ...parts: any[]): string {
         const outcomeName = (outcome instanceof Outcome)
@@ -70,23 +53,9 @@ export abstract class ThemeForColourTerminals extends TerminalTheme {
             case ExecutionSkipped.name:
             case ExecutionIgnored.name:
                 return this.chalk.blackBright(this.joined(parts));
-            case ExecutionSuccessful.name:
+            // case ExecutionSuccessful.name:
+            default:
                 return this.chalk.green(this.joined(parts));
         }
     }
-
-    /**
-     * @desc
-     *  Turns the serialised `expectedValue` and `actualValue` into
-     *  a visual diff, so that it's easier for the developer to spot
-     *  the difference between the two values.
-     *
-     * @param {string} expectedValue
-     * @param {string} actualValue
-     *
-     * @returns {string}
-     */
-    diff(expectedValue: string, actualValue: string): string {
-        return this.differ.diff(expectedValue, actualValue);
-    }
 }

package/src/stage/crew/console-reporter/themes/ThemeForDarkTerminals.ts

@@ -1,6 +1,6 @@
 /* istanbul ignore file */
 
-import { Chalk } from 'chalk';  // eslint-disable-line unicorn/import-style
+import { Chalk } from 'chalk'; // eslint-disable-line unicorn/import-style
 
 import { ThemeForColourTerminals } from './ThemeForColourTerminals';
 

package/src/stage/crew/console-reporter/themes/ThemeForLightTerminals.ts

@@ -1,6 +1,6 @@
 /* istanbul ignore file */
 
-import { Chalk } from 'chalk';  // eslint-disable-line unicorn/import-style
+import { Chalk } from 'chalk'; // eslint-disable-line unicorn/import-style
 
 import { ThemeForColourTerminals } from './ThemeForColourTerminals';
 

package/src/stage/crew/console-reporter/themes/ThemeForMonochromaticTerminals.ts

@@ -1,4 +1,3 @@
-import { AssertionReportDiffer } from '@serenity-js/core/lib/io';
 import { Outcome } from '@serenity-js/core/lib/model';
 
 import { TerminalTheme } from './TerminalTheme';
@@ -12,13 +11,6 @@ import { TerminalTheme } from './TerminalTheme';
  * @public
  */
 export class ThemeForMonochromaticTerminals extends TerminalTheme {
-    constructor() {
-        super(new AssertionReportDiffer({
-            expected: line => `+ ${ line }`,
-            actual:   line => `- ${ line }`,
-            matching: line => `  ${ line }`,
-        }));
-    }
 
     /**
      * @desc
@@ -34,16 +26,15 @@ export class ThemeForMonochromaticTerminals extends TerminalTheme {
     }
 
     /**
-     * @desc
-     *  Joins the `parts` into a single string.
-     *  Since this class represents a theme for monochromatic terminals,
-     *  no decoration of the text is performed.
+     * Joins the `parts` into a single string.
+     * Since this class represents a theme for monochromatic terminals,
+     * no decoration of the text is performed.
      *
-     * @param {@serenity-js/core/lib/model~Outcome | string} outcome
-     *  an instance of an {@link @serenity-js/core/lib/model~Outcome}
+     * @param outcome
+     *  an instance of an {@apilink Outcome}
      *  or a string class name of one of its implementations.
      *
-     * @param {...any[]} parts
+     * @param parts
      *  the parts of the message
      *
      * @returns {string}
@@ -65,21 +56,6 @@ export class ThemeForMonochromaticTerminals extends TerminalTheme {
         return this.repeat(pattern);
     }
 
-    /**
-     * @desc
-     *  Turns the serialised `expectedValue` and `actualValue` into
-     *  a visual diff, so that it's easier for the developer to spot
-     *  the difference between the two values.
-     *
-     * @param {string} expectedValue
-     * @param {string} actualValue
-     *
-     * @returns {string}
-     */
-    diff(expectedValue: string, actualValue: string): string {
-        return this.differ.diff(expectedValue, actualValue);
-    }
-
     /**
      * @desc
      *  Decorates the log entries that the developer wanted to have captured in the output.

package/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src"
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}

package/tsconfig.eslint.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig",
-  "include": [
-    "src/**/*.ts",
-    "spec/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}