Class: HamlLint::Lint

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Creates a new lint.

Parameters:

  • linter (HamlLint::Linter)
  • filename (String)
  • line (Fixnum)
  • message (String)
  • severity (Symbol) (defaults to: :warning)

28
29
30
31
32
33
34
# File 'lib/haml_lint/lint.rb', line 28

def initialize(linter, filename, line, message, severity = :warning)
  @linter   = linter
  @filename = filename
  @line     = line || 0
  @message  = message
  @severity = Severity.new(severity)
end

Instance Attribute Details

#filenameString (readonly)

Returns file path to which the lint applies.

Returns:

  • (String)

    file path to which the lint applies


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

def filename
  @filename
end

#lineString (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/haml_lint/lint.rb', line 10

def line
  @line
end

#linterSlimLint::Linter (readonly)

Returns linter that reported the lint.

Returns:

  • (SlimLint::Linter)

    linter that reported the lint


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

def linter
  @linter
end

#messageString (readonly)

Returns error/warning message to display to user.

Returns:

  • (String)

    error/warning message to display to user


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

def message
  @message
end

#severitySymbol (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/haml_lint/lint.rb', line 19

def severity
  @severity
end

Instance Method Details

#error?Boolean

Return whether this lint has a severity of error.

Returns:

  • (Boolean)

39
40
41
# File 'lib/haml_lint/lint.rb', line 39

def error?
  @severity.error?
end