Fix type members to account for scenario hook names

badeball · badeball · commit 672af4eec58f · 2023-11-04T21:14:28.000+01:00
This fixes #1113 [1]. [1] #1113
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## Unreleased
+
+- Fix type members to account for scenario hook names, fixes [#1113](https://github.com/badeball/cypress-cucumber-preprocessor/issues/1113).
+
 ## v19.0.0
 
 Breaking changes:
diff --git a/lib/browser-runtime.ts b/lib/browser-runtime.ts
@@ -63,7 +63,11 @@ import { runStepWithLogGroup } from "./helpers/cypress";
 
 import { getTags } from "./helpers/environment";
 
-import { IHookParameter, IStepHookParameter } from "./public-member-types";
+import {
+  IHookOptions,
+  IHookParameter,
+  IStepHookParameter,
+} from "./public-member-types";
 
 type Node = ReturnType<typeof parse>;
 
@@ -279,10 +283,7 @@ function getTestStepId(options: {
 function createStepDescription({
   name,
   tags,
-}: {
-  name?: string;
-  tags?: string;
-}): string | undefined {
+}: IHookOptions): string | undefined {
   if (name == null && tags == null) {
     return;
   } else if (name == null) {
diff --git a/lib/entrypoint-browser.ts b/lib/entrypoint-browser.ts
@@ -30,6 +30,7 @@ import {
   IStepHookBody,
   IParameterTypeDefinition,
   IStepDefinitionBody,
+  IHookOptions,
 } from "./public-member-types";
 
 import {
@@ -66,10 +67,10 @@ function defineParameterType<T, C extends Mocha.Context>(
   getRegistry().defineParameterType(options);
 }
 
-function defineBefore(options: { tags?: string }, fn: IHookBody): void;
+function defineBefore(options: IHookOptions, fn: IHookBody): void;
 function defineBefore(fn: IHookBody): void;
 function defineBefore(
-  optionsOrFn: IHookBody | { tags?: string },
+  optionsOrFn: IHookBody | IHookOptions,
   maybeFn?: IHookBody
 ) {
   if (typeof optionsOrFn === "function") {
@@ -81,10 +82,10 @@ function defineBefore(
   }
 }
 
-function defineAfter(options: { tags?: string }, fn: IHookBody): void;
+function defineAfter(options: IHookOptions, fn: IHookBody): void;
 function defineAfter(fn: IHookBody): void;
 function defineAfter(
-  optionsOrFn: IHookBody | { tags?: string },
+  optionsOrFn: IHookBody | IHookOptions,
   maybeFn?: IHookBody
 ) {
   if (typeof optionsOrFn === "function") {
@@ -96,10 +97,10 @@ function defineAfter(
   }
 }
 
-function defineBeforeStep(options: { tags?: string }, fn: IStepHookBody): void;
+function defineBeforeStep(options: IHookOptions, fn: IStepHookBody): void;
 function defineBeforeStep(fn: IStepHookBody): void;
 function defineBeforeStep(
-  optionsOrFn: IStepHookBody | { tags?: string },
+  optionsOrFn: IStepHookBody | IHookOptions,
   maybeFn?: IStepHookBody
 ) {
   if (typeof optionsOrFn === "function") {
@@ -111,10 +112,10 @@ function defineBeforeStep(
   }
 }
 
-function defineAfterStep(options: { tags?: string }, fn: IStepHookBody): void;
+function defineAfterStep(options: IHookOptions, fn: IStepHookBody): void;
 function defineAfterStep(fn: IStepHookBody): void;
 function defineAfterStep(
-  optionsOrFn: IStepHookBody | { tags?: string },
+  optionsOrFn: IStepHookBody | IHookOptions,
   maybeFn?: IStepHookBody
 ) {
   if (typeof optionsOrFn === "function") {
diff --git a/lib/entrypoint-node.ts b/lib/entrypoint-node.ts
@@ -5,6 +5,7 @@ import {
   IStepHookBody,
   IParameterTypeDefinition,
   IStepDefinitionBody,
+  IHookOptions,
 } from "./public-member-types";
 
 export {
@@ -74,44 +75,44 @@ export function attach(data: string | ArrayBuffer, mediaType?: string) {
   throw createUnimplemented();
 }
 
-export function Before(options: { tags?: string }, fn: IHookBody): void;
+export function Before(options: IHookOptions, fn: IHookBody): void;
 export function Before(fn: IHookBody): void;
 export function Before(
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  optionsOrFn: IHookBody | { tags?: string },
+  optionsOrFn: IHookBody | IHookOptions,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   maybeFn?: IHookBody
 ) {
   throw createUnimplemented();
 }
 
-export function After(options: { tags?: string }, fn: IHookBody): void;
+export function After(options: IHookOptions, fn: IHookBody): void;
 export function After(fn: IHookBody): void;
 export function After(
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  optionsOrFn: IHookBody | { tags?: string },
+  optionsOrFn: IHookBody | IHookOptions,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   maybeFn?: IHookBody
 ) {
   throw createUnimplemented();
 }
 
-export function BeforeStep(options: { tags?: string }, fn: IStepHookBody): void;
+export function BeforeStep(options: IHookOptions, fn: IStepHookBody): void;
 export function BeforeStep(fn: IStepHookBody): void;
 export function BeforeStep(
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  optionsOrFn: IStepHookBody | { tags?: string },
+  optionsOrFn: IStepHookBody | IHookOptions,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   maybeFn?: IStepHookBody
 ) {
   throw createUnimplemented();
 }
 
-export function AfterStep(options: { tags?: string }, fn: IStepHookBody): void;
+export function AfterStep(options: IHookOptions, fn: IStepHookBody): void;
 export function AfterStep(fn: IStepHookBody): void;
 export function AfterStep(
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  optionsOrFn: IStepHookBody | { tags?: string },
+  optionsOrFn: IStepHookBody | IHookOptions,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   maybeFn?: IStepHookBody
 ) {
diff --git a/lib/public-member-types.ts b/lib/public-member-types.ts
@@ -6,6 +6,11 @@ export interface IParameterTypeDefinition<T, C extends Mocha.Context> {
   transformer: (this: C, ...match: string[]) => T;
 }
 
+export interface IHookOptions {
+  name?: string;
+  tags?: string;
+}
+
 export interface IHookBody {
   (this: Mocha.Context, options: IHookParameter): void;
 }
diff --git a/lib/registry.ts b/lib/registry.ts
@@ -23,6 +23,7 @@ import {
   IParameterTypeDefinition,
   IStepDefinitionBody,
   IHookParameter,
+  IHookOptions,
 } from "./public-member-types";
 
 import {
@@ -163,7 +164,7 @@ export class Registry {
 
   public defineHook(
     keyword: ScenarioHookKeyword,
-    options: { tags?: string },
+    options: IHookOptions,
     fn: IHookBody
   ) {
     this.preliminaryHooks.push(
@@ -176,17 +177,17 @@ export class Registry {
     );
   }
 
-  public defineBefore(options: { tags?: string }, fn: IHookBody) {
+  public defineBefore(options: IHookOptions, fn: IHookBody) {
     this.defineHook("Before", options, fn);
   }
 
-  public defineAfter(options: { tags?: string }, fn: IHookBody) {
+  public defineAfter(options: IHookOptions, fn: IHookBody) {
     this.defineHook("After", options, fn);
   }
 
   public defineStepHook(
     keyword: StepHookKeyword,
-    options: { tags?: string },
+    options: IHookOptions,
     fn: IStepHookBody
   ) {
     this.stepHooks.push(
@@ -199,11 +200,11 @@ export class Registry {
     );
   }
 
-  public defineBeforeStep(options: { tags?: string }, fn: IStepHookBody) {
+  public defineBeforeStep(options: IHookOptions, fn: IStepHookBody) {
     this.defineStepHook("BeforeStep", options, fn);
   }
 
-  public defineAfterStep(options: { tags?: string }, fn: IStepHookBody) {
+  public defineAfterStep(options: IHookOptions, fn: IStepHookBody) {
     this.defineStepHook("AfterStep", options, fn);
   }
 
diff --git a/test-d/entrypoint-browser.test-d.ts b/test-d/entrypoint-browser.test-d.ts
@@ -146,7 +146,7 @@ Before({}, function () {
   expectType<Mocha.Context>(this);
 });
 
-Before({ tags: "foo" }, function () {
+Before({ tags: "foo", name: "bar" }, function () {
   expectType<Mocha.Context>(this);
 });
 
@@ -158,7 +158,7 @@ After({}, function () {
   expectType<Mocha.Context>(this);
 });
 
-After({ tags: "foo" }, function () {
+After({ tags: "foo", name: "bar" }, function () {
   expectType<Mocha.Context>(this);
 });
 
@@ -196,7 +196,7 @@ BeforeStep(
 );
 
 BeforeStep(
-  { tags: "foo" },
+  { tags: "foo", name: "bar" },
   function ({
     pickle,
     pickleStep,
@@ -247,7 +247,7 @@ AfterStep(
 );
 
 AfterStep(
-  { tags: "foo" },
+  { tags: "foo", name: "bar" },
   function ({
     pickle,
     pickleStep,
diff --git a/test-d/entrypoint-node.test-d.ts b/test-d/entrypoint-node.test-d.ts
@@ -146,7 +146,7 @@ Before({}, function () {
   expectType<Mocha.Context>(this);
 });
 
-Before({ tags: "foo" }, function () {
+Before({ tags: "foo", name: "bar" }, function () {
   expectType<Mocha.Context>(this);
 });
 
@@ -158,7 +158,7 @@ After({}, function () {
   expectType<Mocha.Context>(this);
 });
 
-After({ tags: "foo" }, function () {
+After({ tags: "foo", name: "bar" }, function () {
   expectType<Mocha.Context>(this);
 });
 
@@ -196,7 +196,7 @@ BeforeStep(
 );
 
 BeforeStep(
-  { tags: "foo" },
+  { tags: "foo", name: "bar" },
   function ({
     pickle,
     pickleStep,
@@ -247,7 +247,7 @@ AfterStep(
 );
 
 AfterStep(
-  { tags: "foo" },
+  { tags: "foo", name: "bar" },
   function ({
     pickle,
     pickleStep,

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,11 @@ export interface IParameterTypeDefinition<T, C extends Mocha.Context> {`
`6`	`6`	`transformer: (this: C, ...match: string[]) => T;`
`7`	`7`	`}`
`8`	`8`
	`9`	`+export interface IHookOptions {`
	`10`	`+ name?: string;`
	`11`	`+ tags?: string;`
	`12`	`+}`
	`13`	`+`
`9`	`14`	`export interface IHookBody {`
`10`	`15`	`(this: Mocha.Context, options: IHookParameter): void;`
`11`	`16`	`}`