Skip to content
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

Rename -m, --message-format <MESSAGE_FORMAT> to -f, --format <OUTPUT_FORMAT> #2990

Closed
mrinalwadhwa opened this issue Jul 19, 2022 · 7 comments

Comments

@mrinalwadhwa
Copy link
Member

Ockam Command has an option that indicates the output format.
Calling it message format is confusing since we use message as a specific noun with its own command.

We should just call this option --format

The help output currently is:

-m, --message-format <MESSAGE_FORMAT>    [default: plain] [possible values: plain, json]

It should be:

-f, --format <OUTPUT_FORMAT>    [default: plain] [possible values: plain, json]
@mrinalwadhwa
Copy link
Member Author

@tmuro17
Copy link
Contributor

tmuro17 commented Jul 30, 2022

I would like to take a look at this one. Would it be preferred to change the name of the underlying enum as well, or just the flag exposed in the CLI?

@mrinalwadhwa
Copy link
Member Author

@tmuro17 awesome thank you.

Would it be preferred to change the name of the underlying enum as well, or just the flag exposed in the CLI?

Yes to OutputFormat

But before you start ..

@edbastelli mentioned a few days ago that they would like to pick it up. If they still have time to work on this ... then I would love to add a few more issues over the next hour that @tmuro17 may find interesting.

@tmuro17
Copy link
Contributor

tmuro17 commented Jul 30, 2022

Absolutely, happy to leave it to @edbastelli if they are interested.

@edbastelli
Copy link
Contributor

Hi @tmuro17, @mrinalwadhwa, yes I am working on it. thanks

@mrinalwadhwa
Copy link
Member Author

Awesome! looking forward to it!

@mrinalwadhwa
Copy link
Member Author

Closed in #3073

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment