ruff/crates/ruff_python_formatter
Dhruv Manilawala 6ecb4776de
Rename AnyStringKind -> AnyStringFlags (#11405)
## Summary

This PR renames `AnyStringKind` to `AnyStringFlags` and `AnyStringFlags`
to `AnyStringFlagsInner`.

The main motivation is to have consistent usage of "kind" and "flags".
For each string kind, it's "flags" like `StringLiteralFlags`,
`BytesLiteralFlags`, and `FStringFlags` but it was `AnyStringKind` for
the "any" variant.
2024-05-13 13:18:07 +00:00
..
resources/test/fixtures Avoid multiline expression if format specifier is present (#11123) 2024-04-26 13:34:38 +00:00
src Rename AnyStringKind -> AnyStringFlags (#11405) 2024-05-13 13:18:07 +00:00
tests Avoid multiline expression if format specifier is present (#11123) 2024-04-26 13:34:38 +00:00
Cargo.toml Get cargo shear passing (#11392) 2024-05-13 01:56:24 +00:00
CONTRIBUTING.md Remove remaining ruff_shrinking references (#11272) 2024-05-03 20:22:08 +00:00
generate.py Split string formatting to individual nodes (#9058) 2023-12-14 12:55:10 -06:00
orphan_rules_in_the_formatter.svg Generate FormatRule definitions (#4724) 2023-06-01 08:38:53 +02:00
README.md Move deviations from formatter README to documentation (#10444) 2024-03-18 08:22:28 +00:00

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 Black compatibility.

Getting started

The Ruff formatter is available as of Ruff v0.1.2. Head to The Ruff Formatter for usage instructions and a comparison to Black.