feat: standalone cli #235
Merged
feat: standalone cli #235
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
sh0rez
added
kind/enhancement
Takes the required parts from `spf13/cobra` in a heavily simplified way and adds these to `pkg/cli` so that we can become independent of that massive library, which we use only a small subset from. In the future, this new package is supposed to integrate more tightly with `posener/complete`, so we have a fully integrated cli package that fits our needs: - command parsing - arbitrary flag position - native (non-script) suggestions - struct based API
Works without, no need to clutter that type
Adds native support for CLI argument and flag completion, but also validation of arguments.
Migrates from `spf13/cobra` to our very own implementation in `pkg/cli`, which is much simpler (less features, only the ones we need) and contains native support for CLI completions.
Adds a command to each app to install the CLI completions
Causes formatting changes, which we do not want.
rfratto
reviewed
Mar 17, 2020
There was a problem hiding this comment.
LGTM, have one nit.
I do want to say that I only validated this for correctness. I put off reviewing this for so long because introducing more internal complexity that we have to maintain ourselves makes me a little nervous. I shared these thoughts with @sh0rez and he agrees.
Overall, I don't think this is a lot of code we're adding, so I don't think it's that much of an issue, and I trust the judgment on making the call to replace Cobra with something slimmer. I personally would like to see this brought out of the repository though and made into its own project.
rfratto
reviewed
Mar 17, 2020
Moves the pkg/cli package out of tree to https://github.com/go-clix/cli
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.
Big PR implementing the parts of
spf13/cobrawe actually use ... turns out not that much after all.Motivation behind this was that
spf13/cobrais a big library with many dependencies, that we don't use altogether. Furthermore, we want native completion usingposener/complete, which I hacked upon cobra in an ugly way.The new package
pkg/clihas clearly defined interfaces for all tasks we need, a simplecli.Commandstruct with only the most basic features (enough for 90% of the cases) which fits exactly what Tanka needs.I expect to move this package out of Tanka in the long run, especially if we need it in other projects. For the time being it seems simplest to leave it here until it matures.
Fixes #191