Sha256: cb975e5cd103001977deebe53e87471c6bc875e4ef997c123de8b486f6d75d44

Contents?: true

Size: 1.51 KB

Versions: 6775

Compression:

Stored size: 1.51 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Layout
      # This cop checks for indentation of the first non-blank non-comment
      # line in a file.
      #
      # @example
      #   # bad
      #      class A
      #        def foo; end
      #      end
      #
      #   # good
      #   class A
      #     def foo; end
      #   end
      #
      class InitialIndentation < Cop
        include RangeHelp

        MSG = 'Indentation of first line in file detected.'.freeze

        def investigate(_processed_source)
          space_before(first_token) do |space|
            add_offense(space, location: first_token.pos)
          end
        end

        def autocorrect(range)
          ->(corrector) { corrector.remove(range) }
        end

        private

        def first_token
          processed_source.find_token { |t| !t.text.start_with?('#') }
        end

        def space_before(token)
          return unless token
          return if token.column.zero?

          space_range =
            range_with_surrounding_space(range: token.pos,
                                         side: :left,
                                         newlines: false)
          # If the file starts with a byte order mark (BOM), the column can be
          # non-zero, but then we find out here if there's no space to the left
          # of the first token.
          return if space_range == token.pos

          yield range_between(space_range.begin_pos, token.begin_pos)
        end
      end
    end
  end
end

Version data entries

6,775 entries across 6,769 versions & 24 rubygems

Version Path
rubocop-0.67.1 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.67.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.66.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.65.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.64.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.63.1 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.63.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.62.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.61.1 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.61.0 lib/rubocop/cop/layout/initial_indentation.rb
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/rubocop-0.60.0/lib/rubocop/cop/layout/initial_indentation.rb
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/rubocop-0.60.0/lib/rubocop/cop/layout/initial_indentation.rb
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/rubocop-0.60.0/lib/rubocop/cop/layout/initial_indentation.rb
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/rubocop-0.60.0/lib/rubocop/cop/layout/initial_indentation.rb
rubocop-0.60.0 lib/rubocop/cop/layout/initial_indentation.rb