Allow ConsoleFormatter context to be configurable #131
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 allows for custom definitions of how context is defined for executing commands. A passed in context class should implement the following interface: * `current_task_name`: The currently executing task * `register_new_command`: A new command within the current task * `position`: The numerical position of the current command
mattbrictson
changed the title
mattbrictson
approved these changes
Oct 10, 2019
| @@ -65,6 +65,7 @@ Here are the options you can use, and their effects (note that the defaults may | |||
| |`banner`|`nil`|Provide a string (e.g. "Capistrano started!") that will be printed when Capistrano starts up.| | |||
| |`color`|`:auto`|Use `true` or `false` to enable or disable ansi color. If set to `:auto`, Airbrussh automatically uses color based on whether the output is a TTY, or if the SSHKIT_COLOR environment variable is set.| | |||
| |`command_output`|`true`|Set to `:stdout`, `:stderr`, or `true` to display the SSH output received via stdout, stderr, or both, respectively. Set to `false` to not show any SSH output, for a minimal look.| | |||
| |`context`|`Airbrussh::Rake::Context`|Defines the execution context. Targeted towards uses of Airbrussh outside of Rake/Capistrano. Alternate implementations should provide the definition for `current_task_name`, `register_new_command`, and `position`.| | |||
There was a problem hiding this comment.
Great documentation, thanks! 😍
|
I will probably release this sometime next week, as part of 1.4.0. |
|
Yay, Thanks! |
|
Released! 🚢 |
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.
This allows for custom definitions of how context is defined for
executing commands. A passed in context class should implement the following interface:
current_task_name: The currently executing taskregister_new_command: A new command within the current taskposition: The numerical position of the current commandSee #130 for more context.