Correctly output messages on skip by method invocation

This fixes #1054 [1].

Why this requires a change to ./test-d/tsconfig.json, but not
./tsconfig.json is beyond me right now. Somehow, when building ./test-d,
Cypress' Mocha-types takes precedence over Mocha's own types, but only
in said project.

[1] #1054

Author: badeball

CHANGELOG.md

@@ -6,6 +6,8 @@ All notable changes to this project will be documented in this file.
 
 - Add support for skipped steps, fixes [#1053](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1053).
 
+- Handle use of `this.skip()` correctly in reports, fixes [#1054](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1054).
+
 ## v18.0.1
 
 - Give each TestStep (from `@cucumber/messages`) a unique ID, fixes [#1034](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1034).

features/reporters/json.feature

@@ -140,7 +140,7 @@ Feature: JSON formatter
       Then it passes
       And there should be a JSON output similar to "fixtures/pending-steps.json"
 
-    Scenario: skipped step
+    Scenario: skipped step through return value
       Given a file named "cypress/e2e/a.feature" with:
         """
         Feature: a feature
@@ -162,6 +162,28 @@ Feature: JSON formatter
       Then it passes
       And there should be a JSON output similar to "fixtures/skipped-steps.json"
 
+    Scenario: skipped step through method invocation
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature
+          Scenario: a scenario
+            Given a preceding step
+            And a skipped step
+            And a succeeding step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { Given } = require("@badeball/cypress-cucumber-preprocessor");
+        Given("a preceding step", function () {})
+        Given("a skipped step", function () {
+          this.skip();
+        });
+        Given("a succeeding step", function () {})
+        """
+      When I run cypress
+      Then it passes
+      And there should be a JSON output similar to "fixtures/skipped-steps.json"
+
     Scenario: retried
       Given additional Cypress configuration
         """

features/reporters/messages.feature

@@ -140,7 +140,7 @@ Feature: messages report
       Then it passes
       And there should be a messages similar to "fixtures/pending-steps.ndjson"
 
-    Scenario: skipped step
+    Scenario: skipped step through return value
       Given a file named "cypress/e2e/a.feature" with:
         """
         Feature: a feature
@@ -162,6 +162,28 @@ Feature: messages report
       Then it passes
       And there should be a messages similar to "fixtures/skipped-steps.ndjson"
 
+    Scenario: skipped step through method invocation
+      Given a file named "cypress/e2e/a.feature" with:
+        """
+        Feature: a feature
+          Scenario: a scenario
+            Given a preceding step
+            And a skipped step
+            And a succeeding step
+        """
+      And a file named "cypress/support/step_definitions/steps.js" with:
+        """
+        const { Given } = require("@badeball/cypress-cucumber-preprocessor");
+        Given("a preceding step", function () {})
+        Given("a skipped step", function () {
+          this.skip();
+        });
+        Given("a succeeding step", function () {})
+        """
+      When I run cypress
+      Then it passes
+      And there should be a messages similar to "fixtures/skipped-steps.ndjson"
+
     Scenario: retried
       Given additional Cypress configuration
         """

lib/browser-runtime.ts

@@ -823,8 +823,13 @@ function afterEachHandler(this: Mocha.Context, context: CompositionContext) {
           timestamp: endTimestamp,
         });
       }
-    } else {
-      for (const skippedStep of remainingSteps) {
+    } else if (this.currentTest?.state === "pending") {
+      if (currentStepStartedAt) {
+        const skippedStep = assertAndReturn(
+          remainingSteps.shift(),
+          "Expected there to be a remaining step"
+        );
+
         const hookIdOrPickleStepId = assertAndReturn(
           skippedStep.hook?.id ?? skippedStep.pickleStep?.id,
           "Expected a step to either be a hook or a pickleStep"
@@ -836,6 +841,61 @@ function afterEachHandler(this: Mocha.Context, context: CompositionContext) {
           hookIdOrPickleStepId,
         });
 
+        taskTestStepFinished(context, {
+          testStepId,
+          testCaseStartedId,
+          testStepResult: {
+            status: messages.TestStepResultStatus.SKIPPED,
+            duration: duration(currentStepStartedAt, endTimestamp),
+          },
+          timestamp: endTimestamp,
+        });
+      }
+
+      for (const remainingStep of remainingSteps) {
+        const hookIdOrPickleStepId = assertAndReturn(
+          remainingStep.hook?.id ?? remainingStep.pickleStep?.id,
+          "Expected a step to either be a hook or a pickleStep"
+        );
+
+        const testStepId = getTestStepId({
+          context,
+          pickleId: pickle.id,
+          hookIdOrPickleStepId,
+        });
+
+        taskTestStepStarted(context, {
+          testStepId,
+          testCaseStartedId,
+          timestamp: endTimestamp,
+        });
+
+        taskTestStepFinished(context, {
+          testStepId,
+          testCaseStartedId,
+          testStepResult: {
+            status: messages.TestStepResultStatus.SKIPPED,
+            duration: {
+              seconds: 0,
+              nanos: 0,
+            },
+          },
+          timestamp: endTimestamp,
+        });
+      }
+    } else {
+      for (const remainingStep of remainingSteps) {
+        const hookIdOrPickleStepId = assertAndReturn(
+          remainingStep.hook?.id ?? remainingStep.pickleStep?.id,
+          "Expected a step to either be a hook or a pickleStep"
+        );
+
+        const testStepId = getTestStepId({
+          context,
+          pickleId: pickle.id,
+          hookIdOrPickleStepId,
+        });
+
         taskTestStepStarted(context, {
           testStepId,
           testCaseStartedId,

test-d/tsconfig.json

@@ -1,7 +1,8 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "noEmit": true
+    "noEmit": true,
+    "types": ["node", "mocha", "cypress"],
   },
   "include": [
     "*.test-d.ts",