astral-sh/ruff

How to use COM812 in linter but avoid conflict with formatter?

Open

#9216 opened on Dec 20, 2023

View on GitHub
 (42 comments) (30 reactions) (0 assignees)Rust (47,527 stars) (2,088 forks)batch import
documentationformatterhelp wantedincompatibility

Description

I would like to achieve the following things:

  • Use the ruff linter on my code
  • Use the ruff formatter on my code
  • Enable rule COM812 for the linter

I like the linter, I like the formatter, and I like rule COM812. However, when I have COM812 as an allowed rule I get a warning when I run the formatter that rule COM812 may cause conflicts and that it should be disabled to avoid unexpected behavior. Is there, then, a recommended way to achieve my three goals?

I see a number of issues discussing rule COM812 but I don't see any addressing this exact question.

Contributor guide

Tech stack
python
Domain
developer experiencetooling
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Ruff basicsPython linting concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the ruff documentation for rule COM812 and the configuration of the linter vs formatter. Look at the discussions in this issue for proposed solutions, such as using 'per file ignores' or disabling the rule in the formatter. Check if there is a recommended way documented elsewhere.