refactor: major overhaul of API #9
Merged
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
arikkfir
added
refactor
arikkfir
force-pushed
the
arikkfir/refactor
branch
3 times, most recently
from
de34d76
to
1d53c7c
Compare
This refactor overhauls the API in preparation for v1.0.0. Following major changes have been applied: - Users now implement the Executor interface, instead of the Command interface. The Command object is now the container for a single command, created via the "New" factory. - Configuration schema is read from the given Executor instance's type. Any field in that struct can be a potential flag or args target. The API now allows customization of such flags via struct field tags (to be documented). Configuration can be nested in multi-level structs for grouping and reuse. - Commands can also be created via "MustNew" which panics if command creation fails. - Better command hierarchy with clear definition of which flags are inherited from parent commands to child commands. - Improved help & usage screens - Better code & file structure - Add golang CI linting
arikkfir
force-pushed
the
arikkfir/refactor
branch
from
1d53c7c
to
88e5df1
Compare
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 refactor overhauls the API in preparation for v1.0.0.
Following major changes have been applied:
interface. The Command object is now the container for a single
command, created via the "New" factory.
Any field in that struct can be a potential flag or args target. The
API now allows customization of such flags via struct field tags (to
be documented). Configuration can be nested in multi-level structs for
grouping and reuse.
creation fails.
inherited from parent commands to child commands.