rfmt 1.5.3-aarch64-linux → 1.6.1-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d82f09486291a07109b0fdc54c23899b3e9c077cb38109fc547a0e565c59cb29
-  data.tar.gz: f63b715d048236b81484a0fcd46d1fe7b4cfa995ac91f3aebd94f3999ce4b351
+  metadata.gz: e36c79a715864d1545b7646e65a9de6afe9d2502fdc60702fe595c9c94fccba0
+  data.tar.gz: 40c48ce63e3d9d7f64593635dd13217079eab96e209861fe5529f715160c8ea3
 SHA512:
-  metadata.gz: edc982a72084c9b06334d1c9f3a78d50774ecd0275d0f6fb427c63f56d3c4b99cf2d7c6c3dd227c8a4188769299f0d96b61cad38fbdba2452dd1234d2aeaf209
-  data.tar.gz: aade66d5d03618a45d203c9adc5b83bef8b67aafdce56021bb2982a77b7ed64b82b56a25c25f2b506068f04841bb0bab26908606d463bfe34fd357f2162757c9
+  metadata.gz: d0e411f31a9c4c49be7cff8ecbe7f15f2196b4a005888eecdf206a7fdf6ba098e85fae7ce5ec8675920a43eb7a0fe22687930660b66a88c411d5353dcf3fbd23
+  data.tar.gz: 969b21932415241c2868e1adcda98e9c7e98942522c7aacb025fbaaa53b6543665142cebcdaaead4ff86c4f360e9d17286aa50b06599dddc7b2bf491b2799ad6

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 ## [Unreleased]
 
+## [1.6.1] - 2026-04-24
+
+Follow-up release consolidating the 1.6.0 architecture work.
+
+### Rule-based formatter
+
+The rule-based `format/` pipeline (`Formatter`, `Registry`, `Rule`) is the canonical formatting path, replacing the legacy monolithic emitter. Rules covering body indentation (`StatementsRule`), singleton classes (`SingletonClassRule`), and variable writes (`VariableWriteRule`) ship as part of the default registry. The Intermediate Representation (IR) module decouples parsing from emission for composability and testability.
+
+### Method chain reformatting
+
+Multi-line method chains can be reformatted from aligned style (indented under the first dot) to indented style (one level beyond the receiver), preserving the source's base indent. The pass is wired into the fallback path for resilience.
+
+### Printer optimizations
+
+The printer carries a pre-computed indent cache and inline hints for the hot path; `reformat_chain_lines` has been deduplicated across rules and uses `Cow<str>` to avoid allocations on pass-through.
+
+### Editor integration
+
+Setup guides for VSCode, Neovim, Helix, Emacs, and Zed land in the repository; every editor uses the Ruby LSP addon system, so there are no editor-specific plugins to maintain. The README's Editor Integration section replaces the previous "Coming Soon" placeholder with a VSCode quick start.
+
+## [1.6.0] - 2026-04-23
+
+### Added
+- **Rule-based formatter architecture**: new modular `format/` pipeline (`Formatter`, `Registry`, `Rule`) replacing the legacy monolithic emitter
+- **Intermediate Representation (IR) module**: decouples parsing from emission for composability and testability
+- New formatter rules: `StatementsRule` (body indentation), `SingletonClassRule`, `VariableWriteRule`
+- Method chain reformatting: convert aligned style to indented style when lines exceed the configured width
+- Chain reformatting wired into the fallback path for resilience
+- `config` module exported for test consumption
+- **Editor Integration Documentation**: comprehensive setup guides for VSCode, Neovim, Helix, Emacs, and Zed
+  - VSCode: Format on Save configuration with Ruby LSP, settings reference table, project-specific setup
+  - Zed: full configuration with `initialization_options` and `format_on_save`
+  - All editors work through the Ruby LSP addon system — no editor-specific plugins required
+- README: Editor Integration section updated with VSCode quick start (replacing "Coming Soon")
+
+### Changed
+- Printer optimized with indent cache and inline hints
+- `reformat_chain_lines` deduplicated across rules and optimized with `Cow` to reduce allocations
+- README: Neovim integration updated from CLI-based to Ruby LSP-based approach
+- Removed Sublime Text section from editor documentation (replaced by Zed)
+
+### Fixed
+- Prism comment JSON deserialization now accepts `comment_type` and `embdoc` fields (#97)
+- BTreeMap range panic when computing comment indices on edge inputs
+- Comment duplication during source extraction
+- Empty source input handled gracefully by the formatter runner
+- Clippy warnings: use `repeat_n`
+
+### Removed
+- Legacy `Emitter` module (1844 LOC) — superseded by the new `Formatter`
+
 ## [1.5.3] - 2026-02-22
 
 ### Changed

data/README.md

@@ -361,30 +361,34 @@ end
 
 ## Editor Integration
 
-### Neovim
+rfmt integrates with editors through [Ruby LSP](https://shopify.github.io/ruby-lsp/). For detailed setup instructions, see [Editor Integration Guide](docs/editors.md).
+
+### VSCode (Quick Start)
 
-Format Ruby files on save using autocmd:
+1. Install [Ruby LSP extension](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp)
+2. Add to your `settings.json`:
+
+```json
+{
+  "rubyLsp.formatter": "rfmt",
+  "editor.formatOnSave": true,
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp"
+  }
+}
+```
+
+### Neovim
 
 ```lua
--- ~/.config/nvim/init.lua
-
-vim.api.nvim_create_autocmd("BufWritePre", {
-  pattern = { "*.rb", "*.rake", "Gemfile", "Rakefile" },
-  callback = function()
-    local filepath = vim.fn.expand("%:p")
-    local result = vim.fn.system({ "rfmt", filepath })
-    if vim.v.shell_error == 0 then
-      vim.cmd("edit!")
-    end
-  end,
+require("lspconfig").ruby_lsp.setup({
+  init_options = {
+    formatter = "rfmt"
+  }
 })
 ```
 
-### Coming Soon
-
-- **VS Code** - Extension in development
-- **RubyMine** - Plugin in development
-- **Zed** - Extension in development
+See [Editor Integration Guide](docs/editors.md) for Helix, Emacs, Sublime Text, and more.
 
 ## Development
 

data/lib/rfmt/prism_bridge.rb

@@ -62,17 +62,28 @@ module Rfmt
     # Serialize the Prism AST with comments to JSON
     def self.serialize_ast_with_comments(result)
       comments = result.comments.map do |comment|
+        loc = comment.location
+        end_line = loc.end_line
+        # Prism's `=begin ... =end` (EmbDocComment) location ends at
+        # `<=end_line>:0`, i.e. the column-0 start of the line AFTER the
+        # `=end` terminator. Reporting that larger end_line makes the
+        # comment appear to overlap with the next statement, so the
+        # comment gets misattributed to a deeper node (e.g. the first
+        # expression inside the next method body) and ends up emitted in
+        # the wrong place. Snap it back to the terminator line.
+        end_line = loc.end_line - 1 if loc.end_column.zero? && loc.end_line > loc.start_line
+
         {
           comment_type: comment.class.name.split('::').last.downcase.gsub('comment', ''),
           location: {
-            start_line: comment.location.start_line,
-            start_column: comment.location.start_column,
-            end_line: comment.location.end_line,
-            end_column: comment.location.end_column,
-            start_offset: comment.location.start_offset,
-            end_offset: comment.location.end_offset
+            start_line: loc.start_line,
+            start_column: loc.start_column,
+            end_line: end_line,
+            end_column: loc.end_column,
+            start_offset: loc.start_offset,
+            end_offset: loc.end_offset
           },
-          text: comment.location.slice,
+          text: loc.slice,
           position: 'leading' # Default position, will be refined by Rust
         }
       end
@@ -120,7 +131,7 @@ module Rfmt
         closing = node.closing_loc
         if closing.end_offset > end_offset
           end_offset = closing.end_offset
-          end_line = closing.end_line
+          end_line = heredoc_terminator_line(closing)
           end_column = closing.end_column
         end
       end
@@ -145,6 +156,19 @@ module Rfmt
       }
     end
 
+    # Prism reports a heredoc's `closing_loc` as `<terminator_line>:0..(terminator_line+1):0`,
+    # i.e. its `end_line` is the LINE AFTER the terminator. Using that as the
+    # node's `end_line` makes blank-line preservation fail: a real blank line
+    # right after the terminator looks identical (diff == 1) to two adjacent
+    # statements with no separator. Use the terminator's own line instead.
+    def self.heredoc_terminator_line(closing_loc)
+      if closing_loc.end_column.zero? && closing_loc.end_line > closing_loc.start_line
+        closing_loc.start_line
+      else
+        closing_loc.end_line
+      end
+    end
+
     # Recursively find the maximum closing_loc among all descendant nodes
     # Returns nil if no closing_loc found, otherwise { end_offset:, end_line:, end_column: }
     def self.find_max_closing_loc_recursive(node, depth: 0)
@@ -158,7 +182,7 @@ module Rfmt
           if max_closing.nil? || closing.end_offset > max_closing[:end_offset]
             max_closing = {
               end_offset: closing.end_offset,
-              end_line: closing.end_line,
+              end_line: heredoc_terminator_line(closing),
               end_column: closing.end_column
             }
           end
@@ -424,9 +448,16 @@ module Rfmt
           metadata['name'] = name
         end
       when Prism::DefNode
-        if (name = extract_node_name(node))
-          metadata['name'] = name
-        end
+        # Prefer `name_loc.slice` over `name.to_s` so unary operator suffixes
+        # (`def !@`, `def +@`, `def -@`) survive the round-trip. Prism
+        # normalizes `name` to the symbol with the `@` stripped for `!@`,
+        # which would otherwise rewrite `def !@` to `def !` silently.
+        name = if node.respond_to?(:name_loc) && node.name_loc
+                 node.name_loc.slice
+               else
+                 extract_node_name(node)
+               end
+        metadata['name'] = name if name
         metadata['parameters_count'] = extract_parameter_count(node).to_s
         # Extract parameters text directly from source
         if node.parameters

data/lib/rfmt/version.rb

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

data/lib/ruby_lsp/rfmt/formatter_runner.rb

@@ -10,6 +10,8 @@ module RubyLsp
       # @return [String, nil] Formatted text or nil on error
       def run_formatting(_uri, document)
         source = document.source
+        return "\n" if source.empty?
+
         ::Rfmt.format(source)
       rescue ::Rfmt::Error
         nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfmt
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.1
 platform: aarch64-linux
 authors:
 - fujitani sora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-02-22 00:00:00.000000000 Z
+date: 2026-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs