rfmt 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9981b614b859c7c49e597686b89c79279ba977911b9a62d691aa0b88408eb0f
-  data.tar.gz: 1461e9bcf3ff3b298855963fdf2e6cdd0aca1b3e29bf6f5b9037e62889903469
+  metadata.gz: c712093f002557a29995a2838caede692a26e86d492c7f9f735e8fe9f2a5f5f4
+  data.tar.gz: a7ce48fbf06a56879d803cb848786310ff5e6dc091de1d8f8a9ff47a0bb00dac
 SHA512:
-  metadata.gz: 0b6aa80fa2df44397d1bdc81a12b860e1446a611f565e3283af8a821e691ca5122041f9622d48e2577740e878d740a1dba95df0a8c6acbea71c8301993f6fb46
-  data.tar.gz: a1f330f17114d738523adf1fdcc9ccc42590b028a754e32304d2d4724f9966d54e5a7467bd50c8884111bc3ff16780b9b9c7591a0a22d8cd1eb17ffa50a856ed
+  metadata.gz: '05954d426b7b6951e330d55d469ea78ebbf75350d755e0107eb0c4de32f5b11afd9373fbeabff3f7c2c902cfada70f4fae276c8b5d0d4d3b00eb3514a467fa0e'
+  data.tar.gz: cd4b6992cd4d795dfe8bd91f74504212337bcf7c13c736822919a071abda7ff0e1712f24e277786fa8b9a3ba6150b0727d33f415631c1707b6277c5612c94dbe

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.2.3] - 2025-01-25
+
+### Added
+- Configuration file (rfmt.yml) is now automatically loaded and applied during formatting
+- Automatic config file discovery in current directory, parent directories, and home directory
+- Support for custom indent_width and other formatting options via rfmt.yml
+
+### Changed
+- Default config file name changed from .rfmt.yml to rfmt.yml (hidden file to regular file)
+- Backward compatibility maintained: .rfmt.yml is still supported with lower priority
+- Config file search order: rfmt.yml > rfmt.yaml > .rfmt.yml > .rfmt.yaml
+- README updated to remove exaggerated expressions and focus on factual, data-driven descriptions
+
 ## [0.2.2] - 2025-01-25
 
 ### Fixed

data/Cargo.lock

@@ -1219,7 +1219,7 @@ checksum = "caf4aa5b0f434c91fe5c7f1ecb6a5ece2130b02ad2a590589dda5146df959001"
 
 [[package]]
 name = "rfmt"
-version = "0.2.2"
+version = "0.2.3"
 dependencies = [
  "anyhow",
  "clap",

data/README.md

@@ -65,15 +65,36 @@ Built-in logging system:
 - Performance metrics and timing data
 - Debug context information
 
-### Editor Integration
+## Performance Benchmarks
+
+Performance comparison with RuboCop on a Rails project (111 files, 3,231 lines):
+
+### Benchmark Results (Rails Project)
+
+| Scenario | rfmt | RuboCop | Speedup |
+|----------|------|---------|---------|
+| **Single File** | ~190ms | ~1.35s | **7.3x faster** |
+| **Directory (14 files)** | 168ms | 1.67s | **10.0x faster** |
+| **Full Project (111 files)** | 173ms | 10.09s | **58.5x faster** |
+| **Check Mode (CI/CD)** | 172ms | 1.55s | **9.0x faster** |
+
+### Key Metrics
+
+- Single file: Formats in ~190ms
+- Scaling: 58x faster on full project (111 files)
+- CI/CD: Check time reduced from 10.09s to 0.173s (98% reduction)
+- Variance: Low standard deviation across runs
 
-Compatible editors:
+### Throughput Comparison
 
-- Visual Studio Code
-- RubyMine / IntelliJ IDEA
-- Vim / Neovim
-- Emacs
-- Sublime Text
+| Directory | rfmt | RuboCop | Difference |
+|-----------|------|---------|------------|
+| app/models (14 files) | 83.5 files/s | 8.4 files/s | **10x throughput** |
+| test/ (30 files) | 168.1 files/s | 18.1 files/s | **9.3x throughput** |
+
+*Benchmark environment: Apple Silicon (arm64), macOS Darwin 23.6.0, Ruby 3.4.5*
+
+See [detailed benchmark report](docspriv/benchmark_report.md) for full data.
 
 ## Installation
 
@@ -168,7 +189,7 @@ Create a configuration file with default settings:
 rfmt init
 ```
 
-This creates a `.rfmt.yml` file with default settings:
+This creates a `rfmt.yml` file with default settings:
 
 ```yaml
 version: "1.0"
@@ -206,9 +227,9 @@ rfmt init --force
 
 rfmt automatically searches for configuration files in this order:
 
-1. Current directory (`.rfmt.yml` or `.rfmt.yaml`)
+1. Current directory (`rfmt.yml`, `rfmt.yaml`, `.rfmt.yml`, or `.rfmt.yaml`)
 2. Parent directories (up to root)
-3. User home directory (`~/.rfmt.yml` or `~/.rfmt.yaml`)
+3. User home directory (`rfmt.yml`, `rfmt.yaml`, `.rfmt.yml`, or `.rfmt.yaml`)
 4. Default settings (if no file found)
 
 #### Ruby API for Configuration
@@ -217,11 +238,11 @@ rfmt automatically searches for configuration files in this order:
 require 'rfmt'
 
 # Generate configuration file
-Rfmt::Config.init('.rfmt.yml', force: false)
+Rfmt::Config.init('rfmt.yml', force: false)
 
 # Find configuration file
 config_path = Rfmt::Config.find
-# => "/Users/username/project/.rfmt.yml"
+# => "/Users/username/project/rfmt.yml"
 
 # Check if configuration exists
 Rfmt::Config.exists?
@@ -312,37 +333,6 @@ class User < ApplicationRecord
 end
 ```
 
-## Performance Benchmarks
-
-Performance comparison with RuboCop on a Rails project (111 files, 3,231 lines):
-
-### Benchmark Results (Rails Project)
-
-| Scenario | rfmt | RuboCop | Speedup |
-|----------|------|---------|---------|
-| **Single File** | ~190ms | ~1.35s | **7.3x faster** |
-| **Directory (14 files)** | 168ms | 1.67s | **10.0x faster** |
-| **Full Project (111 files)** | 173ms | 10.09s | **58.5x faster** |
-| **Check Mode (CI/CD)** | 172ms | 1.55s | **9.0x faster** |
-
-### Key Metrics
-
-- Single file: Formats in ~190ms
-- Scaling: 58x faster on full project (111 files)
-- CI/CD: Check time reduced from 10.09s to 0.173s (98% reduction)
-- Variance: Low standard deviation across runs
-
-### Throughput Comparison
-
-| Directory | rfmt | RuboCop | Difference |
-|-----------|------|---------|------------|
-| app/models (14 files) | 83.5 files/s | 8.4 files/s | **10x throughput** |
-| test/ (30 files) | 168.1 files/s | 18.1 files/s | **9.3x throughput** |
-
-*Benchmark environment: Apple Silicon (arm64), macOS Darwin 23.6.0, Ruby 3.4.5*
-
-See [detailed benchmark report](docspriv/benchmark_report.md) for full data.
-
 ## Documentation
 
 Documentation is available in the [docs](docs/) directory. See [User Guide](docs/user_guide.md) or [Contributing Guide](CONTRIBUTING.md) for details.
@@ -358,7 +348,7 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
 | Feature | rfmt | RuboCop |
 |---------|------|---------|
 | **Primary Purpose** | Code formatting | Linting + formatting |
-| **Speed** | 58x faster (tested benchmark) | Ruby-based |
+| **Speed** | 58x faster (tested benchmark) | Baseline |
 | **Configuration** | Minimal | Extensive |
 | **Code Quality Checks** | No | Yes |
 | **Bug Detection** | No | Yes |
@@ -377,7 +367,6 @@ Everyone interacting in the rfmt project's codebases, issue trackers, chat rooms
 
 - 📖 [Documentation](docs/)
 - 🐛 [Issues](https://github.com/fujitanisora/rfmt/issues)
-- 💬 [Discussions](https://github.com/fujitanisora/rfmt/discussions)
 - 📧 Email: fujitanisora0414@gmail.com
 
 ## Acknowledgments

data/ext/rfmt/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rfmt"
-version = "0.2.2"
+version = "0.2.3"
 edition = "2021"
 authors = ["fujitani sora <fujitanisora0414@gmail.com>"]
 license = "MIT"

data/ext/rfmt/src/config/mod.rs

@@ -99,8 +99,45 @@ pub enum TrailingComma {
 }
 
 impl Config {
+    /// Discover configuration file in current directory or parent directories
+    /// Searches in order: rfmt.yml, rfmt.yaml, .rfmt.yml, .rfmt.yaml
+    pub fn discover() -> crate::error::Result<Self> {
+        let config_files = ["rfmt.yml", "rfmt.yaml", ".rfmt.yml", ".rfmt.yaml"];
+
+        // Try current directory and parent directories
+        if let Ok(mut current_dir) = std::env::current_dir() {
+            loop {
+                for filename in &config_files {
+                    let config_path = current_dir.join(filename);
+                    if config_path.exists() {
+                        log::debug!("Found config file: {:?}", config_path);
+                        return Self::load_file(&config_path);
+                    }
+                }
+
+                // Move to parent directory
+                if !current_dir.pop() {
+                    break;
+                }
+            }
+        }
+
+        // Try home directory
+        if let Some(home_dir) = dirs::home_dir() {
+            for filename in &config_files {
+                let config_path = home_dir.join(filename);
+                if config_path.exists() {
+                    log::debug!("Found config file in home: {:?}", config_path);
+                    return Self::load_file(&config_path);
+                }
+            }
+        }
+
+        log::debug!("No config file found, using defaults");
+        Ok(Config::default())
+    }
+
     /// Load configuration from a YAML file
-    #[cfg(test)]
     pub fn load_file(path: &std::path::Path) -> crate::error::Result<Self> {
         use crate::error::RfmtError;
 
@@ -119,7 +156,6 @@ impl Config {
     }
 
     /// Validate configuration values
-    #[cfg(test)]
     fn validate(&self) -> crate::error::Result<()> {
         use crate::error::RfmtError;
 
@@ -145,7 +181,6 @@ impl Config {
     }
 
     /// Get the indent string based on configuration
-    #[cfg(test)]
     pub fn indent_string(&self) -> String {
         match self.formatting.indent_style {
             IndentStyle::Spaces => " ".repeat(self.formatting.indent_width),

data/ext/rfmt/src/error/mod.rs

@@ -18,7 +18,6 @@ pub enum RfmtError {
     },
 
     #[error("Configuration error: {message}")]
-    #[cfg(test)]
     ConfigError { message: String },
 }
 
@@ -36,7 +35,6 @@ impl RfmtError {
             RfmtError::PrismError(_) => "PrismError",
             RfmtError::FormatError(_) => "FormatError",
             RfmtError::UnsupportedFeature { .. } => "UnsupportedFeature",
-            #[cfg(test)]
             RfmtError::ConfigError { .. } => "ConfigError",
         };
 

data/ext/rfmt/src/lib.rs

@@ -25,7 +25,8 @@ fn format_ruby_code(ruby: &Ruby, source: String, json: String) -> Result<String,
     let parser = PrismAdapter::new();
     let ast = parser.parse(&json).map_err(|e| e.to_magnus_error(ruby))?;
 
-    let config = Config::default();
+    // Load configuration from file or use defaults
+    let config = Config::discover().map_err(|e| e.to_magnus_error(ruby))?;
     let mut emitter = Emitter::with_source(config, source);
 
     let formatted = emitter.emit(&ast).map_err(|e| e.to_magnus_error(ruby))?;

data/lib/rfmt/configuration.rb

@@ -18,7 +18,7 @@ module Rfmt
       'exclude' => ['vendor/**/*', 'tmp/**/*', 'node_modules/**/*']
     }.freeze
 
-    CONFIG_FILES = ['.rfmt.yml', '.rfmt.yaml', 'rfmt.yml', 'rfmt.yaml'].freeze
+    CONFIG_FILES = ['rfmt.yml', 'rfmt.yaml', '.rfmt.yml', '.rfmt.yaml'].freeze
 
     attr_reader :config
 

data/lib/rfmt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rfmt
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/rfmt.rb

@@ -95,10 +95,10 @@ module Rfmt
     YAML
 
     # Generate a default configuration file
-    # @param path [String] Path where to create the config file (default: .rfmt.yml)
+    # @param path [String] Path where to create the config file (default: rfmt.yml)
     # @param force [Boolean] Overwrite existing file if true
     # @return [Boolean] true if file was created, false if already exists
-    def self.init(path = '.rfmt.yml', force: false)
+    def self.init(path = 'rfmt.yml', force: false)
       if File.exist?(path) && !force
         warn "Configuration file already exists: #{path}"
         warn 'Use force: true to overwrite'
@@ -116,7 +116,7 @@ module Rfmt
       current_dir = Dir.pwd
 
       loop do
-        ['.rfmt.yml', '.rfmt.yaml'].each do |filename|
+        ['rfmt.yml', 'rfmt.yaml', '.rfmt.yml', '.rfmt.yaml'].each do |filename|
           config_path = File.join(current_dir, filename)
           return config_path if File.exist?(config_path)
         end
@@ -134,7 +134,7 @@ module Rfmt
         nil
       end
       if home_dir
-        ['.rfmt.yml', '.rfmt.yaml'].each do |filename|
+        ['rfmt.yml', 'rfmt.yaml', '.rfmt.yml', '.rfmt.yaml'].each do |filename|
           config_path = File.join(home_dir, filename)
           return config_path if File.exist?(config_path)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rfmt
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - fujitani sora