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 format option to output-format #7354

Closed
Tracked by #7642
zanieb opened this issue Sep 13, 2023 · 1 comment · Fixed by #7514
Closed
Tracked by #7642

Rename format option to output-format #7354

zanieb opened this issue Sep 13, 2023 · 1 comment · Fixed by #7514
Labels
breaking Breaking API change cli Related to the command-line interface configuration Related to settings and configuration formatter Related to the formatter

Comments

@zanieb
Copy link
Member

zanieb commented Sep 13, 2023

The format option could be confused with our formatter. It should be renamed to output-format in both the configuration file and CLI e.g.

--format <kind> -> --output-format <kind>
format = <kind> -> output-format = <kind>

The previous name should undergo a deprecation period during which we display a warning on use.

@zanieb zanieb added configuration Related to settings and configuration cli Related to the command-line interface labels Sep 13, 2023
@MichaReiser MichaReiser added the breaking Breaking API change label Sep 13, 2023
@zanieb
Copy link
Member Author

zanieb commented Sep 14, 2023

I think we'll want to look into building tooling for rename deprecations in our configuration macro.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Breaking API change cli Related to the command-line interface configuration Related to settings and configuration formatter Related to the formatter
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants