Class: SlimLint::Lint

Inherits:
Object
  • Object
show all
Defined in:
lib/slim_lint/lint.rb

Overview

Contains information about a problem or issue with a Slim document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(linter, filename, line, message, severity = :warning, correction: nil) ⇒ Lint

Creates a new lint.

Parameters:

  • linter (SlimLint::Linter)
  • filename (String)
  • line (Fixnum)
  • message (String)
  • severity (Symbol) (defaults to: :warning)
  • correction (Proc, nil) (defaults to: nil) —

    maps a line of source to its corrected version



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/slim_lint/lint.rb', line 38

def initialize(linter, filename, line, message, severity = :warning, # rubocop:disable Metrics/ParameterLists
               correction: nil)
  @linter     = linter
  @filename   = filename
  @line       = line || 0
  @message    = message
  @severity   = severity
  @correction = correction
  @corrected  = false
end

Instance Attribute Details

#corrected ⇒ Boolean

Returns whether this lint's correction has been applied.

Returns:

  • (Boolean) —

    whether this lint's correction has been applied



28
29
30
 
# File 'lib/slim_lint/lint.rb', line 28

def corrected
  @corrected
end

#correction ⇒ Proc? (readonly)

Returns maps a line of source to its corrected version (nil to remove the line, or a string with embedded newlines to replace it with multiple lines), or nil if this lint has no known automatic correction.

Returns:

  • (Proc, nil) —

    maps a line of source to its corrected version (nil to remove the line, or a string with embedded newlines to replace it with multiple lines), or nil if this lint has no known automatic correction



25
26
27
 
# File 'lib/slim_lint/lint.rb', line 25

def correction
  @correction
end

#filename ⇒ String (readonly)

Returns file path to which the lint applies.

Returns:

  • (String) —

    file path to which the lint applies



7
8
9
 
# File 'lib/slim_lint/lint.rb', line 7

def filename
  @filename
end

#line ⇒ String (readonly)

Returns line number of the file the lint corresponds to.

Returns:

  • (String) —

    line number of the file the lint corresponds to



10
11
12
 
# File 'lib/slim_lint/lint.rb', line 10

def line
  @line
end

#linter ⇒ SlimLint::Linter (readonly)

Returns linter that reported the lint.

Returns:



13
14
15
 
# File 'lib/slim_lint/lint.rb', line 13

def linter
  @linter
end

#message ⇒ String (readonly)

Returns error/warning message to display to user.

Returns:

  • (String) —

    error/warning message to display to user



16
17
18
 
# File 'lib/slim_lint/lint.rb', line 16

def message
  @message
end

#severity ⇒ Symbol (readonly)

Returns whether this lint is a warning or an error.

Returns:

  • (Symbol) —

    whether this lint is a warning or an error



19
20
21
 
# File 'lib/slim_lint/lint.rb', line 19

def severity
  @severity
end

Instance Method Details

#correctable? ⇒ Boolean

Return whether this lint has a known automatic correction.

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/slim_lint/lint.rb', line 59

def correctable?
  !@correction.nil?
end

#corrected? ⇒ Boolean

Return whether this lint's correction has been applied.

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/slim_lint/lint.rb', line 66

def corrected?
  @corrected
end

#error? ⇒ Boolean

Return whether this lint has a severity of error.

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/slim_lint/lint.rb', line 52

def error?
  @severity == :error
end