FED-1855 Update instructions for dart2_upgrade codemod #263
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
greglittlefield-wf
changed the title
Security InsightsNo security relevant content was detected by automated scans. Action Items
Questions or Comments? Reach out on Slack: #support-infosec. |
kealjones-wk
requested changes
Nov 3, 2023
README.md
Outdated
Comment on lines
33
to
38
| over_react component code to be compatible with Dart 2 and the over_react | ||
| builder. | ||
| The `dart2_upgrade` codemod that used to be provided by this package is no longer available. | ||
|
|
||
| Depending on your needs, you may be able to upgrade directly from Dart 1 to | ||
| Dart 2, or you may need to take an intermediary step and provide a version of | ||
| your codebase that is both forwards- and backwards-compatible. Both of these | ||
| options are supported by this codemod. | ||
|
|
||
| - `dart pub global run over_react_codemod:dart2_upgrade --backwards-compat` | ||
|
|
||
| Use this codemod to migrate your over_react code to a format that is both | ||
| forwards-compatible with Dart 2 and backwards-compatible with Dart 1. | ||
|
|
||
| - `dart pub global run over_react_codemod:dart2_upgrade` | ||
|
|
||
| Use this codemod if you want to migrate to Dart 2 compatible code and do not | ||
| need to maintain backwards-compatability with Dart 1. You can run this to | ||
| immediately upgrade from Dart 1 to Dart 2, or you can run this on code that | ||
| has already been run through this codemod with the `--backwards-compat` | ||
| flag once you're ready to drop Dart 1 support. | ||
|
|
||
| For more information on the transition from Dart 1 to Dart 2 and how it affects | ||
| over_react, check out the [over_react Dart 2 migration guide][over_react_dart2]. | ||
| It includes sample diffs of the changes that these codemods will introduce. | ||
| To use it, activate over_react_codemod 1.12.1 instead of the latest: | ||
| ```sh | ||
| dart pub global activate over_react_codemod ^1.12.1 | ||
| ``` | ||
| and see its documentation: https://github.com/Workiva/over_react_codemod/tree/1.12.1#dart-1-to-dart-2-codemod |
There was a problem hiding this comment.
After reading the thread with pat is this accurate? or was the final solution to use 1.1.0? also do they need to use a specific dart version? (2.1.0 Was called out in the chat i think?)
There was a problem hiding this comment.
Mm good catch, will update
There was a problem hiding this comment.
Updated; 84685b9
|
@Workiva/release-management-p |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The README referenced a codemod that had been removed, and didn't describe a path forward.
Changes
Update README to show how to run that codemod.
Release Notes
Review
See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.
Please review:
QA Checklist
Merge Checklist
While we perform many automated checks before auto-merging, some manual checks are needed: