Sha256: 141d9ab485a6fbd008d0ab7d9687b6c54f62b30244638881694249fdee277670

Contents?: true

Size: 1.46 KB

Versions: 148

Compression:

Stored size: 1.46 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Layout
      # Checks for a line break before the first element in a
      # multi-line hash.
      #
      # @example
      #
      #     # bad
      #     { a: 1,
      #       b: 2}
      #
      #     # good
      #     {
      #       a: 1,
      #       b: 2 }
      #
      #     # good
      #     {
      #       a: 1, b: {
      #       c: 3
      #     }}
      #
      # @example AllowMultilineFinalElement: false (default)
      #
      #     # bad
      #     { a: 1, b: {
      #       c: 3
      #     }}
      #
      # @example AllowMultilineFinalElement: true
      #
      #     # bad
      #     { a: 1,
      #       b: {
      #       c: 3
      #     }}
      #
      #     # good
      #     { a: 1, b: {
      #       c: 3
      #     }}
      #
      class FirstHashElementLineBreak < Base
        include FirstElementLineBreak
        extend AutoCorrector

        MSG = 'Add a line break before the first element of a multi-line hash.'

        def on_hash(node)
          # node.loc.begin tells us whether the hash opens with a {
          # If it doesn't, Style/FirstMethodArgumentLineBreak will handle it
          return unless node.loc.begin

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

        private

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

Version data entries

148 entries across 147 versions & 15 rubygems

Version Path
bison-0.1.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.62.1/lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.62.1 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.62.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.61.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
mlh-rubocop-config-1.0.3 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.2/lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.60.2 lib/rubocop/cop/layout/first_hash_element_line_break.rb
study_line-0.2.7 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
study_line-0.2.6 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
study_line-0.2.5 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
study_line-0.2.4 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
study_line-0.2.3 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
study_line-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.60.1 lib/rubocop/cop/layout/first_hash_element_line_break.rb
study_line-0.2.1 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
study_line-0.2.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.60.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
harbr-0.2.10 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/layout/first_hash_element_line_break.rb
harbr-0.2.9 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/layout/first_hash_element_line_break.rb
harbr-0.2.8 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/layout/first_hash_element_line_break.rb
harbr-0.2.7 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/layout/first_hash_element_line_break.rb