switch to options bag

Author: dsherret

src/format_text.rs

@@ -13,6 +13,14 @@ use super::generation::generate;
 pub use super::generation::ExternalFormatter;
 use super::swc::parse_swc_ast;
 
+pub struct FormatTextOptions<'a> {
+  pub path: &'a Path,
+  pub extension: Option<&'a str>,
+  pub text: String,
+  pub config: &'a Configuration,
+  pub external_formatter: Option<&'a ExternalFormatter>,
+}
+
 /// Formats a file.
 ///
 /// Returns the file text or an error when it failed to parse.
@@ -36,31 +44,24 @@ use super::swc::parse_swc_ast;
 /// // now format many files (it is recommended to parallelize this)
 /// let files_to_format = vec![(PathBuf::from("path/to/file.ts"), "const  t  =  5 ;")];
 /// for (file_path, file_text) in files_to_format {
-///     let result = format_text(&file_path, None, file_text.into(), &config);
+///     let result = format_text(FormatTextOptions {
+///         path: &file_path,
+///         extension: None,
+///         text: file_text.into(),
+///         config: &config,
+///         external_formatter: None,
+///     });
 ///     // save result here...
 /// }
 /// ```
-pub fn format_text(file_path: &Path, file_extension: Option<&str>, file_text: String, config: &Configuration) -> Result<Option<String>> {
-  format_text_inner(file_path, file_extension, file_text, config, None)
-}
-
-pub fn format_text_with_external_formatter(
-  file_path: &Path,
-  file_extension: Option<&str>,
-  file_text: String,
-  config: &Configuration,
-  external_formatter: ExternalFormatter,
-) -> Result<Option<String>> {
-  format_text_inner(file_path, file_extension, file_text, config, Some(external_formatter))
-}
-
-fn format_text_inner(
-  file_path: &Path,
-  file_extension: Option<&str>,
-  file_text: String,
-  config: &Configuration,
-  external_formatter: Option<ExternalFormatter>,
-) -> Result<Option<String>> {
+pub fn format_text(options: FormatTextOptions) -> Result<Option<String>> {
+  let FormatTextOptions {
+    path: file_path,
+    extension: file_extension,
+    text: file_text,
+    config,
+    external_formatter,
+  } = options;
   if super::utils::file_text_has_ignore_comment(&file_text, &config.ignore_file_comment_text) {
     Ok(None)
   } else {
@@ -82,17 +83,16 @@ fn format_text_inner(
 }
 
 /// Formats an already parsed source. This is useful as a performance optimization.
-pub fn format_parsed_source(source: &ParsedSource, config: &Configuration) -> Result<Option<String>> {
+pub fn format_parsed_source(source: &ParsedSource, config: &Configuration, external_formatter: Option<&ExternalFormatter>) -> Result<Option<String>> {
   if super::utils::file_text_has_ignore_comment(source.text(), &config.ignore_file_comment_text) {
     Ok(None)
   } else {
     ensure_no_specific_syntax_errors(source)?;
-    // TODO(bartlomieju): support external formatter
-    inner_format(source, config, None)
+    inner_format(source, config, external_formatter)
   }
 }
 
-fn inner_format(parsed_source: &ParsedSource, config: &Configuration, external_formatter: Option<ExternalFormatter>) -> Result<Option<String>> {
+fn inner_format(parsed_source: &ParsedSource, config: &Configuration, external_formatter: Option<&ExternalFormatter>) -> Result<Option<String>> {
   let result = dprint_core::formatting::format(
     || {
       #[allow(clippy::let_and_return)]
@@ -133,9 +133,15 @@ mod test {
   fn strips_bom() {
     for input_text in ["\u{FEFF}const t = 5;\n", "\u{FEFF}const t =   5;"] {
       let config = crate::configuration::ConfigurationBuilder::new().build();
-      let result = format_text(&std::path::PathBuf::from("test.ts"), None, input_text.into(), &config)
-        .unwrap()
-        .unwrap();
+      let result = format_text(FormatTextOptions {
+        path: &std::path::PathBuf::from("test.ts"),
+        extension: None,
+        text: input_text.into(),
+        config: &config,
+        external_formatter: None,
+      })
+      .unwrap()
+      .unwrap();
       assert_eq!(result, "const t = 5;\n");
     }
   }

src/generation/context.rs

@@ -45,14 +45,14 @@ use crate::utils::Stack;
 /// cases the templates will be left as they are.
 ///
 /// Only templates with no interpolation are supported.
-pub type ExternalFormatter = Box<dyn Fn(MediaType, String, &Configuration) -> Option<String>>;
+pub type ExternalFormatter = dyn Fn(MediaType, String, &Configuration) -> Option<String>;
 
 pub struct Context<'a> {
   pub media_type: MediaType,
   pub program: Program<'a>,
   pub config: &'a Configuration,
   pub comments: CommentTracker<'a>,
-  pub external_formatter: Option<ExternalFormatter>,
+  pub external_formatter: Option<&'a ExternalFormatter>,
   pub token_finder: TokenFinder<'a>,
   pub current_node: Node<'a>,
   pub parent_stack: Stack<Node<'a>>,
@@ -79,7 +79,7 @@ impl<'a> Context<'a> {
     current_node: Node<'a>,
     program: Program<'a>,
     config: &'a Configuration,
-    external_formatter: Option<ExternalFormatter>,
+    external_formatter: Option<&'a ExternalFormatter>,
   ) -> Context<'a> {
     Context {
       media_type,

src/generation/generate.rs

@@ -25,7 +25,7 @@ use super::*;
 use crate::configuration::*;
 use crate::utils;
 
-pub fn generate(parsed_source: &ParsedSource, config: &Configuration, external_formatter: Option<ExternalFormatter>) -> PrintItems {
+pub fn generate(parsed_source: &ParsedSource, config: &Configuration, external_formatter: Option<&ExternalFormatter>) -> PrintItems {
   // eprintln!("Leading: {:?}", parsed_source.comments().leading_map());
   // eprintln!("Trailing: {:?}", parsed_source.comments().trailing_map());
 

src/lib.rs

@@ -18,8 +18,8 @@ mod utils;
 
 pub use format_text::format_parsed_source;
 pub use format_text::format_text;
-pub use format_text::format_text_with_external_formatter;
 pub use format_text::ExternalFormatter;
+pub use format_text::FormatTextOptions;
 
 #[cfg(feature = "tracing")]
 pub use format_text::trace_file;

src/swc.rs

@@ -359,6 +359,6 @@ Merge conflict marker encountered. at file:///test.ts:6:1
     // a source file that had a non-fatal diagnostic
     let parsed_source = parse_inner_no_diagnostic_check(&file_path, None, text.into()).unwrap();
     let config = ConfigurationBuilder::new().build();
-    assert_eq!(crate::format_parsed_source(&parsed_source, &config).err().unwrap().to_string(), expected);
+    assert_eq!(crate::format_parsed_source(&parsed_source, &config, None).err().unwrap().to_string(), expected);
   }
 }

tests/spec_test.rs

@@ -96,7 +96,13 @@ fn main() {
         let config_result = resolve_config(spec_config, &global_config);
         ensure_no_diagnostics(&config_result.diagnostics);
 
-        format_text_with_external_formatter(file_name, None, file_text.into(), &config_result.config, Box::new(external_formatter))
+        format_text(FormatTextOptions {
+          path: file_name,
+          extension: None,
+          text: file_text.into(),
+          config: &config_result.config,
+          external_formatter: Some(&external_formatter),
+        })
       })
     },
     Arc::new(move |_file_name, _file_text, _spec_config| {