Sha256: 41f85f8b73ce0c74ee09a88ee1161a8fbfbfba5e0039d397baf71931a7f38833

Contents?: true

Size: 1.59 KB

Versions: 148

Compression:

Stored size: 1.59 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Layout
      # Ensures that each key in a multi-line hash
      # starts on a separate line.
      #
      # @example
      #
      #   # bad
      #   {
      #     a: 1, b: 2,
      #     c: 3
      #   }
      #
      #   # good
      #   {
      #     a: 1,
      #     b: 2,
      #     c: 3
      #   }
      #
      #   # good
      #   {
      #     a: 1,
      #     b: {
      #       c: 3,
      #     }
      #   }
      #
      # @example AllowMultilineFinalElement: false (default)
      #
      #   # bad
      #   { a: 1, b: {
      #     c: 3,
      #   }}
      #
      # @example AllowMultilineFinalElement: true
      #
      #   # good
      #   { a: 1, b: {
      #     c: 3,
      #   }}
      #
      class MultilineHashKeyLineBreaks < Base
        include MultilineElementLineBreaks
        extend AutoCorrector

        MSG = 'Each key in a multi-line hash must start on a separate line.'

        def on_hash(node)
          # This cop only deals with hashes wrapped by a set of curly
          # braces like {foo: 1}. That is, not a kwargs hashes.
          # Style/MultilineMethodArgumentLineBreaks handles those.
          return unless starts_with_curly_brace?(node)
          return unless node.loc.begin

          check_line_breaks(node, node.children, ignore_last: ignore_last_element?)
        end

        private

        def starts_with_curly_brace?(node)
          node.loc.begin
        end

        def ignore_last_element?
          !!cop_config['AllowMultilineFinalElement']
        end
      end
    end
  end
end

Version data entries

148 entries across 147 versions & 15 rubygems

Version Path
rubocop-1.70.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.69.2 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.69.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.69.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.68.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.67.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.66.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.66.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.65.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.65.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-1.64.1/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.64.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.63.4 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.63.3 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.63.2 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
harbr-2.8.1 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.63.1 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb
rubocop-1.63.0 lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb