refactor: Change Formatter to format_text as it's no longer needed.

- Fixes #49
- Adds better support for mjs files.

Author: dsherret

Cargo.lock

@@ -2,7 +2,7 @@
 name = "dprint-plugin-typescript"
 description = "TypeScript code formatting plugin for dprint."
 keywords = ["formatting", "formatter", "typescript"]
-version = "0.30.3"
+version = "0.31.0"
 authors = ["David Sherret <[email protected]>"]
 edition = "2018"
 license = "MIT"

Cargo.toml

@@ -0,0 +1,65 @@
+use std::path::Path;
+
+use dprint_core::formatting::*;
+use dprint_core::configuration::{resolve_new_line_kind};
+
+use super::parsing::parse;
+use super::swc::parse_swc_ast;
+use super::configuration::Configuration;
+
+/// Formats a file.
+///
+/// Returns the file text `Ok(formatted_text)` or an error when it failed to parse.
+///
+/// # Example
+///
+/// ```
+/// use std::path::PathBuf;
+/// use dprint_plugin_typescript::*;
+/// use dprint_plugin_typescript::configuration::*;
+///
+/// // build the configuration once
+/// let config = ConfigurationBuilder::new()
+///     .line_width(80)
+///     .prefer_hanging(true)
+///     .prefer_single_line(false)
+///     .quote_style(QuoteStyle::PreferSingle)
+///     .next_control_flow_position(NextControlFlowPosition::SameLine)
+///     .build();
+///
+/// // 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.iter() {
+///     let result = format_text(file_path, file_text, &config);
+///     // save result here...
+/// }
+/// ```
+pub fn format_text(file_path: &Path, file_text: &str, config: &Configuration) -> Result<String, String> {
+    if has_ignore_comment(file_text, config) {
+        return Ok(String::from(file_text));
+    }
+
+    let parsed_source_file = parse_swc_ast(file_path, file_text)?;
+    let print_items = parse(&parsed_source_file, config);
+
+    // println!("{}", print_items.get_as_text());
+
+    return Ok(print(print_items, PrintOptions {
+        indent_width: config.indent_width,
+        max_width: config.line_width,
+        use_tabs: config.use_tabs,
+        new_line_text: resolve_new_line_kind(file_text, config.new_line_kind),
+    }));
+
+    fn has_ignore_comment(file_text: &str, config: &Configuration) -> bool {
+        let mut iterator = super::utils::CharIterator::new(file_text.chars());
+        iterator.skip_whitespace();
+        if iterator.move_next() != Some('/') { return false; }
+        match iterator.move_next() {
+            Some('/') | Some('*') => {},
+            _ => return false,
+        }
+        iterator.skip_whitespace();
+        iterator.check_text(&config.ignore_file_comment_text)
+    }
+}

src/format_text.rs

@@ -2,11 +2,11 @@ extern crate dprint_core;
 
 pub mod configuration;
 mod parsing;
-mod formatter;
+mod format_text;
 mod swc;
 mod utils;
 
-pub use formatter::Formatter;
+pub use format_text::format_text;
 
 #[cfg(feature = "wasm")]
 #[cfg(all(target_arch = "wasm32", target_os = "unknown"))]

src/formatter.rs

@@ -1,5 +1,5 @@
 use std::collections::{HashMap};
-use std::path::PathBuf;
+use std::path::Path;
 use std::rc::Rc;
 use swc_common::{
     errors::{Handler, Emitter, DiagnosticBuilder},
@@ -17,7 +17,7 @@ pub struct ParsedSourceFile<'a> {
     pub trailing_comments: HashMap<BytePos, Vec<Comment>>,
 }
 
-pub fn parse_swc_ast<'a>(file_path: &PathBuf, file_text: &'a str) -> Result<ParsedSourceFile<'a>, String> {
+pub fn parse_swc_ast<'a>(file_path: &Path, file_text: &'a str) -> Result<ParsedSourceFile<'a>, String> {
     match parse_inner(file_path, file_text) {
         Ok(result) => Ok(result),
         Err(err) => {
@@ -35,7 +35,7 @@ pub fn parse_swc_ast<'a>(file_path: &PathBuf, file_text: &'a str) -> Result<Pars
     }
 }
 
-fn parse_inner<'a>(file_path: &PathBuf, file_text: &'a str) -> Result<ParsedSourceFile<'a>, String> {
+fn parse_inner<'a>(file_path: &Path, file_text: &'a str) -> Result<ParsedSourceFile<'a>, String> {
     let handler = Handler::with_emitter(false, false, Box::new(EmptyEmitter {}));
 
     let file_bytes = file_text.as_bytes();
@@ -87,9 +87,9 @@ fn parse_inner<'a>(file_path: &PathBuf, file_text: &'a str) -> Result<ParsedSour
         file_bytes,
     });
 
-    fn should_parse_as_jsx(file_path: &PathBuf) -> bool {
+    fn should_parse_as_jsx(file_path: &Path) -> bool {
         if let Some(extension) = get_lowercase_extension(file_path) {
-            return extension == "tsx" || extension == "jsx" || extension == "js";
+            return extension == "tsx" || extension == "jsx" || extension == "js" || extension == "mjs";
         }
         return true;
     }
@@ -106,7 +106,7 @@ fn parse_inner<'a>(file_path: &PathBuf, file_text: &'a str) -> Result<ParsedSour
     }
 }
 
-fn get_lowercase_extension(file_path: &PathBuf) -> Option<String> {
+fn get_lowercase_extension(file_path: &Path) -> Option<String> {
     file_path.extension().and_then(|e| e.to_str()).map(|f| f.to_lowercase())
 }
 
@@ -135,6 +135,7 @@ fn format_diagnostic(error: &DiagnosticBuilder, file_text: &str) -> String {
 #[cfg(test)]
 mod tests {
     use super::*;
+    use std::path::PathBuf;
 
     #[test]
     fn should_error_on_syntax_diagnostic() {

src/lib.rs

@@ -1,14 +1,13 @@
 use std::path::PathBuf;
 use dprint_core::generate_plugin_code;
 use super::configuration::{Configuration, resolve_config};
-use super::formatter::Formatter;
 
 fn get_plugin_config_key() -> String {
     String::from("typescript")
 }
 
 fn get_plugin_file_extensions() -> Vec<String> {
-    vec![String::from("ts"), String::from("tsx"), String::from("js"), String::from("jsx")]
+    vec![String::from("ts"), String::from("tsx"), String::from("js"), String::from("jsx"), String::from("mjs")]
 }
 
 fn get_plugin_help_url() -> String {
@@ -19,19 +18,8 @@ fn get_plugin_config_schema_url() -> String {
     String::new() // none until https://github.com/microsoft/vscode/issues/98443 is resolved
 }
 
-static mut FORMATTER: Option<Formatter> = None;
-
 fn format_text(file_path: &PathBuf, file_text: &str, config: &Configuration) -> Result<String, String> {
-    let formatter = unsafe {
-        if let Some(formatter) = FORMATTER.as_ref() {
-            formatter
-        } else {
-            let formatter = Formatter::new(config.clone());
-            FORMATTER.replace(formatter);
-            FORMATTER.as_ref().unwrap()
-        }
-    };
-    formatter.format_text(&file_path, &file_text)
+    super::format_text(file_path, file_text, config)
 }
 
 fn get_plugin_license_text() -> String {
@@ -43,7 +31,6 @@ fn get_plugin_license_text() -> String {
 pub fn reset_config() {
     unsafe {
         RESOLVE_CONFIGURATION_RESULT.take();
-        FORMATTER.take();
     }
 }
 

src/swc/parse_swc_ast.rs

@@ -0,0 +1,14 @@
+-- fileName: test.mjs --
+== should format mjs file ==
+class Test{ prop = 5}
+
+[expect]
+class Test {
+    prop = 5;
+}
+
+== should support JSX in mjs file ==
+const test     = <Test>Test</Test>;
+
+[expect]
+const test = <Test>Test</Test>;

src/wasm_plugin.rs

@@ -24,13 +24,12 @@ fn test_performance() {
         .quote_style(QuoteStyle::PreferSingle)
         .build();
     let file_text = fs::read_to_string("tests/performance/checker.txt").expect("Expected to read.");
-    let formatter = Formatter::new(config);
 
     //debug_here!();
 
     for i in 0..10 {
         let start = Instant::now();
-        let result = formatter.format_text(&PathBuf::from("checker.ts"), &file_text).expect("Could not parse...");
+        let result = format_text(&PathBuf::from("checker.ts"), &file_text, &config).expect("Could not parse...");
 
         println!("{}ms", start.elapsed().as_millis());
         println!("---");
@@ -54,8 +53,7 @@ fn test_specs() {
             let config_result = resolve_config(parse_config_key_map(spec_config), &global_config);
             ensure_no_diagnostics(&config_result.diagnostics);
 
-            let formatter = Formatter::new(config_result.config);
-            formatter.format_text(&file_name, &file_text)
+            format_text(&file_name, &file_text, &config_result.config)
         }
     )
 }