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

[WIP] #2690 Decaffeinate action commands and their tests #6148

Closed
wants to merge 18 commits into from
Closed

[WIP] #2690 Decaffeinate action commands and their tests #6148

wants to merge 18 commits into from

Conversation

clarmso
Copy link
Contributor

@clarmso clarmso commented Jan 13, 2020

Converting the source code for the Cypress action commands and their tests from Coffeescript to Javascript is a part of the code maintenance. Having the source code in Javascript (and eventually Typescript) let the developers to utilize tools such as eslint and produce more robust code.

The command npm run decaffeinate-bulk convert has been used to convert the files.

A part of #2690

User facing changelog

Convert the source code for the Cypress action commands from Coffeescript to Javascript.

Additional details

Other than the maintainers of the driver package, no one else should be affected by this change. Most of the conversion has been automatically generated by the bulk-decaffeinate script. In addition, the eslint issues discovered right after the conversion have been addressed.

How has the user experience changed?

There should be no changes in the commands' functionalities. If there are differences before and after this change, this PR should not be merged.

PR Tasks

  • Have tests been added/updated?

@cypress-bot
Copy link
Contributor

cypress-bot bot commented Jan 13, 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.

@jennifer-shehane
Copy link
Member

@clarmso I know there isn't a great guide to how to run decaffeination, but since we do not squash the commits from a decaffeination PR, we prefer there be a minimal amount of commits, so conversion should be done in bulk instead of one by one (which creates 4 commits for each file. Then rebase any additional changes that are required by hand.

Task definitions here: https://github.com/cypress-io/cypress/blob/v4.0-release/.vscode/tasks.json#L13:L13

So, for this commit find a way to bulk decaffeinate all together or split them up into smaller PRs if necessary.

@sainthkh
Copy link
Contributor

sainthkh commented Jan 13, 2020

Hello. Thank you for all the hard works doing decaff.

Currently, there are too many commits for this PR. To fix that problem, you can rearrange and merge them with "interactive rebase". Personally, I use gitkraken to do that.

That's how I created PRs like #6075.

@clarmso
Copy link
Contributor Author

clarmso commented Jan 13, 2020

Ok. Will do!

@clarmso clarmso deleted the #2690-command-actions branch January 13, 2020 14:36
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.

3 participants