-
Notifications
You must be signed in to change notification settings - Fork 1k
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.
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
chore: cypress v13.10.0 #5830
chore: cypress v13.10.0 #5830
Conversation
@@ -215,6 +215,7 @@ object: | |||
| `excludeSpecPattern` | `['/snapshots/*', '/image_snapshots/*']` | A String or Array of glob patterns used to ignore spec files that would otherwise be shown in your list of specs. [Please read the notes on using this.](#excludeSpecPattern) | | |||
| `experimentalSingleTabRunMode` | `false` | Run all specs in a single tab, instead of creating a new tab per spec. This can improve run mode performance, but can impact spec isolation and reliability on large test suites. This experiment currently only applies to Component Testing. | | |||
| `slowTestThreshold` | `250` | Time, in milliseconds, to consider a test "slow" during `cypress run`. A slow test will display in orange text in the default reporter. | | |||
| `devServerPublicPathRoute` | `/__cypress/src` | The public path of the dev server in use. We recommend using the Cypress default, but may need to be changed if needed. See [Framework Configuration](/guides/component-testing/component-framework-configuration) or dev server specific documentation (in particular `@cypress/vite-dev-server`). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest
... but may need to be changed if needed. =>
... but may need to be changed.
Sounds otherwise a bit awkward with 2 x need.
Also it looks like prettier doesn't like the misaligned table formatting.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's definitely a bit awkward since there isn't a great place to currently reference the configuration option. It's mostly supposed to be used internal by the bundler dev servers, but we also expose it so people can customize a dev server. Got this updated in 1f5f96c if you want to take another look!
8f9c0c6
to
1f5f96c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for dealing with my comment! LGTM!
docs/guides/references/changelog.mdx
Outdated
|
||
**Features:** | ||
|
||
- Added support for `vite` `v5` to `@cypress/vite-dev-server`. Addresses [#28347](https://github.com/cypress-io/cypress/issues/28347). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to link out to vite v5?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
like the blogpost? https://vitejs.dev/blog/announcing-vite5
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added the blogpost ref in a0e6c6b
| `excludeSpecPattern` | `['/snapshots/*', '/image_snapshots/*']` | A String or Array of glob patterns used to ignore spec files that would otherwise be shown in your list of specs. [Please read the notes on using this.](#excludeSpecPattern) | | ||
| `experimentalSingleTabRunMode` | `false` | Run all specs in a single tab, instead of creating a new tab per spec. This can improve run mode performance, but can impact spec isolation and reliability on large test suites. This experiment currently only applies to Component Testing. | | ||
| `slowTestThreshold` | `250` | Time, in milliseconds, to consider a test "slow" during `cypress run`. A slow test will display in orange text in the default reporter. | | ||
| `devServerPublicPathRoute` | `/__cypress/src` | The public path of the dev server in use. We recommend using the Cypress default, but may need to be changed. See [Framework Configuration](/guides/component-testing/component-framework-configuration) or dev server specific documentation (in particular `@cypress/vite-dev-server`). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would just remove the second sentence since we aren't stating why it may need to be changed.
| `devServerPublicPathRoute` | `/__cypress/src` | The public path of the dev server in use. We recommend using the Cypress default, but may need to be changed. See [Framework Configuration](/guides/component-testing/component-framework-configuration) or dev server specific documentation (in particular `@cypress/vite-dev-server`). | | |
| `devServerPublicPathRoute` | `/__cypress/src` | The public path of the dev server in use. See [Framework Configuration](/guides/component-testing/component-framework-configuration) or dev server specific documentation (in particular `@cypress/vite-dev-server`). | |
Also, why "in particular" the vite-dev-server
? Is there somewhere we can link the users for the dev server documentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean we definitely want to recommend the default unless you need to specify it. We could link the readme in the repository? https://github.com/cypress-io/cypress/blob/develop/npm/vite-dev-server/README.md#compatibility
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It just feels awkward to me since we aren't saying what issues it would cause or when the user should change the value. I would argue that we recommend the default for all of our config unless the user needs to specify it. If we want to discourage setting the value, I would say something like "Use caution overriding the default value as it can have unintended consequences."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK I reworded in a0e6c6b. How does that look?
adds documentation for the cypress v13.10.0 release