Rename format option to output-format

[MichaReiser]

Summary

This PR renames the check --format option to --output-format, the RUFF_FORMAT environment variable to RUFF_OUTPUT_FORMAT, and the format configuration option to output-format to avoid ambiguity and make the format option available for the formatter.

The issue #7354 suggests building support in our configuration macro. I decided against it because it requires multiple manual edits anyway (CLI, add warning, when loading the configuration from options, another warning).

Closes #7354

Test Plan

New option works

❯ cargo run --bin ruff -- check  . --no-cache --output-format=grouped
    Finished dev [unoptimized + debuginfo] target(s) in 0.14s
     Running `target/debug/ruff check . --no-cache --output-format=grouped`
crates/ruff_cli/resources/test/fixtures/cache_remove_old_files/source.py:
  4:1 F822 Undefined name `b` in `__all__`

crates/ruff_python_resolver/resources/test/airflow/airflow/api/common/mark_tasks.py:
   2:8  F401 [*] `os` imported but unused
   5:47 F401 [*] `airflow.jobs.scheduler_job_runner.SchedulerJobRunner` imported but unused
   8:38 F401 [*] `airflow.compat.functools.cached_property` imported but unused
  11:54 F401 [*] `airflow.providers.google.cloud.hooks.gcs.GCSHook` imported but unused
  14:28 F401 [*] `sqlalchemy.orm.Query` imported but unused

Found 6 errors.
[*] 5 potentially fixable with the --fix option.

The --format option works but prints a warning

❯ cargo run --bin ruff -- check  . --no-cache --format=grouped
    Finished dev [unoptimized + debuginfo] target(s) in 0.10s
     Running `target/debug/ruff check . --no-cache --format=grouped`
warning: The argument `--format=<FORMAT>` is deprecated. Use `--output-format=<FORMAT>` instead.
crates/ruff_cli/resources/test/fixtures/cache_remove_old_files/source.py:
  4:1 F822 Undefined name `b` in `__all__`

crates/ruff_python_resolver/resources/test/airflow/airflow/api/common/mark_tasks.py:
   2:8  F401 [*] `os` imported but unused
   5:47 F401 [*] `airflow.jobs.scheduler_job_runner.SchedulerJobRunner` imported but unused
   8:38 F401 [*] `airflow.compat.functools.cached_property` imported but unused
  11:54 F401 [*] `airflow.providers.google.cloud.hooks.gcs.GCSHook` imported but unused
  14:28 F401 [*] `sqlalchemy.orm.Query` imported but unused

Found 6 errors.
[*] 5 potentially fixable with the --fix option.

Using both options prints an error

❯ cargo run --bin ruff -- check  . --no-cache --format=grouped --output-format=text
    Finished dev [unoptimized + debuginfo] target(s) in 0.10s
     Running `target/debug/ruff check . --no-cache --format=grouped --output-format=text`
error: the argument '--format <FORMAT>' cannot be used with '--output-format <OUTPUT_FORMAT>'

Usage: ruff check --no-cache <FILES>...

For more information, try '--help'.

Using the old environment variable prints a warning but applies the format

❯ RUFF_FORMAT=grouped cargo run --bin ruff -- check  . --no-cache
    Finished dev [unoptimized + debuginfo] target(s) in 0.10s
     Running `target/debug/ruff check . --no-cache`
warning: The environment variable `RUFF_FORMAT` is deprecated. Use `RUFF_OUTPUT_FORMAT` instead.
crates/ruff_cli/resources/test/fixtures/cache_remove_old_files/source.py:
  4:1 F822 Undefined name `b` in `__all__`

crates/ruff_python_resolver/resources/test/airflow/airflow/api/common/mark_tasks.py:
   2:8  F401 [*] `os` imported but unused
   5:47 F401 [*] `airflow.jobs.scheduler_job_runner.SchedulerJobRunner` imported but unused
   8:38 F401 [*] `airflow.compat.functools.cached_property` imported but unused
  11:54 F401 [*] `airflow.providers.google.cloud.hooks.gcs.GCSHook` imported but unused
  14:28 F401 [*] `sqlalchemy.orm.Query` imported but unused

Found 6 errors.
[*] 5 potentially fixable with the --fix option.

Using the new environment variable works

❯ RUFF_OUTPUT_FORMAT=grouped cargo run --bin ruff -- check  . --no-cache
    Finished dev [unoptimized + debuginfo] target(s) in 0.10s
     Running `target/debug/ruff check . --no-cache`
crates/ruff_cli/resources/test/fixtures/cache_remove_old_files/source.py:
  4:1 F822 Undefined name `b` in `__all__`

crates/ruff_python_resolver/resources/test/airflow/airflow/api/common/mark_tasks.py:
   2:8  F401 [*] `os` imported but unused
   5:47 F401 [*] `airflow.jobs.scheduler_job_runner.SchedulerJobRunner` imported but unused
   8:38 F401 [*] `airflow.compat.functools.cached_property` imported but unused
  11:54 F401 [*] `airflow.providers.google.cloud.hooks.gcs.GCSHook` imported but unused
  14:28 F401 [*] `sqlalchemy.orm.Query` imported but unused

Found 6 errors.
[*] 5 potentially fixable with the --fix option.

Using both environment variables emits an error

❯ RUFF_FORMAT=text RUFF_OUTPUT_FORMAT=grouped cargo run --bin ruff -- check  . --no-cache
    Finished dev [unoptimized + debuginfo] target(s) in 0.10s
     Running `target/debug/ruff check . --no-cache`
error: the argument '--format <FORMAT>' cannot be used with '--output-format <OUTPUT_FORMAT>'

Usage: ruff check --no-cache <FILES>...

For more information, try '--help'.

Using the format option prints a warning but applies the format

[tool.ruff]
format = "grouped"

❯ cargo run --bin ruff -- check  . --no-cache
    Finished dev [unoptimized + debuginfo] target(s) in 0.14s
     Running `target/debug/ruff check . --no-cache`
warning: The option `format` has been deprecated to avoid ambiguity with Ruff's upcoming formatter. Use `format-output` instead.
crates/ruff_cli/resources/test/fixtures/cache_remove_old_files/source.py:
  4:1 F822 Undefined name `b` in `__all__`

crates/ruff_python_resolver/resources/test/airflow/airflow/api/common/mark_tasks.py:
   2:8  F401 [*] `os` imported but unused
   5:47 F401 [*] `airflow.jobs.scheduler_job_runner.SchedulerJobRunner` imported but unused
   8:38 F401 [*] `airflow.compat.functools.cached_property` imported but unused
  11:54 F401 [*] `airflow.providers.google.cloud.hooks.gcs.GCSHook` imported but unused
  14:28 F401 [*] `sqlalchemy.orm.Query` imported but unused

Found 6 errors.
[*] 5 potentially fixable with the --fix option.

Using the new output-format option applies the format

[tool.ruff]
output-format = "grouped"

❯ cargo run --bin ruff -- check  . --no-cache
    Finished dev [unoptimized + debuginfo] target(s) in 0.13s
     Running `target/debug/ruff check . --no-cache`
crates/ruff_cli/resources/test/fixtures/cache_remove_old_files/source.py:
  4:1 F822 Undefined name `b` in `__all__`

crates/ruff_python_resolver/resources/test/airflow/airflow/api/common/mark_tasks.py:
   2:8  F401 [*] `os` imported but unused
   5:47 F401 [*] `airflow.jobs.scheduler_job_runner.SchedulerJobRunner` imported but unused
   8:38 F401 [*] `airflow.compat.functools.cached_property` imported but unused
  11:54 F401 [*] `airflow.providers.google.cloud.hooks.gcs.GCSHook` imported but unused
  14:28 F401 [*] `sqlalchemy.orm.Query` imported but unused

Found 6 errors.
[*] 5 potentially fixable with the --fix option.

[MichaReiser]

Current dependencies on/for this PR:

• main
  • PR Rename format option to output-format #7514 👈

This comment was auto-generated by Graphite.

[konstin]

extra snapshot, otherwise i really like this!

[MichaReiser]

@charliermarsh should we mark this PR as breaking or only when we remove the option entirely?

[github-actions]

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

[charliermarsh]

For how long do you anticipate leaving these deprecation warnings in place?

@charliermarsh should we mark this PR as breaking or only when we remove the option entirely?

Only when removing the option but we should call it out explicitly at the top of the release notes.