Sha256: 1cd601eac38d83d6f60c630d45f2e8a36aea8d2563292d9c28c122dd4e094886

Contents?: true

Size: 1.67 KB

Versions: 17

Compression:

Stored size: 1.67 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 AllowMultilineFinalElement: false (default)
      #
      #     # bad
      #     { a: 1,
      #       b: 2}
      #
      #     # bad
      #     { a: 1, b: {
      #       c: 3
      #     }}
      #
      #     # good
      #     {
      #       a: 1,
      #       b: 2 }
      #
      #     # good
      #     {
      #       a: 1, b: {
      #       c: 3
      #     }}
      #
      # @example AllowMultilineFinalElement: true
      #
      #     # bad
      #     { a: 1,
      #       b: 2}
      #
      #     # bad
      #     { a: 1,
      #       b: {
      #       c: 3
      #     }}
      #
      #     # good
      #     { a: 1, b: {
      #       c: 3
      #     }}
      #
      #     # good
      #     {
      #       a: 1,
      #       b: 2 }
      #
      #     # 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

17 entries across 17 versions & 3 rubygems

Version Path
rubocop-1.50.1 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.50.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.49.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
call_your_name-0.1.0 vendor/bundle/ruby/3.1.0/gems/rubocop-1.48.1/lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.48.1 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.48.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.47.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
zilla-0.2.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.46.0/lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.46.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.45.1 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.45.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.44.1 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.44.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.43.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.42.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.41.1 lib/rubocop/cop/layout/first_hash_element_line_break.rb
rubocop-1.41.0 lib/rubocop/cop/layout/first_hash_element_line_break.rb