-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
Be less aggressive with error messages when plugins cause errors #1025
Comments
We derive most of our errors messages out the the feedback we get and the questions we get from real users. These error messages just went in We updated these errors to clearly call out the point of origin, and a suggestion that the user must take action to fix it. Here's the issue that documents these errors: If you search in our issues or search gitter you will find that users regularly were confused without this specific wording. They'd have to inspect a stack trace, and even before doing that, they might not recognize the error and have no idea where it's coming from or why. Many times they would ask: "Is there a bug in Cypress?" We wanted to make it super clear that this is something on their end, and this error is happening as part of the test framework as opposed to a software error in Cypress itself. I'll keep this issue open if anyone else has an opinion. You can find the errors and rewrite them and submit a PR if you'd like. |
I think they are just suggesting changing a couple words in the error. 🙃 I agree, the use of the phrase 'an error from' is much clearer than 'error originated from'. Code where these messages can be found:
There are several tests and snapshots that will require updating when changing this message. |
That reasoning makes sense. I've submitted a PR for a minimal change which I think tweaks the tone of this error message. Let me know what you think. |
Released in |
In this bug: cypress-io/cypress-watch-preprocessor#1
The wording of the error message that the user experiences has a fairly aggressive tone. Specifically this line:
The error message could be better phrased to something like "This is an error from your test code."
When building developer tools it's very important to keep DX (developer experience) in mind.
The text was updated successfully, but these errors were encountered: