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.

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

Added missing EventEmitter2 type to Cypress and cy + missing runUrl to Cypress.run() result. #6066

Merged
merged 6 commits into from
Jan 7, 2020

Conversation

sainthkh
Copy link
Contributor

@sainthkh sainthkh commented Dec 31, 2019

User facing changelog

  • EventEmitter2 types like removeListener, removeAllListeners are added to Cypress and cy.
  • Missing runUrl is added to type.

Additional details

Why was this change necessary?

What is affected by this change?

N/A

Any implementation details to explain?

How has the user experience changed?

#5228

Before:

After:
Screenshot from 2019-12-31 11-18-26

PR Tasks

  • Have tests been added/updated?
  • Has the original issue been tagged with a release in ZenHub?
  • [NA] Has a PR for user-facing changes been opened in cypress-documentation?
  • [NA] Have API changes been updated in the type definitions?
  • [NA] Have new configuration options been added to the cypress.schema.json?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Dec 31, 2019

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

  • Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
  • Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

  • The feature/bugfix is self-documenting from within the product.
  • The change provides the end user with a way to fix their problem (no dead ends).

Functionality

  • The code works and performs its intended function with the correct logic.
  • Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
  • The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

  • The code is readable (too many nested 'if's are a bad sign).
  • Names used for variables, methods, etc, clearly describe their function.
  • The code is easy to understood and there are relevant comments explaining.
  • New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
  • There are comments containing link(s) to the addressed issue (in tests and code).

Quality

  • The change does not reimplement code.
  • There's not a module from the ecosystem that should be used instead.
  • There is no redundant or duplicate code.
  • There are no irrelevant comments left in the code.
  • Tests are testing the code’s intended functionality in the best way possible.

Internal

  • The original issue has been tagged with a release in ZenHub.

@sainthkh sainthkh changed the title Added EventEmitter2 type to Cypress and cy. Added missing EventEmitter2 type to Cypress and cy + missing runUrl to Cypress.run() result. Jan 6, 2020
Copy link
Contributor

@bahmutov bahmutov left a comment

Choose a reason for hiding this comment

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

@sainthkh could you cherry-pick or merge d3c3728 into this branch before I land it, please?

@sainthkh
Copy link
Contributor Author

sainthkh commented Jan 7, 2020

@bahmutov Fast-forwarded and fixed typo (rul -> url).

Copy link
Contributor

@bahmutov bahmutov left a comment

Choose a reason for hiding this comment

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

very nice, merging

@robcresswell
Copy link

Thanks so much! Wasn't expecting such a fast turnaround on an issue. Amazing work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants