Refactor the formatter to use more idiomatic Rust, docstrings, and remove obsolete dependencies and configuration

Add `Formatter` struct

Author: NathanLovato

Cargo.lock

@@ -8,17 +8,13 @@ repository = "https://github.com/gdquest/gdscript-formatter"
 default-run = "gdscript-formatter"
 
 [dependencies]
-anyhow = "1.0"
 clap = { version = "4.0", features = ["derive"] }
 topiary-core = "0.6"
 tree-sitter-gdscript  = { git = "https://github.com/PrestonKnopp/tree-sitter-gdscript.git", rev = "9686853b696db07118ad110e440d6de0ca6498b4" }
 regex = "1.11"
 tree-sitter = "0.25.9"
 
 [dev-dependencies]
-assert_cmd = "2.0"
-predicates = "3.0"
-tempfile = "3.0"
 test_each_file = "0.3.5"
 similar = "2.7.0"
 
@@ -36,6 +32,4 @@ path = "src/scripts/benchmark.rs"
 
 [profile.release]
 strip = true
-debug = false
-opt-level = 3
 lto = true

Cargo.toml

@@ -1,8 +1,7 @@
 pub mod formatter;
 pub mod reorder;
 
-pub use formatter::{format_gdscript, format_gdscript_with_config};
-
+#[derive(Clone)]
 pub struct FormatterConfig {
     pub indent_size: usize,
     pub use_spaces: bool,

src/formatter.rs

@@ -69,7 +69,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     let args = Args::parse();
 
     let input_content = match &args.input {
-        Some(file_path) => fs::read_to_string(&file_path)
+        Some(file_path) => fs::read_to_string(file_path)
             .map_err(|e| format!("Failed to read file {}: {}", file_path.display(), e))?,
         None => {
             let mut buffer = String::new();
@@ -96,20 +96,16 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         println!("File is formatted");
     } else {
         match (args.input.as_ref(), args.stdout) {
-            // If there's no input file, always output to stdout
-            (None, _) => {
-                print!("{}", formatted_content);
-            }
-            // We're reading from a file and the --stdout flag is on: we output to stdout
-            (Some(_), true) => {
-                print!("{}", formatted_content);
-            }
-            // We're reading from a file without the --stdout flag: we overwrite the input file
+            // If we're reading from a file without the --stdout flag: we overwrite the input file
             (Some(input_file), false) => {
                 fs::write(input_file, formatted_content).map_err(|e| {
                     format!("Failed to write to file {}: {}", input_file.display(), e)
                 })?;
             }
+            // Otherwise we output to stdout
+            _ => {
+                print!("{}", formatted_content);
+            }
         }
     }
 

src/lib.rs

@@ -1,15 +1,12 @@
-/**
- * This module exposes a function that reorders GDScript code according to the
- * official GDScript style guide.
- *
- * It works as a separate processing pass that parses the GDScript code using
- * tree-sitter, detects top-level declarations, and reorders them according to
- * the style guide.
- *
- * We assume that you won't run this on every save, but rather manually using
- * a code editor command or task when you're met with a messy file.
- *
- */
+//! This module exposes a function that reorders GDScript code according to the
+//! official GDScript style guide.
+//!
+//! It works as a separate processing pass that parses the GDScript code using
+//! tree-sitter, detects top-level declarations, and reorders them according to
+//! the style guide.
+//!
+//! We assume that you won't run this on every save, but rather manually using
+//! a code editor command or task when you're met with a messy file.
 use tree_sitter::{Node, Query, QueryCursor, StreamingIterator, Tree};
 
 /// This method parses the GDScript content, extracts top-level elements,

src/main.rs

@@ -1,19 +1,19 @@
-/// This module tests the performance of the GDScript formatter. Use this to quickly test the
-/// performance impact of changes to the formatter locally.
-///
-/// Run cargo run --bin benchmark --release to compile and run the benchmark.
-/// You can use it in a shell script to compare performance between two git revisions.
-///
-/// For example, to compare between this commit and the previous one:
-///
-/// ```sh
-/// cargo run --bin benchmark --release > benchmark_results.txt
-/// echo "On previous commit:\n" >> benchmark_results.txt
-/// git checkout HEAD^
-/// cargo run --bin benchmark --release >> benchmark_results.txt
-/// git checkout -
-/// ```
-use gdscript_formatter::{format_gdscript_with_config, FormatterConfig};
+//! This module tests the performance of the GDScript formatter. Use this to quickly test the
+//! performance impact of changes to the formatter locally.
+//!
+//! Run cargo run --bin benchmark --release to compile and run the benchmark.
+//! You can use it in a shell script to compare performance between two git revisions.
+//!
+//! For example, to compare between this commit and the previous one:
+//!
+//! ```sh
+//! cargo run --bin benchmark --release > benchmark_results.txt
+//! echo "On previous commit:\n" >> benchmark_results.txt
+//! git checkout HEAD^
+//! cargo run --bin benchmark --release >> benchmark_results.txt
+//! git checkout -
+//! ```
+use gdscript_formatter::{formatter::format_gdscript_with_config, FormatterConfig};
 use std::{fs, time::Instant};
 
 const ITERATIONS: u16 = 100;

src/reorder.rs

@@ -1,4 +1,4 @@
-use gdscript_formatter::format_gdscript;
+use gdscript_formatter::formatter::format_gdscript;
 use similar::{ChangeTag, TextDiff};
 use std::fs;
 use std::path::Path;