IParameterTypeDefinition regexp

[yasserf]

Hi! 👋

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch @cucumber/[email protected] for the project I'm working on.

The IParameterTypeDefinition in code supported both RegExp and arrays of them.

Here is the diff that solved my problem:

diff --git a/node_modules/@cucumber/cucumber/lib/support_code_library_builder/types.d.ts b/node_modules/@cucumber/cucumber/lib/support_code_library_builder/types.d.ts
index 27e0f51..13b4fbe 100644
--- a/node_modules/@cucumber/cucumber/lib/support_code_library_builder/types.d.ts
+++ b/node_modules/@cucumber/cucumber/lib/support_code_library_builder/types.d.ts
@@ -39,7 +39,7 @@ export interface IDefineTestRunHookOptions {
 }
 export interface IParameterTypeDefinition<T> {
     name: string;
-    regexp: RegExp;
+    regexp: RegExp | RegExp[];
     transformer: (...match: string[]) => T;
     useForSnippets?: boolean;
     preferForRegexpMatch?: boolean;

This issue body was partially generated by patch-package.

[aurelien-reeves]

Hi :)

Thanks for the report.

Could you please give more details regarding the original issue you were facing?

Did you consider creating a pull request with your changes?

[aslakhellesoy]

The IParameterTypeDefinition interface in Cucumber.js is a wrapper around this constructor signature in the cucumber-expressions library:

https://github.com/cucumber/common/blob/5391796cb49ebc93b83325fcce96af2f59e9a201/cucumber-expressions/javascript/src/ParameterType.ts#L44

I think an even better fix would be to adopt the same type:

regexp: readonly RegExp[] | readonly string[] | RegExp | string

Note that the cucumber-expressions library uses the plural regexps while Cucumber.js uses the singular regexp. It's unfortunate that they are different, but for backwards compatibility reasons I think we should keep regexp.

[yasserf]

The issue i faced was when defining custom parameter types:

For example:

defineParameterType({
  regexp: [/object using (.+)$/, /using object (.+)$/],
  transformer: function (this: World, not_sure: string, name: string) {
    ... does something ...
  },
  useForSnippets: true,
  preferForRegexpMatch: true,
  name: 'object',
})

note: the above example syntax makes no real sense, it's for a POC which I refactored a few times and so don't actually need both, but the library supports it so the typescript patch stayed

I raised the issue because I had a patch via patch-package and it offered to do it via a template, so was pretty quick 🙈

happy to raise a PR in the next few days if noone beats me to it!

[davidjgoss]

@yasserf do you mean you wanted to use an array of regexps but it yielded a TypeScript compilation error (even though it would work at runtime)?

[yasserf]

Yup, I just patched the type but the functionality itself worked as expected This was a few months ago, so I can’t say for certain it’s still the case

…

On Fri, 25 Jun 2021 at 12:42, David Goss ***@***.***> wrote: @yasserf <https://github.com/yasserf> do you mean you wanted to use an array of regexps but it yielded a TypeScript compilation error (even though it would work at runtime)? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1702 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAU3WS6RKTTI6S25PHUIGS3TURMRFANCNFSM47DH7IUA> .

[davidjgoss]

Thanks for confirming @yasserf.

I've pushed a test for the TypeScript typing to this branch, which fails as of now and should pass (along with all existing change) once the change @aslakhellesoy suggests is made.

If you or anyone interested would like to do a PR for this, that would be great.