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 use of --format in ruff rule to --output-format #7990

Closed
zanieb opened this issue Oct 16, 2023 · 2 comments · Fixed by #8203
Closed

Rename use of --format in ruff rule to --output-format #7990

zanieb opened this issue Oct 16, 2023 · 2 comments · Fixed by #8203
Labels
cli Related to the command-line interface

Comments

@zanieb
Copy link
Member

zanieb commented Oct 16, 2023

As with #7354, we should probably rename ruff rule --format ... to ruff rule --output-format ... for clarity.

The old option should be deprecated then removed later.

@zanieb zanieb added the cli Related to the command-line interface label Oct 16, 2023
@Skylion007
Copy link
Contributor

I got bitten by this when upgrading ruff as well.

@sibocw
Copy link

sibocw commented Oct 17, 2023

Yes... This broke my Github Action that uses ruff. I guessed something like this could be the reason, but it wasn't obvious to me from the ruff documentation that --format is now --output-format

akx added a commit to akx/ruff that referenced this issue Oct 25, 2023
akx added a commit to akx/ruff that referenced this issue Oct 25, 2023
akx added a commit to akx/ruff that referenced this issue Oct 26, 2023
charliermarsh pushed a commit that referenced this issue Oct 28, 2023
…tion warnings (#8203)

## Summary

Since `--format` was changed to `--output-format` for `check`, it feels
like it makes sense for the same to work for the auxiliary commands.

This 

* adds the same deprecation warning that used to be a thing in #7514
(and un-became a thing in #7984)

Fixes #7990.

## Test Plan

* `cargo run --bin=ruff -- rule --all --output-format=json` works
* `cargo run --bin=ruff -- rule --format=json` works with warnings
justalemon added a commit to justalemon/5desc that referenced this issue Dec 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Related to the command-line interface
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants