ruby-lsp-rubyfmt-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed5cb1b1289eb0b163a41623c2747754ec8c8c26aeb98221290445be1bd5a767
+  data.tar.gz: 68244f3c075f5286267cf0e7f525a0385227f0ae57ae15135a50f20202f9d15a
+SHA512:
+  metadata.gz: a6d7d26044b7cf7f9430fabf3e727276d1d4ad1f8f97d2d3cc921db60f5e8b2da948b88aed97d0aa52bcdb514eb4dd1810af12ffeb246f8c2b19aa3059fb4657
+  data.tar.gz: 3a5b50120bfe500ad94737055ec8ba86e6f7872eda1a5861ec400fe797a626662a257ddb6659d3a626c0a40ecbe1524bcd75a31d9f7dc9d9661eca3ba56efa4e

data/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "[ruby]": {
+        "editor.defaultFormatter": "Shopify.ruby-lsp",
+        "editor.formatOnSave": true
+    },
+    "rubyLsp.formatter": "rubyfmt",
+}

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Reese Williams
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# `ruby-lsp-rubyfmt-formatter`
+
+A [Ruby LSP](https://github.com/Shopify/ruby-lsp) add-on that provides formatting support using [rubyfmt](https://github.com/fables-tales/rubyfmt).
+
+## Installation
+
+Add this gem to your application's Gemfile:
+
+```bash
+bundle add ruby-lsp-rubyfmt-formatter
+```
+
+Or install it directly:
+
+```bash
+gem install ruby-lsp-rubyfmt-formatter
+```
+
+## Usage
+
+Once installed, configure your VSCode settings to use rubyfmt as the formatter:
+
+```json
+{
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp",
+    "editor.formatOnSave": true
+  },
+  "rubyLsp.formatter": "rubyfmt"
+}
+```
+
+By default, the extension uses the `rubyfmt` in your PATH, or see the configuration options below for passing a specific path.
+
+For instructions on installing `rubyfmt` itself, see [the docs](https://github.com/fables-tales/rubyfmt?tab=readme-ov-file#how-do-i-use-it).
+
+### Configuration Options
+
+You can customize the rubyfmt behavior via `rubyLsp.addonSettings` in your VSCode settings:
+
+```json
+{
+  "rubyLsp.formatter": "rubyfmt",
+  "rubyLsp.addonSettings": {
+    "rubyfmt": {
+      "rubyfmtPath": "/custom/path/to/rubyfmt",
+      "rubyfmtArgs": "--include-gitignored"
+    }
+  }
+}
+```
+
+#### Available Options
+
+| Option        | Type   | Default     | Description                                           |
+| ------------- | ------ | ----------- | ----------------------------------------------------- |
+| `rubyfmtPath` | String | `"rubyfmt"` | Path to the rubyfmt executable. Uses PATH by default. |
+| `rubyfmtArgs` | String | `""`        | Additional arguments to pass to rubyfmt.              |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/reese/ruby-lsp-rubyfmt-formatter.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task(default: %i[test])

data/lib/ruby_lsp/rubyfmt_formatter/addon.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ruby_lsp/internal"
+require "open3"
+
+module RubyLsp
+  module RubyfmtFormatter
+    class Addon < ::RubyLsp::Addon
+      def activate(global_state, message_queue)
+        @message_queue = message_queue
+        global_state.register_formatter("rubyfmt", Formatter.new(global_state))
+      end
+
+      def deactivate
+      end
+
+      def name
+        "rubyfmt Formatter"
+      end
+    end
+
+    class Formatter
+      include RubyLsp::Requests::Support::Formatter
+
+      def initialize(global_state)
+        @global_state = global_state
+      end
+
+      def run_formatting(uri, document)
+        source = document.source
+        command = build_command
+
+        stdout, stderr, status = Open3.capture3(*command, stdin_data: source)
+
+        unless status.success?
+          raise StandardError, "`rubyfmt` failed: #{stderr}"
+        end
+
+        stdout
+      end
+
+      def run_range_formatting(_uri, _source, _base_indentation)
+        # rubyfmt doesn't support range formatting
+      end
+
+      def run_diagnostic(_uri, _document)
+        # rubyfmt doesn't emit diagnostics
+      end
+
+      private def build_command
+        path = rubyfmt_executable
+        args = additional_args
+
+        [path] + args
+      end
+
+      private def rubyfmt_executable
+        # Fall back to PATH if nothing is provided
+        settings.fetch("rubyfmtPath", "rubyfmt")
+      end
+
+      private def additional_args
+        args_string = settings.fetch("rubyfmtArgs", "")
+        return [] if args_string.empty?
+
+        args_string.split
+      end
+
+      private def settings
+        addon_settings = @global_state.settings_for_addon("rubyfmt")
+        addon_settings || {}
+      end
+    end
+  end
+end

data/lib/ruby_lsp/rubyfmt_formatter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module RubyfmtFormatter
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-rubyfmt-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Reese Williams
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+email:
+- reese@reesew.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".vscode/settings.json"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_lsp/rubyfmt_formatter/addon.rb
+- lib/ruby_lsp/rubyfmt_formatter/version.rb
+homepage: https://github.com/reese/ruby-lsp-rubyfmt-formatter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/reese/ruby-lsp-rubyfmt-formatter
+  source_code_uri: https://github.com/reese/ruby-lsp-rubyfmt-formatter
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: A Ruby LSP add-on for formatting with `rubyfmt`.
+test_files: []