Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

testTimeout is not documented in the config docs #9448

Closed
mriedem opened this issue Jan 22, 2020 · 1 comment · Fixed by #9449
Closed

testTimeout is not documented in the config docs #9448

mriedem opened this issue Jan 22, 2020 · 1 comment · Fixed by #9449
Labels
Bug Report Needs Triage

Comments

@mriedem
Copy link
Contributor

mriedem commented Jan 22, 2020

🐛 Bug Report

The testTimeout configuration option is not documented here:

https://jestjs.io/docs/en/configuration

It's documented in the CLI options:

https://jestjs.io/docs/en/cli#--testtimeoutnumber

And it's available in the code for the config:

https://github.com/facebook/jest/blob/89c151b69f81baba49caeceec19f07b4bc2680cc/packages/jest-config/src/ValidConfig.ts#L118

To Reproduce

n/a - just docs

Expected behavior

It'd be nice to not have to dig into source code or play with things to confirm what is possible for config if the docs tell me what is available.

Link to repl or repo (highly encouraged)

n/a

envinfo

$ npx envinfo --preset jest
npx: installed 1 in 1.121s

  System:
    OS: Linux 5.3 Ubuntu 18.04.3 LTS (Bionic Beaver)
    CPU: (8) x64 Intel(R) Core(TM) i7-8850H CPU @ 2.60GHz
  Binaries:
    Node: 13.5.0 - /usr/bin/node
    npm: 6.13.4 - /usr/bin/npm
  npmPackages:
    jest: ^24.9.0 => 24.9.0
mriedem added a commit to mriedem/jest that referenced this issue Jan 22, 2020
@mriedem
Document testTimeout configuration option
9dba8b9 
The `testTimeout` configuration option was documented in the CLI docs but not the configuration docs so I wasn't completely sure if it was available to use in my package.json configuration, so I needed to try it and also dig into the jest source code to confirm. This simply documents the option in the config docs as well.

Fixes jestjs#9448 9448
@mriedem mriedem mentioned this issue Jan 22, 2020
Merged
mriedem added a commit to mriedem/jest that referenced this issue Jan 23, 2020
@mriedem
Document testTimeout configuration option
47aa6ba 
The `testTimeout` configuration option was documented
in the CLI docs but not the configuration docs so I wasn't
completely sure if it was available to use in my
package.json configuration, so I needed to try it and also
dig into the jest source code to confirm. This simply
documents the option in the config docs as well.

Fixes jestjs#9448
@github-actions
Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Bug Report Needs Triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document testTimeout configuration option mriedem/jest
1 participant
@mriedem