Class: RuboCop::Cop::Layout::LeadingBlankLines

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/layout/leading_blank_lines.rb

Overview

This cop checks for unnecessary leading blank lines at the beginning of a file.

Examples:


# bad
# (start of file)

class Foo
end

# bad
# (start of file)

# a comment

# good
# (start of file)
class Foo
end

# good
# (start of file)
# a comment

Constant Summary collapse

MSG = 
'Unnecessary blank line at the beginning of the source.'.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/layout/leading_blank_lines.rb', line 41

def autocorrect(node)
  range = Parser::Source::Range.new(processed_source.buffer,
                                    0,
                                    node.begin_pos)

  lambda do |corrector|
    corrector.remove(range)
  end
end

#investigate(processed_source) ⇒ Object 



33
34
35
36
37
38
39
 
# File 'lib/rubocop/cop/layout/leading_blank_lines.rb', line 33

def investigate(processed_source)
  token = processed_source.tokens[0]
  return unless token && token.line > 1

  add_offense(processed_source.tokens[0],
              location: processed_source.tokens[0].pos)
end