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

Pretty Print toolbox configuration. #11

Open
benjamin-heasly opened this issue Sep 13, 2016 · 0 comments
Open

Pretty Print toolbox configuration. #11

benjamin-heasly opened this issue Sep 13, 2016 · 0 comments
Milestone

Comments

@benjamin-heasly
Copy link
Collaborator

benjamin-heasly commented Sep 13, 2016

Currently tbDeployToolboxes parses the given struct or JSON configuration and decides what to do with it. It's not always clear what it's going to do in advance.

It would help document the ToolboxToolbx and individual configurations if we could also "pretty print" a given configuration. This would write out in a friendly, human-readable way, how the given configuration would be processed.

This could be used to "dry run" a given configuration.

It could also be used as the basis for auto-generated documentation for how to install a toolbox, with or without the ToolboxToolbox.

It could also be used as the basis for documentation about the ToolboxToolbox itself, since we could include the pretty print output along with the usage examples.

As part of implementing this, we could add a describe method to the TbToolboxStrategy class. This would allow specific strategies to describe what they're going to do with a given record.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant