Class: ERBLint::Linter

Inherits:
Object
  • Object
show all
Defined in:
lib/erb_lint/linter.rb

Overview

Defines common functionality available to all linters.

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_loader, config) ⇒ Linter

Must be implemented by the concrete inheriting class.

Raises:

  • (ArgumentError) 


36
37
38
39
40
41
42
 
# File 'lib/erb_lint/linter.rb', line 36

def initialize(file_loader, config)
  @file_loader = file_loader
  @config = config
  raise ArgumentError, "expect `config` to be #{self.class.config_schema} instance, "\
    "not #{config.class}" unless config.is_a?(self.class.config_schema)
  @offenses = []
end

Class Attribute Details

.config_schema ⇒ Object

Returns the value of attribute config_schema.



8
9
10
 
# File 'lib/erb_lint/linter.rb', line 8

def config_schema
  @config_schema
end

.simple_name ⇒ Object

Returns the value of attribute simple_name.



7
8
9
 
# File 'lib/erb_lint/linter.rb', line 7

def simple_name
  @simple_name
end

Instance Attribute Details

#offenses ⇒ Object (readonly)

Returns the value of attribute offenses.



33
34
35
 
# File 'lib/erb_lint/linter.rb', line 33

def offenses
  @offenses
end

Class Method Details

.inherited(linter) ⇒ Object

When defining a Linter class, define its simple name as well. This assumes that the module hierarchy of every linter starts with ‘ERBLint::Linters::`, and removes this part of the class name.

‘ERBLint::Linters::Foo.simple_name` #=> “Foo” `ERBLint::Linters::Compass::Bar.simple_name` #=> “Compass::Bar”



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/erb_lint/linter.rb', line 16

def inherited(linter)
  super
  linter.simple_name = if linter.name.start_with?("ERBLint::Linters::")
    name_parts = linter.name.split("::")
    name_parts[2..-1].join("::")
  else
    linter.name
  end

  linter.config_schema = LinterConfig
end

.support_autocorrect? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/erb_lint/linter.rb', line 28

def support_autocorrect?
  method_defined?(:autocorrect)
end

Instance Method Details

#add_offense(source_range, message, context = nil, severity = nil) ⇒ Object 



56
57
58
 
# File 'lib/erb_lint/linter.rb', line 56

def add_offense(source_range, message, context = nil, severity = nil)
  @offenses << Offense.new(self, source_range, message, context, severity)
end

#clear_offenses ⇒ Object 



60
61
62
 
# File 'lib/erb_lint/linter.rb', line 60

def clear_offenses
  @offenses = []
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/erb_lint/linter.rb', line 44

def enabled?
  @config.enabled?
end

#excludes_file?(filename) ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/erb_lint/linter.rb', line 48

def excludes_file?(filename)
  @config.excludes_file?(filename)
end

#run(_processed_source) ⇒ Object

Raises:

  • (NotImplementedError) 


52
53
54
 
# File 'lib/erb_lint/linter.rb', line 52

def run(_processed_source)
  raise NotImplementedError, "must implement ##{__method__}"
end