-
Notifications
You must be signed in to change notification settings - Fork 44
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
chore: Binaries incmd
folder, examples in examples
folder
#501
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to change all the files under cli/
that have the package name cmd
to cli
cmd
foldercmd
folder, examples in examples
folder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! made a minor non-blocking follow up comment.
Co-authored-by: Shahzad Lone <[email protected]>
da56713
to
ff93e45
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Thought: Not a blocker on this PR, but was wondering if there is a benefit if we included a subcommand on the main defra binary called tools
which may include docsgen
, mangen
, and future cli-completions
stuff.
Can be done in a diff PR down the line tho.
My first impression is that I'm in favor of it. It would allow to provide infrequently used tools in a CLI sub-namespace. As I understand it would require a different pattern than what is introduced in this PR. Taking note of it as a potential idea for CLI structure. Thanks. |
RELEVANT ISSUE(S)
Resolves #500
DESCRIPTION
As described in the issue:
Use
/cmd/
as the place for all our binaries,defradb
, cmd docs generator, man pages generator (upcoming), etc. CLI remains as a package under/cli/
. This is scalable and idiomatic to Go. Additionally introduces convenience for the cmd docs generator.HOW HAS THIS BEEN TESTED?
Manual testing.
CHECKLIST:
ENVIRONMENT / OS THIS WAS TESTED ON?
Please specify which of the following was this tested on (remove or add your own):