166b9d18ee
## Summary Text ranges that overlap (or are adjacent) will be collapsed. This is done after text ranges have been adjusted to their enclosing nodes in the tree. Formatting of each range is then performed starting from the bottom of the file, ensuring that the following range still applies to the lines that the user intended to format. Implements #12800. ## Test Plan - Pre-existing unit tests ensure no regression or unexpected behavior change in regular executions with a single `--range` argument. - New unit tests have been added to cover the feature enhancement. |
||
|---|---|---|
| .. | ||
| resources/test/fixtures | ||
| src | ||
| tests | ||
| CONTRIBUTING.md | ||
| Cargo.toml | ||
| README.md | ||
| generate.py | ||
| orphan_rules_in_the_formatter.svg | ||
README.md
Ruff Formatter
The Ruff formatter is an extremely fast Python code formatter that ships as part of the ruff
CLI.
Goals
The formatter is designed to be a drop-in replacement for Black, but with an excessive focus on performance and direct integration with Ruff.
Specifically, the formatter is intended to emit near-identical output when run over Black-formatted code. When run over extensive Black-formatted projects like Django and Zulip, > 99.9% of lines are formatted identically. When migrating an existing project from Black to Ruff, you should expect to see a few differences on the margins, but the vast majority of your code should be unchanged.
If you identify deviations in your project, spot-check them against the intentional deviations enumerated below, as well as the unintentional deviations filed in the issue tracker. If you've identified a new deviation, please file an issue.
When run over non-Black-formatted code, the formatter makes some different decisions than Black, and so more deviations should be expected, especially around the treatment of end-of-line comments. For details, see Style Guide.
Getting started
Head to The Ruff Formatter for usage instructions and a comparison to Black.