Remove support for providing output format via format option
#7984
Conversation
zanieb
added
breaking
zanieb
force-pushed
the
zanie/remove-format
branch
from
e33389c to
13d7547
Compare
| warning: The option `format` has been deprecated to avoid ambiguity with Ruff's upcoming formatter. Use `output-format` instead. | ||
| "###); | ||
| insta::with_settings!({filters => vec![ | ||
| (&*regex::escape(ruff_toml.to_str().unwrap()), "[RUFF-TOML-PATH]"), |
PR Check ResultsEcosystem✅ ecosystem check detected no changes. |
|
This broke everyone's CI without warning. It's not that hard to fix but at the very least it would have been nice to have advanced notice and perhaps a more meaningful error message. |
The `--format=github` option was removed in astral-sh/ruff#7984.
|
Hey @acdha I'm sorry to hear this broke your CI. Use of this displayed warnings since v0.0.291 and the changelog for that release had a bolded notice. Additionally, we grouped this breaking change with an increase in a different version number per our versioning policy. I'm not sure what else we could have done here, except to have a longer deprecation period — which we will generally strive for, but in this case the error messages when the |
The `--format=github` option was removed in astral-sh/ruff#7984.
The `--format=github` option was removed in astral-sh/ruff#7984.
Yeah, I appreciate that there isn't a great answer here - a longer period than a couple of weeks might have helped but given that most of the time it's running in CI where people rarely look at passing builds I think the part which would have helped more would have been having an error message specifically noting that this option was renamed. Long-term, I'm sure the best solution would be an official GitHub Action which you could update at the same time as any future API changes. |
The `--format` option has been renamed to `--output-format` in astral-sh/ruff#7984
The `--format` option has been renamed to `--output-format` in astral-sh/ruff#7984 This is a breaking change and we require ruff>=0.0.291 to be compatible.
In astral-sh/ruff#7984, ruff removed support for the "--output" command line option, and now requires "--output-format" instead.
I'm sorry about that. What's your setup? Do you always install the latest Ruff version on CI? If so, I would recommend you to pin your ruff version and bump it periodically. |
In astral-sh/ruff#7984, ruff removed support for the "--output" command line option, and now requires "--output-format" instead.
…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
See the provided breaking changes note for details.
Removes support for the deprecated
--formatoption in theruff checkCLI,formatinference asoutput-formatin the configuration file, and theRUFF_FORMATenvironment variable.The error message for use of
formatin the configuration file could be better, but would require some awkward serde wrappers and it seems hard to present the correct schema to the user still.