Move withProgress and associated code to a separate file#2202
Merged
robertbrignull merged 3 commits intomainfrom Mar 22, 2023
Merged
Move withProgress and associated code to a separate file#2202robertbrignull merged 3 commits intomainfrom
robertbrignull merged 3 commits intomainfrom
Conversation
koesie10
approved these changes
Mar 22, 2023
8006bf6 to
408c042
Compare
This file contains hidden or 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
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.
Thoughts: would it be clearer to move
withProgressand associated code and types to a separate file, so it's not as linked tocommandRunner?I think this will make even more sense as we continue with the "typed commands" migration and essentially remove all usages of
commandRunnerWithProgress, because tracking progress is now explicitly something that's done within the command rather than it appearing to be an intrinsic property of the command. I think separating the code will make it more clear that displaying/tracking progress is completely separate from running a command.This PR is quite large because of the number of other files that import these types and methods. The only change here is moving code around, and a slight change to method documentation. I remove some bits saying to avoid using
withProgressdirectly and to usecommandRunnerinstead. I think with this code move it's clearer what each piece of code does, so this explanation isn't necessary.Checklist
ready-for-doc-reviewlabel there.