Skip to content

Add type for Cypress.automation#7573

Merged
jennifer-shehane merged 2 commits into
cypress-io:developfrom
sainthkh:issue-7519
Jun 4, 2020
Merged

Add type for Cypress.automation#7573
jennifer-shehane merged 2 commits into
cypress-io:developfrom
sainthkh:issue-7519

Conversation

@sainthkh
Copy link
Copy Markdown
Contributor

@sainthkh sainthkh commented Jun 3, 2020

User facing changelog

Added type for Cypress.automation.

Additional details

Why was this change necessary?

Although it's mainly for internal use, some users need it.

What is affected by this change?

N/A

Any implementation details to explain?

N/A

How has the user experience changed?

N/A

PR Tasks

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

@cypress-bot
Copy link
Copy Markdown
Contributor

cypress-bot Bot commented Jun 3, 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.

@sainthkh sainthkh marked this pull request as ready for review June 3, 2020 06:11
Comment thread cli/types/cypress.d.ts Outdated
Comment thread cli/types/tests/cypress-tests.ts Outdated
@jennifer-shehane jennifer-shehane merged commit 128f2eb into cypress-io:develop Jun 4, 2020
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.

Cypress.automation is missing from TypeScript types

3 participants