TypeScript typings errors for ScenarioConfig.config and FeatureConfig.config

[danielrentz]

In https://codecept.io/advanced/#dynamic-configuration it is documented that Scenario().config can be called with (options), (string, options), or (function).

The type signature in types.d.ts is

    class ScenarioConfig {
        config(helper: string | { [key: string]: any; }, obj?: {[key: string]: any; }): this;
    }

which allows (string), (options), (string, options), or (options, options). The function variant is missing completely.

Better signature would be

    class ScenarioConfig {
        config(obj: {[key: string]: any; }): this;
        config(helper: string, obj: {[key: string]: any; }): this;
        config(fn: (test: TestObject) => unknown): this;
    }

(with the correct type for the test object).

Similar but even worse problem for Feature().config: Documentation only shows (options), but types.d.ts contains

    class FeatureConfig {
        config(helper: string | number, obj: any): this;
    }

Btw, in v3.6.10 the type definition of FeatureConfig.config was equal to ScenarioConfig.config, what was the reason for changing it?

[DavertMik]

@danielrentz Please make Pull Request to fix this!
I will pack it in the next patch release

[danielrentz]

@DavertMik
Seems, this issue cannot be solved completely as long as type definitions will be generated from source doc (no support for function overloading). Anyways, will try my best in the MR... :)

[danielrentz]

@DavertMik This happens when I follow the steps in CONTRIBUTING.md:

> npm i --force --omit=optional
> npm run docs
...
building @codecepjs/detox helper docs
[#4 REPLACEINFILE] › ℹ  node_modules/@codeceptjs/detox-helper/Detox.js
[#4 REPLACEINFILE] › ✖  Failed with "ENOENT: no such file or directory, open 'node_modules/@codeceptjs/detox-helper/Detox.js'"  in 0 ms
[#4 REPLACEINFILE] › ⚠  warning   Execution stopped

After that, I tried with optional deps, which brings me a few steps further, but still no success:

> npm i --force
> npm run docs
...
[#26 REPLACEINFILE] › ℹ  docs/helpers/Appium.md
[#26 REPLACEINFILE] › ✔  Finished  in 1 ms
[#27 REPLACEINFILE] › ℹ  docs/helpers/Appium.md
[#27 REPLACEINFILE] › ✔  Finished  in 0 ms
[#28 REPLACEINFILE] › ℹ  docs/helpers/Appium.md
[#28 REPLACEINFILE] › ✔  Finished  in 0 ms
~/github/codeceptjs/runok.js:339
    for (const method of webdriverDoc[0].members.instance) {
                                         ^

TypeError: Cannot read properties of undefined (reading 'members')
    at Object.docsAppium (~/github/codeceptjs/runok.js:339:42)
    at async Object.docsHelpers (~/github/codeceptjs/runok.js:245:9)
    at async Promise.all (index 0)
    at async Object.docs (~/github/codeceptjs/runok.js:29:5)

Node.js v20.13.1

Any advice?

[danielrentz]

@DavertMik Even committing fails:

> git commit -m "fix #4848 ..."
lib/mocha/featureConfig.js 58ms (unchanged)
lib/mocha/scenarioConfig.js 13ms (unchanged)

> [email protected] dtslint
> npm run types-fix && tsd


> [email protected] types-fix
> node typings/fixDefFiles.js

Error reading the file: Error: ENOENT: no such file or directory, open '~/github/codeceptjs/typings/promiseBasedTypes.d.ts'
Error reading the file: Error: ENOENT: no such file or directory, open '~/github/codeceptjs/typings/types.d.ts'

followed by a ton of unrelated (?) type linter errors

[kobenguyent]

@danielrentz well, looks like we need to run npm run def before npm run docs