rfmt 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d42c0061474a8e7ef36fc5cbce1d7bfdad2bc5a9dbbff9b1a2c2b700b373c6ca
-  data.tar.gz: f12d17ab726936fbdf69e4e5aaf3bca55fadf49230aa641adf0cba61c363f5ca
+  metadata.gz: 1344ebd75598608c54dc975f8afecc17be05152039542ac1c1e80007086530fc
+  data.tar.gz: b5a29adb45e5163fdfdbbea2526d4ac72bdbca410ee86e888ecb224f3b98c922
 SHA512:
-  metadata.gz: 51948c8616f667de54435f87f7e154209c27777e82a84ada9f73d97c8928f68a063da72c1d7268035ca7d8d6e3eec658e4f6d874770658501edaad68a512ecdf
-  data.tar.gz: e9a794b23d30ba314aa2b0f5fcacb6bbaff7408430bab6623169ef7d76fad53f32f58789e2a0a828a3b9e38dc074ca22bb0c4ff93f023e7c1a8c000081ba66e5
+  metadata.gz: 71db0a1b94b8a2288a5fae7e3a09ec41fac6e834abd9760fd45b4ac7dfef71baac7ada32582a6018b74fa22a6d0711f529b8372c491179dfbe66cc9c56c287aa
+  data.tar.gz: c7dc265d4ba68a15c653715bd26d8c087be6d361a7bb3170bd59057c0b9a65cfbf2093c02ff8528dcffd8a2b4ca445faef2fdc4fa4c5035016360d64ad297b9e

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-11-25
+
+### Changed
+- **BREAKING**: Default configuration file name changed from `rfmt.yml` to `.rfmt.yml`
+  - `rfmt init` now creates `.rfmt.yml` instead of `rfmt.yml`
+  - Configuration file search order updated: `.rfmt.yml` > `.rfmt.yaml` > `rfmt.yml` > `rfmt.yaml`
+  - This follows Ruby community conventions for hidden configuration files
+  - Backward compatibility maintained: `rfmt.yml` is still supported
+- Updated README.md to use `.rfmt.yml` in all examples and documentation
+- Updated benchmark data with latest accurate measurements (3,241 lines, more realistic performance ratios)
+- Removed exaggerated performance claims from README and documentation
+- Simplified feature descriptions in README (removed Error Handling and Logging from Features section)
+
+### Documentation
+- Updated user guides (English and Japanese) to reflect `.rfmt.yml` as default
+- Updated version information in documentation to 0.2.4 → 0.3.0
+- Updated benchmark documentation with accurate data from latest measurements
+- Added configuration verification examples in examples/ directory
+- Improved Ruby API examples with clearer input/output distinction
+
 ## [0.2.4] - 2025-11-25
 
 ### Fixed

data/Cargo.lock

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

data/README.md

@@ -22,21 +22,16 @@ A Ruby code formatter written in Rust
 
 **rfmt** is a Ruby code formatter that enforces consistent style across your codebase. Key characteristics:
 
-- **Rust implementation**: Provides faster execution than Ruby-based tools
 - **Opinionated**: Minimal configuration with consistent output
 - **Idempotent**: Running multiple times produces identical results
 - **Comment preservation**: Maintains existing comment placement
-- **Error handling**: Includes structured error messages and logging
+- **Rust implementation**: Core formatter implemented in Rust
 
 ## Features
 
 ### Performance
 
-Built with Rust for improved execution speed:
-
-- Benchmark shows 7-58x faster than RuboCop depending on project size (see Performance Benchmarks section)
-- Processes 168 files/second in tested Rails project
-- Supports parallel processing
+Built with Rust for improved execution speed. See Performance Benchmarks section for details.
 
 ### Consistent Style
 
@@ -47,54 +42,26 @@ Enforces code style rules:
 - Quote style standardization
 - Method definition formatting
 
-### Error Handling
-
-Provides structured error messages:
-
-- Error codes (E001-E999) for categorization
-- Code snippets showing error locations
-- Help URLs linking to documentation
-- Recovery strategies for handling errors
-
-### Logging
-
-Built-in logging system:
-
-- 5 log levels (ERROR, WARN, INFO, DEBUG, TRACE)
-- Structured output format
-- Performance metrics and timing data
-- Debug context information
-
 ## Performance Benchmarks
 
-Performance comparison with RuboCop on a Rails project (111 files, 3,231 lines):
+Performance comparison with RuboCop on a Rails project (111 files, 3,241 lines):
 
-### Benchmark Results (Rails Project)
+| Test Type | Files | rfmt | RuboCop | Ratio |
+|-----------|-------|------|---------|-------|
+| Single File | 1 | 191ms | 1.38s | 7.2x |
+| Directory | 14 | 176ms | 1.68s | 9.6x |
+| Full Project (check) | 111 | 172ms | 4.36s | 25.4x |
 
-| 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** |
+**Observations:**
+- rfmt execution time remains constant (172-191ms) regardless of file count
+- Low variance across runs (standard deviation: 8-23ms)
 
-### Key Metrics
+**Test Environment:**
+- CPU: Apple Silicon (arm64)
+- Ruby: 3.4.5
+- rfmt: 0.2.4, RuboCop: 1.81.7
 
-- 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.
+See [detailed benchmark report](docs/benchmark.md) for complete data.
 
 ## Installation
 
@@ -132,6 +99,48 @@ bundle exec rake compile
 
 ## Usage
 
+### Initialize Configuration
+
+First, create a configuration file with default settings:
+
+```bash
+rfmt init
+```
+
+This creates a `.rfmt.yml` file with default settings:
+
+```yaml
+version: "1.0"
+
+formatting:
+  line_length: 100        # Maximum line length (40-500)
+  indent_width: 2         # Spaces/tabs per indent (1-8)
+  indent_style: "spaces"  # "spaces" or "tabs"
+  quote_style: "double"   # "double", "single", or "consistent"
+
+include:
+  - "**/*.rb"
+  - "**/*.rake"
+  - "**/Rakefile"
+  - "**/Gemfile"
+
+exclude:
+  - "vendor/**/*"
+  - "tmp/**/*"
+  - "node_modules/**/*"
+  - "db/schema.rb"
+```
+
+**Options:**
+
+```bash
+# Specify custom path
+rfmt init --path config/.rfmt.yml
+
+# Overwrite existing configuration
+rfmt init --force
+```
+
 ### Command Line
 
 Format a single file:
@@ -152,16 +161,24 @@ Check if files need formatting (CI/CD):
 rfmt check .
 ```
 
+Show diff without modifying files:
+
+```bash
+rfmt format lib/user.rb --diff
+```
+
 ### Ruby API
 
+**Input (unformatted code):**
+
 ```ruby
 require 'rfmt'
 
 source = <<~RUBY
   class User
-    def initialize(name)
-      @name=name
-    end
+  def initialize(name)
+  @name=name
+  end
   end
 RUBY
 
@@ -169,67 +186,25 @@ formatted = Rfmt.format(source)
 puts formatted
 ```
 
-**Output:**
+**Output (formatted code):**
 
 ```ruby
 class User
   def initialize(name)
-    @name = name
+    @name=name
   end
 end
 ```
 
 ### Configuration
 
-#### Initializing Configuration
-
-Create a configuration file with default settings:
-
-```bash
-rfmt init
-```
-
-This creates a `rfmt.yml` file with default settings:
-
-```yaml
-version: "1.0"
-
-formatting:
-  line_length: 100        # Maximum line length (40-500)
-  indent_width: 2         # Spaces/tabs per indent (1-8)
-  indent_style: "spaces"  # "spaces" or "tabs"
-  quote_style: "double"   # "double", "single", or "consistent"
-
-include:
-  - "**/*.rb"
-  - "**/*.rake"
-  - "**/Rakefile"
-  - "**/Gemfile"
-
-exclude:
-  - "vendor/**/*"
-  - "tmp/**/*"
-  - "node_modules/**/*"
-  - "db/schema.rb"
-```
-
-**Options:**
-
-```bash
-# Specify custom path
-rfmt init --path config/rfmt.yml
-
-# Overwrite existing configuration
-rfmt init --force
-```
-
 #### Configuration File Discovery
 
 rfmt automatically searches for configuration files in this order:
 
-1. Current directory (`rfmt.yml`, `rfmt.yaml`, `.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`, `rfmt.yaml`, `.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
@@ -238,11 +213,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?
@@ -253,59 +228,6 @@ config = Rfmt::Config.load
 # => {"version"=>"1.0", "formatting"=>{"line_length"=>100, ...}, ...}
 ```
 
-## Error Handling
-
-rfmt provides structured error messages:
-
-```
-[Rfmt::ParseError] Parse error in app/models/user.rb:15:10
-Expected closing 'end' for class definition
-
-Code:
-  13 | class User < ApplicationRecord
-  14 |   def initialize(name)
-  15 |     @name = name
-     |          ^
-  16 | # Missing 'end' for method
-  17 | end
-
-Help: https://rfmt.dev/errors/E001
-```
-
-### Error Codes
-
-| Code | Type | Description |
-|------|------|-------------|
-| E001 | ParseError | Ruby syntax error |
-| E002 | ConfigError | Invalid configuration |
-| E003 | IoError | File read/write error |
-| E004 | FormattingError | Formatting process error |
-| E005 | RuleError | Rule application failed |
-| E006 | UnsupportedFeature | Feature not yet supported |
-| E007 | PrismError | Parser integration error |
-| E008 | FormatError | General formatting error |
-| E999 | InternalError | Internal bug (please report!) |
-
-See the [Error Reference](docs/error_reference.md) for detailed information.
-
-## Logging
-
-rfmt includes a logging system:
-
-```ruby
-# Logs are automatically output during initialization
-require 'rfmt'
-# [INFO] rfmt - Initializing rfmt Rust extension
-# [INFO] rfmt - rfmt Rust extension initialized successfully
-```
-
-Log levels:
-- **ERROR**: Critical errors
-- **WARN**: Warnings
-- **INFO**: General information (default)
-- **DEBUG**: Debug information
-- **TRACE**: Detailed trace information
-
 ## Examples
 
 ### Before Formatting
@@ -335,7 +257,11 @@ end
 
 ## Documentation
 
-Documentation is available in the [docs](docs/) directory. See [User Guide](docs/user_guide.md) or [Contributing Guide](CONTRIBUTING.md) for details.
+Documentation is available in the [docs](docs/) directory:
+
+- [User Guide](docs/user_guide.md) - Comprehensive usage guide
+- [Error Reference](docs/error_reference.md) - Error codes and troubleshooting
+- [Contributing Guide](CONTRIBUTING.md) - How to contribute
 
 ## Contributing
 
@@ -348,12 +274,11 @@ 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) | Baseline |
 | **Configuration** | Minimal | Extensive |
 | **Code Quality Checks** | No | Yes |
 | **Bug Detection** | No | Yes |
 
-**Note**: rfmt focuses on formatting speed, while RuboCop provides additional code quality analysis. They can be used together.
+**Note**: rfmt focuses on code formatting, while RuboCop provides additional code quality analysis. They can be used together.
 
 ## License
 

data/ext/rfmt/Cargo.toml

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

data/lib/rfmt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rfmt
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 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', '.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', '.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfmt
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - fujitani sora
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-24 00:00:00.000000000 Z
+date: 2025-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys