Wrong config types in type declaration files

[jereaameli]

Current behavior:

When running Cypress through a script made in TypeScript, there are conflicts with the current Type Definitions with the actual configs supported.

There are some configs that accept both strings (path to a file / folder) or false to disable that options. The properties I have found that meet this criteria are fixturesFolder, supportFile and pluginsFile, but there could be more.

The type declarations for this config properties accept only strings as values, as seen here.

Screenshot of error thrown in VSCode:

Desired behavior:

false should be a valid value for this mentioned configs.

Example of correct type declaration:

pluginsFile: string | false

Test code to reproduce

// cypressScript.ts
import { run } from 'cypress';

const runConfig = {
  config: {
    pluginsFile: false,
  }
}

run(runConfig);

npx tsc cypressScript.ts

Versions

Cypress 4.8.0
OS: macOS Catalina 10.15.3

[jennifer-shehane]

Opened a PR to fix this here: #7674

[cypress-bot]

The code for this is done in cypress-io/cypress#7674, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 4.9.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v4.9.0, please open a new issue.