Confused about --preview

[buhtz]

I am confused about the Preview Mode using --preview on shell.

Referencing this documentation I would say it is a flag to activate several extra linter rules (that are not stable currently).

But it also seems that it modifies the output of ruff. No I get output like this

tests/test_report_output.py:14:8: F401 [*] `seaborn` imported but unused
   |
12 | import PIL
13 | import PIL.Image
14 | import seaborn
   |        ^^^^^^^ F401
15 | import docx
16 | import docx.document
   |
   = help: Remove unused import: `seaborn`

Instead of just

tests/test_report_output.py:14:8: F401 [*] `seaborn` imported but unused

I prefer the one-line output but also prefer the extra linter rules.

[MichaReiser]

I think there's an opportunity to improve our documentation. The beginning mentions that it is a way for us to receive feedback from the community (phrased openly), but we then narrow the list to rules and formatter changes.

Our intention is to use --preview for all kind of changes, including changing the output format. You can get the "old" output format by using output-format = "concise" in your configuration or CLI

[buhtz]

Yes, you can ping me.

Can you explain the term "preview mode" please?
Is this just another output format or does this influence the selection of rules?

Is preview = true in pyproject.toml something different from --preview on shell?

[hoel-bagard]

By "preview mode" I meant using --preview.

Is preview = true in pyproject.toml something different from --preview on shell?

They have the same effect.

[buhtz]

OK, then what is the "effect"? Regarding my experiement the effect is only another output format but not select any rules. Am I right?

[hoel-bagard]

Rather than selecting the rules, it allows you to select preview only rules. So by itself it doesn't do much, it mainly enables more options.

If you happened to have ALL rules enabled, then it would have the effect of turning on all the preview rules.

[buhtz]

"it allows you to select preview only rules" -> Easy to misunderstand by none-native speakers.

I understand but that behavior is misleading and confusing.
There is a switch/option to modify the output format. But indirect it kind of activates hidden selection options.

That is IMHO not a good design and IMHO a bug. The "connection" between --preview (modify output format) and rule selection should be killed.