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

Consolidate output options into --output-format / -of flag #253

Closed
tarkatronic opened this issue Nov 2, 2021 · 1 comment · Fixed by #266
Closed

Consolidate output options into --output-format / -of flag #253

tarkatronic opened this issue Nov 2, 2021 · 1 comment · Fixed by #266
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@tarkatronic
Copy link
Contributor

Feature Request

Is your feature request related to a problem? Please describe.

During the discussion that resulted in #239, we talked about the current output formats, the various options to trigger them, along with any possible future formats, and decided that it would be best to combine them into a single option. There really is only ever one applicable output format, making them somewhat mutually exclusive, so this will both improve the user experience and reduce complexity in the code.

Describe the solution you'd like

The following options should be removed:

  • --json / --no-json
  • --compact / --no-compact

The following option should be added:

--output-format [json | compact | text] (Default: text)

This also makes for extensibility in the future in case we want, for example, --output-format [toml | yaml] or whatever else. This will also be easier to document and logic around in the code.

@tarkatronic
Copy link
Contributor Author

Fixed in #266

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants