@serenity-js/mocha 3.25.0 → 3.25.2

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.25.2](https://github.com/serenity-js/serenity-js/compare/v3.25.1...v3.25.2) (2024-07-17)
+
+**Note:** Version bump only for package @serenity-js/mocha
+
+
+
+
+
+## [3.25.1](https://github.com/serenity-js/serenity-js/compare/v3.25.0...v3.25.1) (2024-07-10)
+
+
+### Bug Fixes
+
+* **core:** all the API docs now link to the online Serenity/JS API documentation ([f8f451d](https://github.com/serenity-js/serenity-js/commit/f8f451dffdb4caaa2e31a860f59d59470f4856ad))
+
+
+
+
+
 # [3.25.0](https://github.com/serenity-js/serenity-js/compare/v3.24.1...v3.25.0) (2024-07-03)
 
 **Note:** Version bump only for package @serenity-js/mocha

package/README.md

@@ -17,7 +17,7 @@ of complex software systems faster, more collaborative and easier to scale.
 👋 Join the Serenity/JS Community!
 - Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
 - Find answers to your Serenity/JS questions on the [Serenity/JS Forum](https://github.com/orgs/serenity-js/discussions/categories/how-do-i),
-- Learn how to [contribute to Serenity/JS](https://serenity-js.org/contributing),
+- Learn how to [contribute to Serenity/JS](https://serenity-js.org/community/contributing/),
 - Support the project and gain access to [Serenity/JS Playbooks](https://github.com/serenity-js/playbooks) by becoming a [Serenity/JS GitHub Sponsor](https://github.com/sponsors/serenity-js)!
 
 ## Serenity/JS Mocha

package/lib/adapter/MochaAdapter.d.ts

@@ -4,10 +4,10 @@ import type { Outcome } from '@serenity-js/core/lib/model';
 import type { MochaConfig } from './MochaConfig';
 /**
  * Allows for programmatic execution of Mocha test scenarios,
- * using {@apilink SerenityReporterForMocha} to report progress.
+ * using [`SerenityReporterForMocha`](https://serenity-js.org/api/mocha/function/export=/) to report progress.
  *
  * ## Learn more
- * - {@apilink TestRunnerAdapter}
+ * - [`TestRunnerAdapter`](https://serenity-js.org/api/core-adapter/interface/TestRunnerAdapter/)
  *
  * @group Integration
  */
@@ -32,14 +32,14 @@ export declare class MochaAdapter implements TestRunnerAdapter {
     /**
      * Returns the number of loaded scenarios
      *
-     * @throws {@apilink LogicError}
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  If called before `load`
      */
     scenarioCount(): number;
     /**
      * Runs loaded test scenarios.
      *
-     * @throws {@apilink LogicError}
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  If called before `load`
      */
     run(): Promise<void>;

package/lib/adapter/MochaAdapter.js

@@ -30,10 +30,10 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path")); // eslint-disable-line unicorn/import-style
 /**
  * Allows for programmatic execution of Mocha test scenarios,
- * using {@apilink SerenityReporterForMocha} to report progress.
+ * using [`SerenityReporterForMocha`](https://serenity-js.org/api/mocha/function/export=/) to report progress.
  *
  * ## Learn more
- * - {@apilink TestRunnerAdapter}
+ * - [`TestRunnerAdapter`](https://serenity-js.org/api/core-adapter/interface/TestRunnerAdapter/)
  *
  * @group Integration
  */
@@ -82,7 +82,7 @@ class MochaAdapter {
     /**
      * Returns the number of loaded scenarios
      *
-     * @throws {@apilink LogicError}
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  If called before `load`
      */
     scenarioCount() {
@@ -94,7 +94,7 @@ class MochaAdapter {
     /**
      * Runs loaded test scenarios.
      *
-     * @throws {@apilink LogicError}
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  If called before `load`
      */
     run() {

package/lib/adapter/MochaConfig.d.ts

@@ -38,7 +38,7 @@ export interface MochaConfig {
     /**
      * Only run tests containing this string.
      *
-     * **Note:** {@apilink MochaConfig.fgrep} and {@apilink MochaConfig.grep} are mutually exclusive.
+     * **Note:** [`MochaConfig.fgrep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#fgrep) and [`MochaConfig.grep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#grep) are mutually exclusive.
      */
     fgrep?: string;
     /**
@@ -60,7 +60,7 @@ export interface MochaConfig {
     /**
      * Only run tests matching this string or regexp.
      *
-     * **Note:** {@apilink MochaConfig.grep} and {@apilink MochaConfig.fgrep} are mutually exclusive.
+     * **Note:** [`MochaConfig.grep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#grep) and [`MochaConfig.fgrep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#fgrep) are mutually exclusive.
      */
     grep?: string | RegExp;
     /**
@@ -68,7 +68,7 @@ export interface MochaConfig {
      */
     growl?: boolean;
     /**
-     * Inverts {@apilink MochaConfig.grep} and {@apilink MochaConfig.fgrep} matches.
+     * Inverts [`MochaConfig.grep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#grep) and [`MochaConfig.fgrep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#fgrep) matches.
      */
     invert?: boolean;
     /**

package/lib/index.d.ts

@@ -1,7 +1,7 @@
 import type { MochaOptions, Runner } from 'mocha';
 import { SerenityReporterForMocha } from './SerenityReporterForMocha';
 /**
- * Registers a Mocha reporter that emits {@apilink DomainEvent|Serenity/JS domain events}
+ * Registers a Mocha reporter that emits [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/)
  * and informs Serenity/JS when a test scenario starts, finishes, and with what result.
  */
 declare function bootstrap(runner: Runner, options?: MochaOptions): SerenityReporterForMocha;

package/lib/index.js

@@ -3,7 +3,7 @@ const core_1 = require("@serenity-js/core");
 const io_1 = require("@serenity-js/core/lib/io");
 const SerenityReporterForMocha_1 = require("./SerenityReporterForMocha");
 /**
- * Registers a Mocha reporter that emits {@apilink DomainEvent|Serenity/JS domain events}
+ * Registers a Mocha reporter that emits [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/)
  * and informs Serenity/JS when a test scenario starts, finishes, and with what result.
  */
 function bootstrap(runner, options) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@serenity-js/mocha",
-  "version": "3.25.0",
-  "description": "Serenity/JS adapter for Mocha",
+  "version": "3.25.2",
+  "description": "Serenity/JS test runner adapter for Mocha, enabling the use of the Screenplay Pattern in Mocha-based test suites and leveraging Serenity/JS reporting capabilities",
   "author": {
     "name": "Jan Molak",
     "email": "jan.molak@smartcodeltd.co.uk",
@@ -44,7 +44,7 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/core": "3.25.0"
+    "@serenity-js/core": "3.25.2"
   },
   "peerDependencies": {
     "mocha": "^10.6.0"
@@ -59,5 +59,5 @@
     "ts-node": "10.9.2",
     "typescript": "5.2.2"
   },
-  "gitHead": "22657b685b6002f75b2569db54f4bea31ab91d12"
+  "gitHead": "98b68da1e04a8fcbb255dca509b7bc9c322a3b6b"
 }

package/src/adapter/MochaAdapter.ts

@@ -11,10 +11,10 @@ import type Mocha = require('mocha');
 
 /**
  * Allows for programmatic execution of Mocha test scenarios,
- * using {@apilink SerenityReporterForMocha} to report progress.
+ * using [`SerenityReporterForMocha`](https://serenity-js.org/api/mocha/function/export=/) to report progress.
  *
  * ## Learn more
- * - {@apilink TestRunnerAdapter}
+ * - [`TestRunnerAdapter`](https://serenity-js.org/api/core-adapter/interface/TestRunnerAdapter/)
  *
  * @group Integration
  */
@@ -75,7 +75,7 @@ export class MochaAdapter implements TestRunnerAdapter {
     /**
      * Returns the number of loaded scenarios
      *
-     * @throws {@apilink LogicError}
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  If called before `load`
      */
     scenarioCount(): number {
@@ -89,7 +89,7 @@ export class MochaAdapter implements TestRunnerAdapter {
     /**
      * Runs loaded test scenarios.
      *
-     * @throws {@apilink LogicError}
+     * @throws [`LogicError`](https://serenity-js.org/api/core/class/LogicError/)
      *  If called before `load`
      */
     run(): Promise<void> {

package/src/adapter/MochaConfig.ts

@@ -45,7 +45,7 @@ export interface MochaConfig {
     /**
      * Only run tests containing this string.
      *
-     * **Note:** {@apilink MochaConfig.fgrep} and {@apilink MochaConfig.grep} are mutually exclusive.
+     * **Note:** [`MochaConfig.fgrep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#fgrep) and [`MochaConfig.grep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#grep) are mutually exclusive.
      */
     fgrep?: string;
 
@@ -72,7 +72,7 @@ export interface MochaConfig {
     /**
      * Only run tests matching this string or regexp.
      *
-     * **Note:** {@apilink MochaConfig.grep} and {@apilink MochaConfig.fgrep} are mutually exclusive.
+     * **Note:** [`MochaConfig.grep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#grep) and [`MochaConfig.fgrep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#fgrep) are mutually exclusive.
      */
     grep?: string | RegExp;
 
@@ -82,7 +82,7 @@ export interface MochaConfig {
     growl?: boolean;
 
     /**
-     * Inverts {@apilink MochaConfig.grep} and {@apilink MochaConfig.fgrep} matches.
+     * Inverts [`MochaConfig.grep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#grep) and [`MochaConfig.fgrep`](https://serenity-js.org/api/mocha-adapter/interface/MochaConfig/#fgrep) matches.
      */
     invert?: boolean;
 

package/src/index.ts

@@ -5,7 +5,7 @@ import type { MochaOptions, Runner } from 'mocha';
 import { SerenityReporterForMocha } from './SerenityReporterForMocha';
 
 /**
- * Registers a Mocha reporter that emits {@apilink DomainEvent|Serenity/JS domain events}
+ * Registers a Mocha reporter that emits [Serenity/JS domain events](https://serenity-js.org/api/core-events/class/DomainEvent/)
  * and informs Serenity/JS when a test scenario starts, finishes, and with what result.
  */
 function bootstrap(runner: Runner, options?: MochaOptions): SerenityReporterForMocha {