Improved language around --nodelete flag in push and pull commands #4659
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
This comment has been minimized.
This comment has been minimized.
EvilGenius13
force-pushed
the
fix-issue-225
branch
from
e564d29
to
be2df96
Compare
Coverage report
Show files with reduced coverage 🔻
Test suite run success1917 tests passing in 871 suites. Report generated by 🧪jest coverage report action from 58768c3 |
EvilGenius13
force-pushed
the
fix-issue-225
branch
from
be2df96
to
41505c2
Compare
graygilmore
approved these changes
Oct 16, 2024
EvilGenius13
force-pushed
the
fix-issue-225
branch
4 times, most recently
from
412b5e3
to
0a344c9
Compare
karreiro
reviewed
Oct 17, 2024
There was a problem hiding this comment.
Thank you for this PR, @EvilGenius13!
I've left only one minor suggestion — please feel free to adopt a different version from mine, following a similar idea :)
| @@ -33,7 +33,7 @@ If no theme is specified, then you're prompted to select the theme to pull from | |||
| }), | |||
| nodelete: Flags.boolean({ | |||
| char: 'n', | |||
| description: 'Runs the pull command without deleting local files.', | |||
| description: 'Prevent deleting local files that have been removed remotely.', | |||
There was a problem hiding this comment.
We don't know if the given files ever exist remotely, so I'd update this to something like this:
Suggested change
| description: 'Prevent deleting local files that have been removed remotely.', | |
| description: 'Prevent deleting local files that that do not exist remotely.', |
| @@ -65,7 +65,7 @@ export default class Push extends ThemeCommand { | |||
| }), | |||
| nodelete: Flags.boolean({ | |||
| char: 'n', | |||
| description: 'Runs the push command without deleting local files.', | |||
| description: 'Prevent deleting remote files that have been removed locally.', | |||
There was a problem hiding this comment.
Adopting the same reasoning:
Suggested change
| description: 'Prevent deleting remote files that have been removed locally.', | |
| description: 'Prevent deleting remote files that that do not exist locally.', |
jamesmengo
approved these changes
Oct 17, 2024
|
The final edits are |
EvilGenius13
force-pushed
the
fix-issue-225
branch
from
0a344c9
to
52f6d78
Compare
This commit updates the language around the --nodelete flag in the push and pull commands to make it more clear what files are being affected by the flag.
EvilGenius13
force-pushed
the
fix-issue-225
branch
from
52f6d78
to
58768c3
Compare
karreiro
approved these changes
Oct 22, 2024
|
@Shopify/app-inner-loop could someone please take a look at this? Thanks so much! |
isaacroldan
approved these changes
Oct 25, 2024
jamesmengo
added
the
#gsd:40767
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.
WHY are these changes introduced?
Create some clarity around wording for
--nodeleteflagCloses: https://github.com/Shopify/develop-advanced-edits/issues/225
WHAT is this pull request doing?
Updating the language for the
--nodeleteflag on push and pull commandsHow to test your changes?
Purely documentation changes but you can see them by
Running:
shopify theme push --helpshopify theme pull --helpMeasuring impact
How do we know this change was effective? Please choose one:
Checklist