rubocop-rubyfmt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f586cfd1ffc7386de88b57de617856b9167ead93e62265cddeb165daefa159d
+  data.tar.gz: 852bed5eb157c8bebf8b48c47749923a92d510f6b96c8ca4f1faf1365b7c4b22
+SHA512:
+  metadata.gz: 41819404358b145c83c7aab4c4beb1e911d0b00ec544e0a416856a3bd247ab8a392939a8c7440dcf71f280fd148bdcd6855df86fa14e10a70423841b4f4f83d5
+  data.tar.gz: 0abe8016a1adad552574f0ed43f8e42764e847b85af68c1466ee9adebb9107c25d89cabf454704ee7301eea25e7383f597dc52c4c4e1fb416e07d9e0a5c882fd

data/.rubocop.yml

@@ -0,0 +1,33 @@
+plugins:
+  - rubocop-internal_affairs
+  - rubocop-rubyfmt
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-rubyfmt.rb
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.vscode/settings.json

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.1.0
+
+- Initial project setup
+- Add a custom lint for enforcing multiline rubocop disables
+- Add a few initial rubocop configurations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 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,85 @@
+# `rubocop-rubyfmt`
+
+[`rubyfmt`](https://github.com/fables-tales/rubyfmt)-compliant Rubocop configuration.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rubocop-rubyfmt
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rubocop-rubyfmt
+```
+
+## Usage
+
+Add the plugin to your `.rubocop.yml`:
+
+```yaml
+plugins:
+  - rubocop-rubyfmt
+```
+
+## Custom Lints
+
+### `Rubyfmt/NoEndOfLineRubocopDisables`
+
+Rubocop allows two ways to disable lints for a certain expression. You can disable them at the end of a line, like so:
+
+```ruby
+'foo' # rubocop:disable Some/Lint
+```
+
+Alternatively, you can wrap the whole expression with comments on multiple lines.
+
+```ruby
+# rubocop:disable Some/Lint
+'foo'
+# rubocop:enable Some/Lint
+```
+
+`rubyfmt` only supports comments on their own line, and thus the latter is the only one that will work.
+
+`Rubyfmt/NoEndOfLineRubocopDisables` is a custom lint that prevents usages of the end-of-line format, and it includes an autocorrect.
+
+> [!TIP]
+> If you're adopting `rubyfmt` for the first time and want to codemod your rubocop disables, you can run _only_ this cop with `bundle exec rubocop --autocorrect --only Rubyfmt/NoEndOfLineRubocopDisables`
+>
+> Note that the autocorrect for this lint is best-effort and may require manual fixups. That said, it'll only move comments and should be safe, and RuboCop will notify you of any new failures.
+
+## Disabled Lints
+
+All the disabled lints along with the rationale for disabling them is listed in [`config/default.yml`](https://github.com/reese/rubocop-rubyfmt/blob/main/config/default.yml).
+
+The goal of these lints is not to prevent _any_ violations, but to prevent lint violations _specific to `rubyfmt`_. Other lint violations may still occur after formatting: for example, a method body may get longer and cause a `Metrics/MethodLength` violation. Such violations are not covered by `rubocop-rubyfmt`.
+
+### Optional Lint Disables
+
+There are also some matters of taste (especially in RuboCop's `Style` department) that `rubyfmt` doesn't automatically enforce but which may be modified by `rubyfmt` and cause failures. For example, `rubyfmt` does not currently enforce that multiline blocks must use `do`/`end`. For those who wish to leave formatting decisions entirely up to `rubyfmt` and not worry about them, there's a "full" config that more aggressively disables such lints, which you can include in your RuboCop config:
+
+```yaml
+inherit_gem:
+  rubocop-rubyfmt:
+    - config/full.yml
+```
+
+You may also wish to instead [read the file](https://github.com/reese/rubocop-rubyfmt/blob/main/config/full.yml) and pick-and-choose which ones to disable.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/reese/rubocop-rubyfmt.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "rubocop/rake_task"
+
+require "rspec/core/rake_task"
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task(default: %i[spec rubocop])

data/config/default.yml

@@ -0,0 +1,111 @@
+# Custom cops provided by rubocop-rubyfmt
+Rubyfmt/NoEndOfLineRubocopDisables:
+  Description: 'Prevents end-of-line disable comments. `rubyfmt` only supports comments on their own line.'
+  Enabled: true
+  VersionAdded: '0.1.0'
+
+# Cops disabled because rubyfmt handles formatting.
+# rubyfmt is intended to supersede any and all other formatting styles,
+# so we disable the entire Layout department.
+Layout:
+  Enabled: false
+
+# Strings are always double-quoted
+Style/StringLiterals:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# %Q/%q/% literals are transformed into quoted strings
+Style/PercentQLiterals:
+  Enabled: false
+Style/RedundantPercentQ:
+  Enabled: false
+Style/BarePercentLiterals:
+  Enabled: false
+
+# Methods always render their `end` keyword on a new line
+Style/EmptyMethod:
+  Enabled: false
+
+# `rubyfmt` doesn't make a preference, neither should you
+Style/BlockDelimiters:
+  Enabled: false
+
+# Trailing commas are always removed
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+# These arguments will be wrapped in parens, so they won't be ambiguous
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+# Ternaries are always rendered on a single line
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+# Comments are always put on their own line, so this is redundant
+Style/CommentedKeyword:
+  Enabled: false
+
+# Character literals are converted to quoted strings
+Style/CharacterLiteral:
+  Enabled: false
+
+# Statements on the same line are always split to multiple lines
+Style/Semicolon:
+  Enabled: false
+
+# Methods with end keywords (even empty ones) are always on multiple lines
+Style/SingleLineMethods:
+  Enabled: false
+
+# `then` is never used
+Style/WhenThen:
+  Enabled: false
+Style/MultilineWhenThen:
+  Enabled: false
+Style/InPatternThen:
+  Enabled: false
+Style/MultilineIfThen:
+  Enabled: false
+
+# `do` in loops is never used
+Style/WhileUntilDo:
+  Enabled: false
+
+# Lambda parameters always use parentheses when present
+# and are removed when not
+Style/StabbyLambdaParentheses:
+  Enabled: false
+Style/EmptyLambdaParameter:
+  Enabled: false
+
+# Parens are always used for method defs with parameters
+# and always stripped without parameters
+Style/MethodDefParentheses:
+  Enabled: false
+Style/DefWithParentheses:
+  Enabled: false
+
+# Percent arrays always use `[]` delimiters
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Calls with args inside other callers will always use parens
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+# Statements on the same line as `else` will always be moved
+Lint/ElseLayout:
+  Enabled: false
+
+# `if` modifiers with multiline bodies will convert to a multiline if block
+Style/MultilineIfModifier:
+  Enabled: false

data/config/full.yml

@@ -0,0 +1,7 @@
+# `rubyfmt` has no preference on block delimiters
+Style/BlockDelimiters:
+  Enabled: false
+
+# `rubyfmt` has no preference for `lambda { }` or `-> () { }`
+Style/Lambda:
+  Enabled: false

data/lib/rubocop/cop/rubyfmt/no_end_of_line_rubocop_disables.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Rubyfmt
+
+      # `rubyfmt` always places comments at the beginning of lines, so end-of-line
+      # disables cannot be used. The autocorrect for this lint
+      #
+      # @safety
+      #   This cop should only be moving comments and thus should be safe.
+      #   However, this is largely intended as a migration mechanism when first
+      #   adopting rubyfmt, so this is best-effort and may require some manual fixups.
+      #   That said, since it's moving comments only, those fixups should be pretty much entirely
+      #   caught by Rubocop, and most of the fixups should just be moving comments such that they
+      #   appropriately wrap the offending code.
+      #
+      #
+      # rubocop:disable Lint/RedundantCopDisableDirective
+      # ```ruby
+      # # good
+      # # rubocop:disable Style/ExampleCop
+      # bad_call!
+      # # rubocop:enable Style/ExampleCop
+      #
+      # # bad
+      # bad_call! # rubocop:disable Style/ExampleCop
+      # ````
+      # rubocop:enable Lint/RedundantCopDisableDirective
+      #
+      class NoEndOfLineRubocopDisables < Base
+        extend AutoCorrector
+
+        MSG = "Use multiline rubocop directives instead of end-of-line comments."
+        DISABLE_PATTERN = /# rubocop:(disable|todo) .*/.freeze
+
+        def on_new_investigation
+          processed_source.comments.each do |comment|
+            next unless same_line_directive?(comment)
+
+            register_offense(comment)
+          end
+        end
+
+        private def same_line_directive?(comment)
+          comment.text.match?(DISABLE_PATTERN) && !comment_only_line?(comment)
+        end
+
+        private def comment_only_line?(comment)
+          processed_source.lines[comment.loc.line - 1].strip == comment.text
+        end
+
+        private def register_offense(comment)
+          add_offense(comment) do |corrector|
+            autocorrect(corrector, comment)
+          end
+        end
+
+        private def autocorrect(corrector, comment)
+          line_number = comment.source_range.line
+          line = processed_source.lines[line_number - 1]
+
+          # Extract the disable directive
+          disable_text = comment.text.match(DISABLE_PATTERN)[0]
+
+          # Find the position where the whitespace before the comment starts
+          line_without_comment = line.sub(/#.*$/, "")
+          whitespace_before_comment_length = line_without_comment.length - line_without_comment.rstrip.length
+
+          # Create a range that includes the whitespace before the comment
+          comment_with_leading_space_range = if whitespace_before_comment_length.positive?
+            range_with_leading_space = Parser::Source::Range.new(
+              comment.source_range.source_buffer,
+              comment.source_range.begin_pos - whitespace_before_comment_length,
+              comment.source_range.end_pos
+            )
+            range_with_leading_space
+          else
+            comment.source_range
+          end
+
+          # Remove the end-of-line comment with its leading whitespace
+          corrector.remove(comment_with_leading_space_range)
+
+          # Add the disable directive on the line before
+          indent = line[/\A\s*/]
+          beginning_of_line = processed_source.buffer.line_range(line_number)
+          corrector.insert_before(
+            beginning_of_line,
+            "#{indent}#{disable_text}\n"
+          )
+
+          # Add the enable directive on the line after
+          enable_text = disable_text.gsub("disable", "enable")
+          end_of_line = processed_source.buffer.line_range(line_number)
+          corrector.insert_after(
+            end_of_line,
+            "\n#{indent}#{enable_text}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rubyfmt_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rubyfmt/no_end_of_line_rubocop_disables"

data/lib/rubocop/rubyfmt/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module Rubyfmt
+    # A plugin that integrates rubocop-rubyfmt with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-rubyfmt",
+          version: VERSION,
+          homepage: "https://github.com/reese/rubocop-rubyfmt",
+          description: "Rubocop rules compatible with `rubyfmt`"
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join("../../../config/default.yml")
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/rubyfmt/version.rb

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

data/lib/rubocop/rubyfmt.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "rubyfmt/version"
+
+module RuboCop
+  module Rubyfmt
+    class Error < StandardError
+    end
+  end
+end

data/lib/rubocop-rubyfmt.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "rubocop/rubyfmt"
+require_relative "rubocop/rubyfmt/version"
+require_relative "rubocop/rubyfmt/plugin"
+
+require_relative "rubocop/cop/rubyfmt_cops"

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rubyfmt
+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: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+description: Rubocop rules for adopting `rubyfmt`
+email:
+- reese@reesew.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/default.yml
+- config/full.yml
+- lib/rubocop-rubyfmt.rb
+- lib/rubocop/cop/rubyfmt/no_end_of_line_rubocop_disables.rb
+- lib/rubocop/cop/rubyfmt_cops.rb
+- lib/rubocop/rubyfmt.rb
+- lib/rubocop/rubyfmt/plugin.rb
+- lib/rubocop/rubyfmt/version.rb
+homepage: https://github.com/reese/rubocop-rubyfmt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/reese/rubocop-rubyfmt
+  source_code_uri: https://github.com/reese/rubocop-rubyfmt
+  changelog_uri: https://github.com/reese/rubocop-rubyfmt/tree/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Rubyfmt::Plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Rubocop rules for adopting `rubyfmt`
+test_files: []