chore: update type definitions for coverageReporters

[not-a-doctor]

Summary

import { Config } from '@jest/types';

const config: Config.InitialOptions = {
  coverageReporters: ['html', { subdir: 'dir' }] // typing error
}

Typing the config object as Config.InitialOptions resulted in error, because coverageReporters property in Config.InitialOptions was listed as an array of strings.

Test plan

Since there is only a change in typing precision, there is none.

[facebook-github-bot]

Hi @not-a-doctor!

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

[SimenB]

This type is not defined in the docs, do you think it'll be confusing for users?

[not-a-doctor]

I did hesitate a bit editing this line because of the reason you've mentioned. I then searched docs and here in the file we also have a ProjectConfig type in a signature and as "projects" config field definition, although it is not "defined" itself.

Several combinations of options shape make it tedious to list and not pleasant to maintain; and [string, any] type is not quite correct as we are about to become limited to these shapes. While I decided to use the custom TS type, it still is not terrible to leave it as it were before, imo. So what do you think?

[SimenB]

We could link to the types (code)?

[not-a-doctor]

thanks for the tip, done.

[SimenB]

Can you update the versioned docs as well?

[github-actions]

This pull request 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.