Adds experimental --ion-version option #128
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
jobarr-amzn
reviewed
Jul 2, 2024
| non-goal. | ||
| help Print this message or the help of the given subcommand(s) | ||
| cat Prints all Ion input files to the specified output in the requested format. | ||
| count (UNSTABLE) Prints the number of top-level values found in the input stream. |
There was a problem hiding this comment.
What makes count unstable, anyway?
There was a problem hiding this comment.
I have no idea, but it was in the beta namespace, so I'm leaving it as unstable for now. We can fix that in a separate PR.
There was a problem hiding this comment.
Actually, it is possible that #104 could eventually replace count, so maybe that's a good reason to leave it a "unstable" for now.
| @@ -17,7 +17,12 @@ impl IonCliCommand for CatCommand { | |||
| } | |||
|
|
|||
| fn configure_args(&self, command: Command) -> Command { | |||
| command.with_input().with_output().with_format() | |||
| command | |||
| .alias("dump") | |||
Comment on lines
+28
to
+43
| /// Indicates whether this command is stable (as opposed to unstable or experimental). | ||
| /// Namespaces should almost always be stable. | ||
| fn is_stable(&self) -> bool { | ||
| true | ||
| } | ||
|
|
||
| /// Whether the output format is machine-readable. | ||
| /// | ||
| /// Commands that are "plumbing" should default to putting one output (result, value, document) | ||
| /// on each line in a machine-readable format (file name, Ion value(s), integers, booleans) | ||
| /// without any prose or table formatting, etc. | ||
| /// | ||
| /// See https://git-scm.com/book/en/v2/Git-Internals-Plumbing-and-Porcelain#_plumbing_porcelain | ||
| fn is_porcelain(&self) -> bool { | ||
| false | ||
| } |
There was a problem hiding this comment.
Should the defaults be flipped here? I'd rather default to assuming that commands are unstable and porcelain, and have commands intentionally vouch that they are stable or plumbing.
There was a problem hiding this comment.
I don't mind flipping them.
jobarr-amzn
approved these changes
Jul 2, 2024
This was referenced Oct 22, 2024
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.
Issue #, if available:
#85
Description of changes:
Changes are mostly broken up by commits
dumpcommand in favor of using clap'saliasfeature to achieve the same effect.--unstable/-Xto opt into experimental features.is_porcelain()function to theIonCliCommandtrait. If implemented to return true, it gets a warning at the bottom of the command help that the output is not intended to be suitable for machine-readable use cases.--ion-versionoptionBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.