react-native-community / upgrade-helper

⚛️ A web tool to support React Native developers in upgrading their apps.
https://react-native-community.github.io/upgrade-helper
MIT License
3.67k stars 112 forks source link

Replace `RnDiffApp` in the diff content #234

Closed lucasbento closed 4 years ago

lucasbento commented 4 years ago

Summary

Currently we are only replacing the rndiffapp name in file paths, this PR replaces the RnDiffApp mentions in the diff changes as well.

Fixes #227. Fixes #230.

Test Plan

  1. Add app name in settings button;
  2. Check that the path has been replaced with the name provided;
  3. Make sure that the View file button works fine;
  4. Check that the content of files like Podfile has the name provided.

Checklist

pvinis commented 4 years ago

This looks great.

I remember we talk about this, when we click to view the file, the name is, of course, rndiffapp in there. I can't remember what we decided on, but I think just leaving it as it is now is fine. If we plan to leave it like that, could we maybe add an alert or a popup tooltip or something, so when the user has changed the project name, and is about to click on view/download file, to get a notice that they should make sure they replace manually RnDiffApp with <name from input field> and rndiffapp with <name from input field in lowercase>?

What are your thoughts on this, before we merge this one?

lucasbento commented 4 years ago

@pvinis: get a notice that they should make sure they replace manually RnDiffApp with and rndiffapp with ?

Hmm, this makes a lot of sense.

I think we could add the small text that we have at the useful content section.

What we could do is:

  1. Show an alert after clicking on View file with that small text. ✅ Alert should be shown only after clicking the button ✅ Alert should be shown only once, if the user clicks another View file it should go directly ❌ If the user reloads the page they will see the alert again which can be very annoying.
  2. Show tooltip with small text when hovering View file ✅ Very small ❌ Perhaps too small, can be unnoticeable ❌ Maybe weird? not sure

Thoughts?

vamshi9666 commented 4 years ago

when clicked on view file , raw file is shown in new browser window.App name is still not reflecting there. checked in deploy preview.

lucasbento commented 4 years ago

@vamshi9666: when clicked on view file , raw file is shown in new browser window.App name is still not reflecting there. checked in deploy preview.

Yeah, this is something that we can't change as it leads to a file on GitHub itself.

Do you have any suggestions on what to do regarding this?