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

Add progress tracker and message for CLI while cloning a template #1888

Merged
merged 6 commits into from
Jul 31, 2023

Conversation

hpmellema
Copy link
Contributor

Description of changes:
Adds a progress tracker class that can be used to execute a progress tracker for the CLI while waiting for a set of commands to execute. This PR adds the progress tracker to cloning of templates in the init command as that action can take multiple seconds to complete.

Additional loading bars and progress tracker styles could be added in the future.

Example Execution gif:
cli

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@hpmellema hpmellema requested a review from a team as a code owner July 28, 2023 15:32
@hpmellema hpmellema force-pushed the add-copying-message branch from 4251ac5 to 209cd47 Compare July 28, 2023 18:43
Copy link
Member

@mtdowling mtdowling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works, thanks. I think we can improve the style/updater APIs in the future to improve them a bit more (e.g., one idea is to make the update value a generic parameter of the style and update class, then allow update messages to be sent to the updater which then sends it to the styler, allowing progress bars, messages, etc).

@hpmellema hpmellema merged commit 5cc75a6 into smithy-lang:main Jul 31, 2023
@hpmellema hpmellema deleted the add-copying-message branch July 31, 2023 16:54
syall pushed a commit to Xtansia/smithy that referenced this pull request Aug 11, 2023
…ithy-lang#1888)

Adds a progress tracker for long running CLI tasks. The progress tracker currently supports a simple repeated dots pattern to indicate execution of a long running task. The progress tracker can be extended in the future to support progress bars and additional loading messages.
alextwoods pushed a commit to alextwoods/smithy that referenced this pull request Sep 15, 2023
…ithy-lang#1888)

Adds a progress tracker for long running CLI tasks. The progress tracker currently supports a simple repeated dots pattern to indicate execution of a long running task. The progress tracker can be extended in the future to support progress bars and additional loading messages.
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.

2 participants