Add ParameterInfo (#124)

* Add ParameterInfo

* Better typing for ParameterInfo

* Update changelog

* Rename counter to count

Author: aslakhellesoy

CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 - [.NET] Fix casing in "word" parameter type constant
 
+### Added
+- [JavaScript] Add `ParameterInfo` ([#124](https://github.com/cucumber/cucumber-expressions/pull/124))
+
 ## [15.1.1] - 2022-04-21
 ### Fixed
 - [JavaScript] Make `CucumberExpression.ast` public (it was accidentally private in 15.1.0)

docs/index.js

@@ -445,7 +445,8 @@ select {
   background-size: 1.5em 1.5em;
   padding-right: 2.5rem;
   -webkit-print-color-adjust: exact;
-          color-adjust: exact;
+     color-adjust: exact;
+          print-color-adjust: exact;
 }
 
 [multiple] {
@@ -455,7 +456,8 @@ select {
   background-size: initial;
   padding-right: 0.75rem;
   -webkit-print-color-adjust: unset;
-          color-adjust: unset;
+     color-adjust: unset;
+          print-color-adjust: unset;
 }
 
 [type='checkbox'],[type='radio'] {
@@ -464,7 +466,8 @@ select {
           appearance: none;
   padding: 0;
   -webkit-print-color-adjust: exact;
-          color-adjust: exact;
+     color-adjust: exact;
+          print-color-adjust: exact;
   display: inline-block;
   vertical-align: middle;
   background-origin: border-box;
@@ -548,6 +551,7 @@ select {
 }
 
 [type='file']:focus {
+  outline: 1px solid ButtonText;
   outline: 1px auto -webkit-focus-ring-color;
 }
 

docs/index.js.map

@@ -86,12 +86,9 @@ export default class CucumberExpressionGenerator {
     parameterType: ParameterType<unknown>,
     text: string
   ): ParameterTypeMatcher[] {
-    // TODO: [].map
-    const result = []
-    for (const regexp of parameterType.regexpStrings) {
-      result.push(new ParameterTypeMatcher(parameterType, regexp, text))
-    }
-    return result
+    return parameterType.regexpStrings.map(
+      (regexp) => new ParameterTypeMatcher(parameterType, regexp, text)
+    )
   }
 }
 

docs/style.css

@@ -1,4 +1,5 @@
 import ParameterType from './ParameterType.js'
+import { ParameterInfo } from './types.js'
 
 export default class GeneratedExpression {
   constructor(
@@ -16,17 +17,43 @@ export default class GeneratedExpression {
    * @returns {ReadonlyArray.<String>}
    */
   get parameterNames(): readonly string[] {
+    return this.parameterInfos.map((i) => `${i.name}${i.count === 1 ? '' : i.count.toString()}`)
+  }
+
+  /**
+   * Returns an array of ParameterInfo to use in generated function/method signatures
+   */
+  get parameterInfos(): readonly ParameterInfo[] {
     const usageByTypeName: { [key: string]: number } = {}
-    return this.parameterTypes.map((t) => getParameterName(t.name || '', usageByTypeName))
+    return this.parameterTypes.map((t) => getParameterInfo(t, usageByTypeName))
   }
 }
 
-function getParameterName(typeName: string, usageByTypeName: { [key: string]: number }) {
-  let count = usageByTypeName[typeName]
-  count = count ? count + 1 : 1
-  usageByTypeName[typeName] = count
-
-  return count === 1 ? typeName : `${typeName}${count}`
+function getParameterInfo(
+  parameterType: ParameterType<unknown>,
+  usageByName: { [key: string]: number }
+): ParameterInfo {
+  const name = parameterType.name || ''
+  let counter = usageByName[name]
+  counter = counter ? counter + 1 : 1
+  usageByName[name] = counter
+  let type: string | null
+  if (parameterType.type) {
+    if (typeof parameterType.type === 'string') {
+      type = parameterType.type
+    } else if ('name' in parameterType.type) {
+      type = parameterType.type.name
+    } else {
+      type = null
+    }
+  } else {
+    type = null
+  }
+  return {
+    type,
+    name,
+    count: counter,
+  }
 }
 
 function format(pattern: string, ...args: readonly string[]): string {

javascript/src/CucumberExpressionGenerator.ts

@@ -3,8 +3,15 @@ import CucumberExpressionError from './CucumberExpressionError.js'
 const ILLEGAL_PARAMETER_NAME_PATTERN = /([[\]()$.|?*+])/
 const UNESCAPE_PATTERN = () => /(\\([[$.|?*+\]]))/g
 
+interface Constructor<T> extends Function {
+  new (...args: unknown[]): T
+  prototype: T
+}
+
+type Factory<T> = (...args: unknown[]) => T
+
 export default class ParameterType<T> {
-  private transformFn: (...match: readonly string[]) => T
+  private transformFn: (...match: readonly string[]) => T | PromiseLike<T>
 
   public static compare(pt1: ParameterType<unknown>, pt2: ParameterType<unknown>) {
     if (pt1.preferForRegexpMatch && !pt2.preferForRegexpMatch) {
@@ -42,8 +49,8 @@ export default class ParameterType<T> {
   constructor(
     public readonly name: string | undefined,
     regexps: readonly RegExp[] | readonly string[] | RegExp | string,
-    private readonly type: unknown,
-    transform: (...match: string[]) => T,
+    public readonly type: Constructor<T> | Factory<T> | string | null,
+    transform: (...match: string[]) => T | PromiseLike<T>,
     public readonly useForSnippets: boolean,
     public readonly preferForRegexpMatch: boolean
   ) {

javascript/src/GeneratedExpression.ts

@@ -60,7 +60,7 @@ export default function defineDefaultParameterTypes(registry: DefinesParameterTy
     new ParameterType(
       'bigdecimal',
       FLOAT_REGEXP,
-      Number,
+      String,
       (s) => (s === undefined ? null : s),
       false,
       false
@@ -104,7 +104,7 @@ export default function defineDefaultParameterTypes(registry: DefinesParameterTy
     new ParameterType(
       'biginteger',
       INTEGER_REGEXPS,
-      Number,
+      BigInt,
       (s) => (s === undefined ? null : BigInt(s)),
       false,
       false

javascript/src/ParameterType.ts

@@ -9,3 +9,18 @@ export interface Expression {
   readonly source: string
   match(text: string): readonly Argument[] | null
 }
+
+export type ParameterInfo = {
+  /**
+   * The string representation of the original ParameterType#type property
+   */
+  type: string | null
+  /**
+   * The parameter type name
+   */
+  name: string
+  /**
+   * The number of times this name has been used so far
+   */
+  count: number
+}

javascript/src/defineDefaultParameterTypes.ts

@@ -4,6 +4,7 @@ import CucumberExpression from '../src/CucumberExpression.js'
 import CucumberExpressionGenerator from '../src/CucumberExpressionGenerator.js'
 import ParameterType from '../src/ParameterType.js'
 import ParameterTypeRegistry from '../src/ParameterTypeRegistry.js'
+import { ParameterInfo } from '../src/types.js'
 
 class Currency {
   constructor(public readonly s: string) {}
@@ -15,11 +16,11 @@ describe('CucumberExpressionGenerator', () => {
 
   function assertExpression(
     expectedExpression: string,
-    expectedArgumentNames: string[],
+    expectedParameterInfo: ParameterInfo[],
     text: string
   ) {
     const generatedExpression = generator.generateExpressions(text)[0]
-    assert.deepStrictEqual(generatedExpression.parameterNames, expectedArgumentNames)
+    assert.deepStrictEqual(generatedExpression.parameterInfos, expectedParameterInfo)
     assert.strictEqual(generatedExpression.source, expectedExpression)
 
     const cucumberExpression = new CucumberExpression(
@@ -32,7 +33,7 @@ describe('CucumberExpressionGenerator', () => {
         `Expected text '${text}' to match generated expression '${generatedExpression.source}'`
       )
     }
-    assert.strictEqual(match.length, expectedArgumentNames.length)
+    assert.strictEqual(match.length, expectedParameterInfo.length)
   }
 
   beforeEach(() => {
@@ -63,37 +64,110 @@ describe('CucumberExpressionGenerator', () => {
   })
 
   it('generates expression with escaped slashes', () => {
-    assertExpression('The {int}\\/{int}\\/{int} hey', ['int', 'int2', 'int3'], 'The 1814/05/17 hey')
+    assertExpression(
+      'The {int}\\/{int}\\/{int} hey',
+      [
+        {
+          type: 'Number',
+          name: 'int',
+          count: 1,
+        },
+        {
+          type: 'Number',
+          name: 'int',
+          count: 2,
+        },
+        {
+          type: 'Number',
+          name: 'int',
+          count: 3,
+        },
+      ],
+      'The 1814/05/17 hey'
+    )
   })
 
   it('generates expression for int float arg', () => {
     assertExpression(
       'I have {int} cukes and {float} euro',
-      ['int', 'float'],
+      [
+        {
+          type: 'Number',
+          name: 'int',
+          count: 1,
+        },
+        {
+          type: 'Number',
+          name: 'float',
+          count: 1,
+        },
+      ],
       'I have 2 cukes and 1.5 euro'
     )
   })
 
   it('generates expression for strings', () => {
     assertExpression(
       'I like {string} and {string}',
-      ['string', 'string2'],
+      [
+        {
+          type: 'String',
+          name: 'string',
+          count: 1,
+        },
+        {
+          type: 'String',
+          name: 'string',
+          count: 2,
+        },
+      ],
       'I like "bangers" and \'mash\''
     )
   })
 
   it('generates expression with % sign', () => {
-    assertExpression('I am {int}%% foobar', ['int'], 'I am 20%% foobar')
+    assertExpression(
+      'I am {int}%% foobar',
+      [
+        {
+          type: 'Number',
+          name: 'int',
+          count: 1,
+        },
+      ],
+      'I am 20%% foobar'
+    )
   })
 
   it('generates expression for just int', () => {
-    assertExpression('{int}', ['int'], '99999')
+    assertExpression(
+      '{int}',
+      [
+        {
+          type: 'Number',
+          name: 'int',
+          count: 1,
+        },
+      ],
+      '99999'
+    )
   })
 
   it('numbers only second argument when builtin type is not reserved keyword', () => {
     assertExpression(
       'I have {float} cukes and {float} euro',
-      ['float', 'float2'],
+      [
+        {
+          type: 'Number',
+          name: 'float',
+          count: 1,
+        },
+        {
+          type: 'Number',
+          name: 'float',
+          count: 2,
+        },
+      ],
       'I have 2.5 cukes and 1.5 euro'
     )
   })
@@ -103,18 +177,38 @@ describe('CucumberExpressionGenerator', () => {
       new ParameterType('currency', /[A-Z]{3}/, Currency, (s) => new Currency(s), true, false)
     )
 
-    assertExpression('I have a {currency} account', ['currency'], 'I have a EUR account')
+    assertExpression(
+      'I have a {currency} account',
+      [
+        {
+          type: 'Currency',
+          name: 'currency',
+          count: 1,
+        },
+      ],
+      'I have a EUR account'
+    )
   })
 
   it('prefers leftmost match when there is overlap', () => {
     parameterTypeRegistry.defineParameterType(
-      new ParameterType<Currency>('currency', /c d/, Currency, (s) => new Currency(s), true, false)
+      new ParameterType('currency', /c d/, Currency, (s) => new Currency(s), true, false)
     )
     parameterTypeRegistry.defineParameterType(
       new ParameterType('date', /b c/, Date, (s) => new Date(s), true, false)
     )
 
-    assertExpression('a {date} d e f g', ['date'], 'a b c d e f g')
+    assertExpression(
+      'a {date} d e f g',
+      [
+        {
+          type: 'Date',
+          name: 'date',
+          count: 1,
+        },
+      ],
+      'a b c d e f g'
+    )
   })
 
   // TODO: prefers widest match