Sha256: ce6adb1ae65d54b1630e75e4ff45a381c4e7589a76ccb86cd74bcb88724bf63f

Contents?: true

Size: 1.39 KB

Versions: 38

Compression:

Stored size: 1.39 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 < Base
        include RangeHelp
        extend AutoCorrector

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

        def on_new_investigation
          space_before(first_token) do |space|
            add_offense(first_token.pos) do |corrector|
              corrector.remove(space)
            end
          end
        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

38 entries across 38 versions & 6 rubygems

Version Path
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/layout/initial_indentation.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.29.1 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.29.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.28.2 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.28.1 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.28.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.27.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.26.1 lib/rubocop/cop/layout/initial_indentation.rb
op_connect-0.1.2 vendor/bundle/ruby/3.1.0/gems/rubocop-1.26.0/lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.26.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.25.1 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.25.0 lib/rubocop/cop/layout/initial_indentation.rb
phillipug-foodie-0.1.0 .vendor/ruby/3.0.0/gems/rubocop-1.24.0/lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.24.1 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.24.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.23.0 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.22.3 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.22.2 lib/rubocop/cop/layout/initial_indentation.rb
rubocop-1.22.1 lib/rubocop/cop/layout/initial_indentation.rb