Introduce FormatterSettings (#7545)

crates/ruff_python_formatter/src/lib.rs

@@ -17,6 +17,7 @@ use crate::comments::{
 pub use crate::context::PyFormatContext;
 pub use crate::options::{MagicTrailingComma, PreviewMode, PyFormatOptions, QuoteStyle};
 use crate::verbatim::suppressed_node;
+pub use settings::FormatterSettings;
 
 pub(crate) mod builders;
 pub mod cli;
@@ -29,6 +30,7 @@ mod options;
 pub(crate) mod other;
 pub(crate) mod pattern;
 mod prelude;
+mod settings;
 pub(crate) mod statement;
 pub(crate) mod type_param;
 mod verbatim;

crates/ruff_python_formatter/src/options.rs

@@ -1,9 +1,12 @@
 use ruff_formatter::printer::{LineEnding, PrinterOptions, SourceMapGeneration};
 use ruff_formatter::{FormatOptions, IndentStyle, IndentWidth, LineWidth};
+use ruff_macros::CacheKey;
 use ruff_python_ast::PySourceType;
 use std::path::Path;
 use std::str::FromStr;
 
+/// Resolved options for formatting one individual file. This is different from [`crate::FormatterSettings`] which
+/// represents the formatting settings for multiple files (the whole project, a subdirectory, ...)
 #[derive(Clone, Debug)]
 #[cfg_attr(
     feature = "serde",
@@ -176,7 +179,7 @@ impl FormatOptions for PyFormatOptions {
     }
 }
 
-#[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
+#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, CacheKey)]
 #[cfg_attr(
     feature = "serde",
     derive(serde::Serialize, serde::Deserialize),
@@ -230,7 +233,7 @@ impl FromStr for QuoteStyle {
     }
 }
 
-#[derive(Copy, Clone, Debug, Default)]
+#[derive(Copy, Clone, Debug, Default, CacheKey)]
 #[cfg_attr(
     feature = "serde",
     derive(serde::Serialize, serde::Deserialize),
@@ -261,7 +264,7 @@ impl FromStr for MagicTrailingComma {
     }
 }
 
-#[derive(Copy, Clone, Debug, Eq, PartialEq, Default)]
+#[derive(Copy, Clone, Debug, Eq, PartialEq, Default, CacheKey)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(rename_all = "lowercase"))]
 pub enum PreviewMode {

crates/ruff_python_formatter/src/settings.rs

@@ -0,0 +1,49 @@
+use std::path::PathBuf;
+
+use ruff_formatter::{FormatOptions, IndentStyle, LineWidth};
+use ruff_macros::CacheKey;
+use ruff_python_ast::PySourceType;
+
+use crate::{MagicTrailingComma, PreviewMode, PyFormatOptions, QuoteStyle};
+
+#[derive(CacheKey, Clone, Debug)]
+pub struct FormatterSettings {
+    /// The files that are excluded from formatting (but may be linted).
+    pub exclude: Vec<PathBuf>,
+
+    pub preview: PreviewMode,
+
+    pub line_width: LineWidth,
+
+    pub indent_style: IndentStyle,
+
+    pub quote_style: QuoteStyle,
+
+    pub magic_trailing_comma: MagicTrailingComma,
+}
+
+impl FormatterSettings {
+    pub fn to_format_options(&self, source_type: PySourceType) -> PyFormatOptions {
+        PyFormatOptions::from_source_type(source_type)
+            .with_indent_style(self.indent_style)
+            .with_quote_style(self.quote_style)
+            .with_magic_trailing_comma(self.magic_trailing_comma)
+            .with_preview(self.preview)
+            .with_line_width(self.line_width)
+    }
+}
+
+impl Default for FormatterSettings {
+    fn default() -> Self {
+        let default_options = PyFormatOptions::default();
+
+        Self {
+            exclude: Vec::default(),
+            preview: PreviewMode::Disabled,
+            line_width: default_options.line_width(),
+            indent_style: default_options.indent_style(),
+            quote_style: default_options.quote_style(),
+            magic_trailing_comma: default_options.magic_trailing_comma(),
+        }
+    }
+}