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

TypeScript: strict parameter type for location #5574

Merged
merged 3 commits into from Dec 19, 2019

Conversation

OliverJAsh
Copy link
Contributor

@OliverJAsh OliverJAsh commented Nov 1, 2019

  • Closes

User facing changelog

The type definitions for cy.location() have been improved.

Additional details

cy.location('path') // type error
cy.location('pathname') // ✅

How has the user experience changed?

PR Tasks

@cypress-bot
Copy link

@cypress-bot cypress-bot bot commented Nov 1, 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.

@CLAassistant
Copy link

@CLAassistant CLAassistant commented Nov 1, 2019

CLA assistant check
All committers have signed the CLA.

@jennifer-shehane jennifer-shehane requested a review from Dec 19, 2019
Copy link
Member

@flotwig flotwig left a comment

Thanks for the PR!

I changed it to use keyof Location instead of keyof Window['location'], which is different from what cy.location resolves with when no arguments are passed, updated the return type to use the expected type from Location, and added some tests.

@flotwig flotwig merged commit 78d0536 into cypress-io:develop Dec 19, 2019
35 checks passed
@OliverJAsh
Copy link
Contributor Author

@OliverJAsh OliverJAsh commented Dec 19, 2019

Thank you! Can you ping me when this is released?

@bahmutov
Copy link
Contributor

@bahmutov bahmutov commented Dec 19, 2019

@OliverJAsh our release bot will comment on the issue whenever it gets released, so you will get an email

@cypress-bot
Copy link

@cypress-bot cypress-bot bot commented Dec 26, 2019

Released in 3.8.1.

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.

None yet

4 participants