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

Fix the type of $$. #6327

Merged
merged 2 commits into from
Feb 19, 2020
Merged

Conversation

sainthkh
Copy link
Contributor

@sainthkh sainthkh commented Feb 5, 2020

User facing changelog

Fix the type of cy.$$.

Additional details

  • Why was this change necessary?

cy.$$ and Cypress.$ are different. But they use the same type.

  • What is affected by this change?

N/A

  • Any implementation details to explain?

Copied related type from jQuery.d.ts.

How has the user experience changed?

Using jQuery utility functions with cy.$$ like cy.$$.escapeSelector now fails.

PR Tasks

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Feb 5, 2020

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.

@flotwig
Copy link
Contributor

flotwig commented Feb 18, 2020

@sainthkh Just to make sure I understand - this closes #2017 because there was actually not an issue in #2017, but people were confused about escapeSelector, so this PR fixes the $$ type so people won't try to use $$.escapeSelector?

@sainthkh
Copy link
Contributor Author

Yes, you're right.

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.

cy.get does not work with IDs that use characters other than [0-9a-zA-Z\-]+
3 participants