CLI: Deprecate --show-sources in favor of --output_format <concise|full>
#7350
Assignees
Labels
cli
Related to the command-line interface
Comments
This was referenced Sep 13, 2023
snowsignal
changed the title
--show-sources in favor of --format <concise|full>--show-sources in favor of --output_format <concise|full>
snowsignal
added a commit
that referenced
this issue
Jan 30, 2024
…<full|concise>` (#9687) Fixes #7350 ## Summary * `--show-source` and `--no-show-source` are now deprecated. * `output-format` supports two new variants, `full` and `concise`. `text` is now a deprecated variant, and any use of it is treated as the default serialization format. * `--output-format` now default to `concise` * In preview mode, `--output-format` defaults to `full` * `--show-source` will still set `--output-format` to `full` if the output format is not otherwise specified. * likewise, `--no-show-source` can override an output format that was set in a file-based configuration, though it will also be overridden by `--output-format` ## Test Plan A lot of tests were updated to use `--output-format=full`. Additional tests were added to ensure the correct deprecation warnings appeared, and that deprecated options behaved as intended.
zanieb
pushed a commit
that referenced
this issue
Jan 30, 2024
…<full|concise>` (#9687) Fixes #7350 ## Summary * `--show-source` and `--no-show-source` are now deprecated. * `output-format` supports two new variants, `full` and `concise`. `text` is now a deprecated variant, and any use of it is treated as the default serialization format. * `--output-format` now default to `concise` * In preview mode, `--output-format` defaults to `full` * `--show-source` will still set `--output-format` to `full` if the output format is not otherwise specified. * likewise, `--no-show-source` can override an output format that was set in a file-based configuration, though it will also be overridden by `--output-format` ## Test Plan A lot of tests were updated to use `--output-format=full`. Additional tests were added to ensure the correct deprecation warnings appeared, and that deprecated options behaved as intended.
zanieb
added a commit
that referenced
this issue
Feb 1, 2024
…<full|concise>` (#9687) Fixes #7350 ## Summary * `--show-source` and `--no-show-source` are now deprecated. * `output-format` supports two new variants, `full` and `concise`. `text` is now a deprecated variant, and any use of it is treated as the default serialization format. * `--output-format` now default to `concise` * In preview mode, `--output-format` defaults to `full` * `--show-source` will still set `--output-format` to `full` if the output format is not otherwise specified. * likewise, `--no-show-source` can override an output format that was set in a file-based configuration, though it will also be overridden by `--output-format` ## Test Plan A lot of tests were updated to use `--output-format=full`. Additional tests were added to ensure the correct deprecation warnings appeared, and that deprecated options behaved as intended. # Conflicts: # crates/ruff/tests/integration_test.rs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
--show-sources/--no-show-sourcesflags should be replaced with--output_format full/--format conciseoptions. Ruff's default format should change tofull. These formats would replace thetextformat, which should undergo a deprecation period.The flags should also undergo a deprecation period during which
--format <..>is providedThe "full" name is up for debate! Feel free to chime in with suggestions.
In #7349 the default behavior is changed to
--show-sources/--format full.The text was updated successfully, but these errors were encountered: