mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-14 23:50:24 +00:00
Create PyFormatOptions
<!-- Thank you for contributing to Ruff! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? - Does this pull request include references to any relevant issues? --> ## Summary This PR adds a new `PyFormatOptions` struct that stores the python formatter options. The new options aren't used yet, with the exception of magical trailing commas and the options passed to the printer. I'll follow up with more PRs that use the new options (e.g. `QuoteStyle`). <!-- What's the purpose of the change? What does it do, and why? --> ## Test Plan `cargo test` I'll follow up with a new PR that adds support for overriding the options in our fixture tests.
This commit is contained in:
parent
a52cd47c7f
commit
dd0d1afb66
10 changed files with 170 additions and 88 deletions
118
crates/ruff_python_formatter/src/options.rs
Normal file
118
crates/ruff_python_formatter/src/options.rs
Normal file
|
@ -0,0 +1,118 @@
|
|||
use ruff_formatter::printer::{LineEnding, PrinterOptions};
|
||||
use ruff_formatter::{FormatOptions, IndentStyle, LineWidth};
|
||||
|
||||
#[derive(Clone, Debug)]
|
||||
pub struct PyFormatOptions {
|
||||
/// Specifies the indent style:
|
||||
/// * Either a tab
|
||||
/// * or a specific amount of spaces
|
||||
indent_style: IndentStyle,
|
||||
|
||||
/// The preferred line width at which the formatter should wrap lines.
|
||||
line_width: LineWidth,
|
||||
|
||||
/// The preferred quote style to use (single vs double quotes).
|
||||
quote_style: QuoteStyle,
|
||||
|
||||
/// Whether to expand lists or elements if they have a trailing comma such as `(a, b,)`
|
||||
magic_trailing_comma: MagicTrailingComma,
|
||||
}
|
||||
|
||||
impl PyFormatOptions {
|
||||
pub fn magic_trailing_comma(&self) -> MagicTrailingComma {
|
||||
self.magic_trailing_comma
|
||||
}
|
||||
|
||||
pub fn quote_style(&self) -> QuoteStyle {
|
||||
self.quote_style
|
||||
}
|
||||
|
||||
pub fn with_quote_style(&mut self, style: QuoteStyle) -> &mut Self {
|
||||
self.quote_style = style;
|
||||
self
|
||||
}
|
||||
|
||||
pub fn with_magic_trailing_comma(&mut self, trailing_comma: MagicTrailingComma) -> &mut Self {
|
||||
self.magic_trailing_comma = trailing_comma;
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
impl FormatOptions for PyFormatOptions {
|
||||
fn indent_style(&self) -> IndentStyle {
|
||||
self.indent_style
|
||||
}
|
||||
|
||||
fn line_width(&self) -> LineWidth {
|
||||
self.line_width
|
||||
}
|
||||
|
||||
fn as_print_options(&self) -> PrinterOptions {
|
||||
PrinterOptions {
|
||||
tab_width: 4,
|
||||
print_width: self.line_width.into(),
|
||||
line_ending: LineEnding::LineFeed,
|
||||
indent_style: self.indent_style,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for PyFormatOptions {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
indent_style: IndentStyle::Space(4),
|
||||
line_width: LineWidth::try_from(88).unwrap(),
|
||||
quote_style: QuoteStyle::default(),
|
||||
magic_trailing_comma: MagicTrailingComma::default(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
|
||||
pub enum QuoteStyle {
|
||||
Single,
|
||||
#[default]
|
||||
Double,
|
||||
}
|
||||
|
||||
impl QuoteStyle {
|
||||
pub const fn as_char(self) -> char {
|
||||
match self {
|
||||
QuoteStyle::Single => '\'',
|
||||
QuoteStyle::Double => '"',
|
||||
}
|
||||
}
|
||||
|
||||
#[must_use]
|
||||
pub const fn opposite(self) -> QuoteStyle {
|
||||
match self {
|
||||
QuoteStyle::Single => QuoteStyle::Double,
|
||||
QuoteStyle::Double => QuoteStyle::Single,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl TryFrom<char> for QuoteStyle {
|
||||
type Error = ();
|
||||
|
||||
fn try_from(value: char) -> std::result::Result<Self, Self::Error> {
|
||||
match value {
|
||||
'\'' => Ok(QuoteStyle::Single),
|
||||
'"' => Ok(QuoteStyle::Double),
|
||||
_ => Err(()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Copy, Clone, Debug, Default)]
|
||||
pub enum MagicTrailingComma {
|
||||
#[default]
|
||||
Preserve,
|
||||
Skip,
|
||||
}
|
||||
|
||||
impl MagicTrailingComma {
|
||||
pub const fn is_preserve(self) -> bool {
|
||||
matches!(self, Self::Preserve)
|
||||
}
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue