Class: HtmlCheck

Inherits:
HTMLProofer::Check show all
Defined in:
lib/html-proofer/check/html.rb

Constant Summary collapse

SCRIPT_EMBEDS_MSG =

tags embedded in scripts are used in templating languages: git.io/vOovv

/Element script embeds close tag/.freeze
INVALID_TAG_MSG =
/Tag ([\w\-:]+) invalid/.freeze
INVALID_PREFIX =
/Namespace prefix/.freeze
PARSE_ENTITY_REF =
/htmlParseEntityRef: no name/.freeze
DOCTYPE_MSG =
/The doctype must be the first token in the document/.freeze

Instance Attribute Summary

Attributes inherited from HTMLProofer::Check

#element, #external_urls, #html, #issues, #node, #options, #path, #src

Instance Method Summary collapse

Methods inherited from HTMLProofer::Check

#add_issue, #add_path_for_url, #add_to_external_urls, #blank?, #create_element, #initialize, subchecks

Constructor Details

This class inherits a constructor from HTMLProofer::Check

Instance Method Details

#report?(message) ⇒ Boolean

Returns:

  • (Boolean)


17
18
19
20
21
22
23
24
25
26
27
28
29
30
# File 'lib/html-proofer/check/html.rb', line 17

def report?(message)
  case message
  when SCRIPT_EMBEDS_MSG
    options[:validation][:report_script_embeds]
  when INVALID_TAG_MSG, INVALID_PREFIX
    options[:validation][:report_invalid_tags]
  when PARSE_ENTITY_REF
    options[:validation][:report_missing_names]
  when DOCTYPE_MSG
    options[:validation][:report_missing_doctype]
  else
    true
  end
end

#runObject



11
12
13
14
15
# File 'lib/html-proofer/check/html.rb', line 11

def run
  @html.errors.each do |error|
    add_issue(error.message, line: error.line) if report?(error.message)
  end
end