Class: RuboCop::Cop::Layout::TrailingWhitespace

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
Heredoc, RangeHelp
Defined in:
lib/rubocop/cop/layout/trailing_whitespace.rb

Overview

This cop looks for trailing whitespace in the source code.

Examples:

# The line in this example contains spaces after the 0.
# bad
x = 0

# The line in this example ends directly after the 0.
# good
x = 0

AllowInHeredoc: false (default)

# The line in this example contains spaces after the 0.
# bad
code = <<~RUBY
  x = 0
RUBY

# ok
code = <<~RUBY
  x = 0 #{}
RUBY

# good
trailing_whitespace = ' '
code = <<~RUBY
  x = 0#{trailing_whitespace}
RUBY

AllowInHeredoc: true

# The line in this example contains spaces after the 0.
# good
code = <<~RUBY
  x = 0
RUBY

Constant Summary collapse

MSG =
'Trailing whitespace detected.'

Constants included from Heredoc

Heredoc::OPENING_DELIMITER

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from Heredoc

#on_str

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_heredoc(_node) ⇒ Object


58
# File 'lib/rubocop/cop/layout/trailing_whitespace.rb', line 58

def on_heredoc(_node); end

#on_new_investigationObject


49
50
51
52
53
54
55
56
# File 'lib/rubocop/cop/layout/trailing_whitespace.rb', line 49

def on_new_investigation
  @heredocs = extract_heredocs(processed_source.ast)
  processed_source.lines.each_with_index do |line, index|
    next unless line.end_with?(' ', "\t")

    process_line(line, index + 1)
  end
end