refactor: Improve list subcommand error reporting #113
+22
−27
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
DavidNix
commented
Mar 24, 2023
Comment on lines
-173
to
-175
| func init() { | ||
| rootCmd.AddCommand(BuildCmd()) | ||
| } |
There was a problem hiding this comment.
I feel init functions are generally an anti-pattern and should be avoided.
Although it can be useful for unique purposes, it is generally not recommended to use package-level init() functions because they can have unintended side effects and make it difficult to reason about the behavior of the code.
Particularly:
- Order of execution is not obvious.
- Global state is generally an anti-pattern.
Comment on lines
+20
to
+30
| var rootCmd = &cobra.Command{ | ||
| Use: "heighliner", | ||
| Short: "Generate docker images for Cosmos chains", | ||
| Long: `Welcome to Heighliner, provided by Strangelove Ventures. | ||
|
|
||
| This tool can generate docker images for all different release versions | ||
| of the configured Cosmos blockchains in chains.yaml`, | ||
| } | ||
|
|
||
| rootCmd.AddCommand(BuildCmd()) | ||
| rootCmd.AddCommand(ListCmd()) |
There was a problem hiding this comment.
Instead, it's super easy to initialize everything scoped to main(). That way, the execution flow (in this case registering subcommands) is in one spot. No indirection.
danbryan
approved these changes
Mar 24, 2023
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.
A sample of the new output: