Skip to content

Conversation

@sainthkh
Copy link
Contributor

User facing changelog

Added types for config properties appended at runtime.

Additional details

  • Why was this change necessary? => Some runtime config properties are not defined in the type file.
  • What is affected by this change? => N/A

Any implementation details to explain?

I got the list of runtime config properties with the code below:

it('t', () => {
  console.log(Cypress.config())
})

And compared the list of options in server/lib/config_options.ts.

How has the user experience changed?

N/A

Questions

  • I intentionally left some explanations for some properties as ??? because it's hard to guess or track the meaning of them.
  • I intentionally grouped and left no explanation for internal or unlisted properties.

PR Tasks

I intentionally didn't add tests because config types are not tested in the cli tests.

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jan 15, 2021

Thanks for taking the time to open a PR!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could see this also being useful to document.

@sainthkh
Copy link
Contributor Author

@jennifer-shehane Thank you for the feedback. I applied them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

We need to provide types for resolved config object

3 participants