api documentation for htmllint (v0.6.0)

An unofficial html5 linter.

table of contents

  1. module htmllint
    1. function htmllint ()
    2. function htmllint.Linter (rules)
    3. function htmllint.dom_builder ()
    4. function htmllint.inline_config (newBasis)
    5. function htmllint.rule_list ()
    6. function htmllint.use (plugins)
    7. object htmllint.Linter.prototype
    8. object htmllint.apply_rules
    9. object htmllint.attr
    10. object htmllint.attr_bans
    11. object htmllint.attr_name_style
    12. object htmllint.attr_new_line
    13. object htmllint.attr_no_dup
    14. object htmllint.attr_no_unsafe_char
    15. object htmllint.attr_order
    16. object htmllint.attr_parse
    17. object htmllint.attr_quote_style
    18. object htmllint.attr_req_value
    19. object htmllint.boolean_attrs
    20. object htmllint.class
    21. object htmllint.defaultLinter
    22. object htmllint.doctype_first
    23. object htmllint.doctype_html5
    24. object htmllint.dom
    25. object htmllint.dom_builder.prototype
    26. object htmllint.fig_req_figcaption
    27. object htmllint.focusable_tabindex_style
    28. object htmllint.head_valid_content_model
    29. object htmllint.href_style
    30. object htmllint.html_valid_content_model
    31. object htmllint.id_class_no_ad
    32. object htmllint.id_no_dup
    33. object htmllint.id_style
    34. object htmllint.img_req_alt
    35. object htmllint.img_req_src
    36. object htmllint.indent_style
    37. object htmllint.index
    38. object htmllint.inline_config.prototype
    39. object htmllint.input_radio_req_name
    40. object htmllint.input_req_label
    41. object htmllint.is_labeable
    42. object htmllint.is_void_element
    43. object htmllint.label_req_for
    44. object htmllint.lang
    45. object htmllint.lang_tag
    46. object htmllint.line
    47. object htmllint.line_end_style
    48. object htmllint.line_max_len
    49. object htmllint.match_filter
    50. object htmllint.messages
    51. object htmllint.page_title
    52. object htmllint.relative_line_col
    53. object htmllint.rule_list.prototype
    54. object htmllint.rules
    55. object htmllint.shred
    56. object htmllint.spec_char_escape
    57. object htmllint.table_req_caption
    58. object htmllint.table_req_header
    59. object htmllint.tag
    60. object htmllint.tag_bans
    61. object htmllint.tag_close
    62. object htmllint.tag_name_lowercase
    63. object htmllint.tag_utils
  2. module htmllint.Linter
    1. function htmllint.Linter (rules)
    2. function htmllint.Linter.getOptions (args)
  3. module htmllint.Linter.prototype
    1. function htmllint.Linter.prototype.lint ()
    2. function htmllint.Linter.prototype.lintByLine (lines, opts)
    3. function htmllint.Linter.prototype.lintDom (dom, opts)
    4. function htmllint.Linter.prototype.resetRules (opts)
    5. function htmllint.Linter.prototype.setupInlineConfigs (dom)
    6. function htmllint.Linter.prototype.setupSubscriptions ()
    7. function htmllint.Linter.prototype.use (plugin)
  4. module htmllint.apply_rules
    1. function htmllint.apply_rules.applyRules (rules, element, opts)
  5. module htmllint.attr
    1. function htmllint.attr.lint (element, opts)
    2. object htmllint.attr.on
    3. string htmllint.attr.name
  6. module htmllint.attr_bans
    1. function htmllint.attr_bans.lint (element, opts)
    2. object htmllint.attr_bans.on
    3. string htmllint.attr_bans.name
  7. module htmllint.attr_name_style
    1. function htmllint.attr_name_style.lint (attr, opts)
    2. object htmllint.attr_name_style.on
    3. string htmllint.attr_name_style.name
  8. module htmllint.attr_new_line
    1. function htmllint.attr_new_line.lint (element, opts)
    2. object htmllint.attr_new_line.on
    3. string htmllint.attr_new_line.name
  9. module htmllint.attr_no_dup
    1. function htmllint.attr_no_dup.lint (element, opts)
    2. object htmllint.attr_no_dup.on
    3. string htmllint.attr_no_dup.name
  10. module htmllint.attr_no_unsafe_char
    1. function htmllint.attr_no_unsafe_char.lint (attr, opts)
    2. object htmllint.attr_no_unsafe_char.on
    3. string htmllint.attr_no_unsafe_char.name
  11. module htmllint.attr_order
    1. function htmllint.attr_order.lint (element, opts)
    2. object htmllint.attr_order.on
    3. string htmllint.attr_order.name
  12. module htmllint.attr_parse
    1. function htmllint.attr_parse.inputIndices (attributes, openTag, openIndex)
    2. function htmllint.attr_parse.parseHtmlAttrs (attrs)
  13. module htmllint.attr_quote_style
    1. function htmllint.attr_quote_style.lint (attr, opts)
    2. object htmllint.attr_quote_style.on
    3. string htmllint.attr_quote_style.name
  14. module htmllint.attr_req_value
    1. function htmllint.attr_req_value.lint (attr, opts)
    2. object htmllint.attr_req_value.on
    3. string htmllint.attr_req_value.name
  15. module htmllint.boolean_attrs
    1. function htmllint.boolean_attrs.isBooleanAttr (name)
  16. module htmllint.class
    1. function htmllint.class.lint (attr, opts)
    2. object htmllint.class.filter
    3. object htmllint.class.on
    4. string htmllint.class.name
  17. module htmllint.doctype_first
    1. boolean htmllint.doctype_first.passedFirst
    2. function htmllint.doctype_first.end ()
    3. function htmllint.doctype_first.lint (element, opts)
    4. object htmllint.doctype_first.on
    5. string htmllint.doctype_first.name
  18. module htmllint.doctype_html5
    1. function htmllint.doctype_html5.lint (ele, opts)
    2. object htmllint.doctype_html5.on
    3. string htmllint.doctype_html5.name
  19. module htmllint.dom
    1. function htmllint.dom.lint (dom, opts, inlineConfigs)
    2. string htmllint.dom.name
  20. module htmllint.dom_builder
    1. function htmllint.dom_builder ()
    2. function htmllint.dom_builder.super_ (callback, options, elementCB)
  21. module htmllint.dom_builder.prototype
    1. function htmllint.dom_builder.prototype._addDomElement (ele)
    2. function htmllint.dom_builder.prototype.initialize (parser)
    3. function htmllint.dom_builder.prototype.onattribute (name, value)
    4. function htmllint.dom_builder.prototype.onclosetag ()
    5. function htmllint.dom_builder.prototype.onerror (error)
    6. function htmllint.dom_builder.prototype.onopentag (name, attribs)
    7. function htmllint.dom_builder.prototype.onprocessinginstruction (name, data)
    8. function htmllint.dom_builder.prototype.start (htmlText)
  22. module htmllint.fig_req_figcaption
    1. function htmllint.fig_req_figcaption.lint (ele, opts)
    2. object htmllint.fig_req_figcaption.filter
    3. object htmllint.fig_req_figcaption.on
    4. string htmllint.fig_req_figcaption.name
  23. module htmllint.focusable_tabindex_style
    1. function htmllint.focusable_tabindex_style.end ()
    2. function htmllint.focusable_tabindex_style.getTabIndexStyle (element)
    3. function htmllint.focusable_tabindex_style.isDisabled (element)
    4. function htmllint.focusable_tabindex_style.lint (element, opts)
    5. object htmllint.focusable_tabindex_style.detectedStyle
    6. object htmllint.focusable_tabindex_style.filter
    7. object htmllint.focusable_tabindex_style.on
    8. string htmllint.focusable_tabindex_style.name
  24. module htmllint.head_valid_content_model
    1. function htmllint.head_valid_content_model.lint (elt, opts)
    2. object htmllint.head_valid_content_model.filter
    3. object htmllint.head_valid_content_model.on
    4. string htmllint.head_valid_content_model.name
  25. module htmllint.href_style
    1. function htmllint.href_style.lint (element, opts)
    2. object htmllint.href_style.filter
    3. object htmllint.href_style.on
    4. string htmllint.href_style.name
  26. module htmllint.html_valid_content_model
    1. function htmllint.html_valid_content_model.lint (elt, opts)
    2. object htmllint.html_valid_content_model.filter
    3. object htmllint.html_valid_content_model.on
    4. string htmllint.html_valid_content_model.name
  27. module htmllint.id_class_no_ad
    1. function htmllint.id_class_no_ad.lint (attr, opts)
    2. object htmllint.id_class_no_ad.filter
    3. object htmllint.id_class_no_ad.on
    4. string htmllint.id_class_no_ad.name
  28. module htmllint.id_no_dup
    1. function htmllint.id_no_dup.end ()
    2. function htmllint.id_no_dup.lint (element, opts)
    3. object htmllint.id_no_dup.on
    4. object htmllint.id_no_dup.table
    5. string htmllint.id_no_dup.name
  29. module htmllint.id_style
    1. function htmllint.id_style.lint (attr, opts)
    2. object htmllint.id_style.filter
    3. object htmllint.id_style.on
    4. string htmllint.id_style.name
  30. module htmllint.img_req_alt
    1. function htmllint.img_req_alt.lint (element, opts)
    2. object htmllint.img_req_alt.filter
    3. object htmllint.img_req_alt.on
    4. string htmllint.img_req_alt.name
  31. module htmllint.img_req_src
    1. function htmllint.img_req_src.lint (element, opts)
    2. object htmllint.img_req_src.filter
    3. object htmllint.img_req_src.on
    4. string htmllint.img_req_src.name
  32. module htmllint.indent_style
    1. function htmllint.indent_style.end ()
    2. function htmllint.indent_style.lint (line, opts)
    3. object htmllint.indent_style.on
    4. string htmllint.indent_style.name
  33. module htmllint.index
    1. function htmllint.index.applyRules (rules, element, opts)
    2. function htmllint.index.checkLangTag (l)
    3. function htmllint.index.getFormatTest (name)
    4. function htmllint.index.getLineColFunc (htmlText, lineCol)
    5. function htmllint.index.hasNonEmptyAttr (tag, attr, allowNull)
    6. function htmllint.index.inputIndices (attributes, openTag, openIndex)
    7. function htmllint.index.isBooleanAttr (name)
    8. function htmllint.index.isLabeable (ele)
    9. function htmllint.index.isSelfClosing (element)
    10. function htmllint.index.isVoidElement (tagName)
    11. function htmllint.index.matchFilter (data, rule)
    12. function htmllint.index.parseHtmlAttrs (attrs)
    13. function htmllint.index.shred (html)
  34. module htmllint.inline_config
    1. function htmllint.inline_config (newBasis)
  35. module htmllint.inline_config.prototype
    1. function htmllint.inline_config.prototype.addConfig (config)
    2. function htmllint.inline_config.prototype.clear ()
    3. function htmllint.inline_config.prototype.feedComment (element)
    4. function htmllint.inline_config.prototype.getOptsAtIndex (newIndex)
    5. function htmllint.inline_config.prototype.reset (newBasis)
  36. module htmllint.input_radio_req_name
    1. function htmllint.input_radio_req_name.lint (element, opts)
    2. object htmllint.input_radio_req_name.filter
    3. object htmllint.input_radio_req_name.inputsInfo
    4. object htmllint.input_radio_req_name.labels
    5. object htmllint.input_radio_req_name.on
    6. string htmllint.input_radio_req_name.name
  37. module htmllint.input_req_label
    1. function htmllint.input_req_label.end ()
    2. function htmllint.input_req_label.lint (element, opts)
    3. object htmllint.input_req_label.filter
    4. object htmllint.input_req_label.inputsInfo
    5. object htmllint.input_req_label.labels
    6. object htmllint.input_req_label.on
    7. string htmllint.input_req_label.name
  38. module htmllint.is_labeable
    1. function htmllint.is_labeable.isLabeable (ele)
  39. module htmllint.is_void_element
    1. function htmllint.is_void_element.isVoidElement (tagName)
  40. module htmllint.label_req_for
    1. function htmllint.label_req_for.buildIdMap (originElement)
    2. function htmllint.label_req_for.end ()
    3. function htmllint.label_req_for.hasValidChild (ele)
    4. function htmllint.label_req_for.lint (ele, opts)
    5. object htmllint.label_req_for.filter
    6. object htmllint.label_req_for.idmap
    7. object htmllint.label_req_for.on
    8. string htmllint.label_req_for.name
  41. module htmllint.lang
    1. function htmllint.lang.lint (element, opts)
    2. object htmllint.lang.filter
    3. object htmllint.lang.on
    4. string htmllint.lang.name
  42. module htmllint.lang_tag
    1. function htmllint.lang_tag.checkLangTag (l)
  43. module htmllint.line
    1. function htmllint.line.lint (lines, opts, inlineConfigs)
    2. string htmllint.line.name
  44. module htmllint.line_end_style
    1. function htmllint.line_end_style.lint (line, opts)
    2. object htmllint.line_end_style.on
    3. string htmllint.line_end_style.name
  45. module htmllint.line_max_len
    1. function htmllint.line_max_len.lint (line, opts)
    2. object htmllint.line_max_len.on
    3. string htmllint.line_max_len.name
  46. module htmllint.match_filter
    1. function htmllint.match_filter.matchFilter (data, rule)
  47. module htmllint.messages
    1. function htmllint.messages.renderIssue (issue)
    2. function htmllint.messages.renderMsg (code, data)
    3. object htmllint.messages.errors
  48. module htmllint.page_title
    1. function htmllint.page_title.lint (elt, opts)
    2. object htmllint.page_title.filter
    3. object htmllint.page_title.on
    4. string htmllint.page_title.name
  49. module htmllint.relative_line_col
    1. function htmllint.relative_line_col.getLineColFunc (htmlText, lineCol)
  50. module htmllint.rule_list
    1. function htmllint.rule_list ()
    2. function htmllint.rule_list.fromRuleMap (ruleMap)
  51. module htmllint.rule_list.prototype
    1. function htmllint.rule_list.prototype.addRule (rule)
    2. function htmllint.rule_list.prototype.forEach (func)
    3. function htmllint.rule_list.prototype.getRule (ruleName)
    4. function htmllint.rule_list.prototype.getSubscribers (subName)
    5. function htmllint.rule_list.prototype.removeRule (ruleName)
    6. function htmllint.rule_list.prototype.subscribeRule (rule)
    7. function htmllint.rule_list.prototype.unsubscribeRule (rule)
  52. module htmllint.shred
    1. function htmllint.shred (html)
  53. module htmllint.spec_char_escape
    1. function htmllint.spec_char_escape.lint (element, opts)
    2. object htmllint.spec_char_escape.filter
    3. object htmllint.spec_char_escape.on
    4. string htmllint.spec_char_escape.name
  54. module htmllint.table_req_caption
    1. function htmllint.table_req_caption.lint (ele, opts)
    2. object htmllint.table_req_caption.filter
    3. object htmllint.table_req_caption.on
    4. string htmllint.table_req_caption.name
  55. module htmllint.table_req_header
    1. function htmllint.table_req_header.lint (ele, opts)
    2. object htmllint.table_req_header.filter
    3. object htmllint.table_req_header.on
    4. string htmllint.table_req_header.name
  56. module htmllint.tag
    1. function htmllint.tag.lint (element, opts)
    2. object htmllint.tag.filter
    3. object htmllint.tag.on
    4. string htmllint.tag.name
  57. module htmllint.tag_bans
    1. function htmllint.tag_bans.lint (element, opts)
    2. object htmllint.tag_bans.filter
    3. object htmllint.tag_bans.on
    4. string htmllint.tag_bans.name
  58. module htmllint.tag_close
    1. function htmllint.tag_close.lint (element, opts)
    2. object htmllint.tag_close.on
    3. string htmllint.tag_close.name
  59. module htmllint.tag_name_lowercase
    1. function htmllint.tag_name_lowercase.lint (element, opts)
    2. object htmllint.tag_name_lowercase.on
    3. string htmllint.tag_name_lowercase.name
  60. module htmllint.tag_utils
    1. function htmllint.tag_utils.hasNonEmptyAttr (tag, attr, allowNull)
    2. function htmllint.tag_utils.isSelfClosing (element)

module htmllint

function htmllint ()

function htmllint.Linter (rules)

function htmllint.dom_builder ()

function htmllint.inline_config (newBasis)

function htmllint.rule_list ()

function htmllint.use (plugins)

module htmllint.Linter

function htmllint.Linter (rules)

function htmllint.Linter.getOptions (args)

module htmllint.Linter.prototype

function htmllint.Linter.prototype.lint ()

function htmllint.Linter.prototype.lintByLine (lines, opts)

function htmllint.Linter.prototype.lintDom (dom, opts)

function htmllint.Linter.prototype.resetRules (opts)

function htmllint.Linter.prototype.setupInlineConfigs (dom)

function htmllint.Linter.prototype.setupSubscriptions ()

function htmllint.Linter.prototype.use (plugin)

module htmllint.apply_rules

function htmllint.apply_rules.applyRules (rules, element, opts)

module htmllint.attr

function htmllint.attr.lint (element, opts)

module htmllint.attr_bans

function htmllint.attr_bans.lint (element, opts)

module htmllint.attr_name_style

function htmllint.attr_name_style.lint (attr, opts)

module htmllint.attr_new_line

function htmllint.attr_new_line.lint (element, opts)

module htmllint.attr_no_dup

function htmllint.attr_no_dup.lint (element, opts)

module htmllint.attr_no_unsafe_char

function htmllint.attr_no_unsafe_char.lint (attr, opts)

module htmllint.attr_order

function htmllint.attr_order.lint (element, opts)

module htmllint.attr_parse

function htmllint.attr_parse.inputIndices (attributes, openTag, openIndex)

function htmllint.attr_parse.parseHtmlAttrs (attrs)

module htmllint.attr_quote_style

function htmllint.attr_quote_style.lint (attr, opts)

module htmllint.attr_req_value

function htmllint.attr_req_value.lint (attr, opts)

module htmllint.boolean_attrs

function htmllint.boolean_attrs.isBooleanAttr (name)

module htmllint.class

function htmllint.class.lint (attr, opts)

module htmllint.doctype_first

function htmllint.doctype_first.end ()

function htmllint.doctype_first.lint (element, opts)

module htmllint.doctype_html5

function htmllint.doctype_html5.lint (ele, opts)

module htmllint.dom

function htmllint.dom.lint (dom, opts, inlineConfigs)

module htmllint.dom_builder

function htmllint.dom_builder ()

function htmllint.dom_builder.super_ (callback, options, elementCB)

module htmllint.dom_builder.prototype

function htmllint.dom_builder.prototype._addDomElement (ele)

function htmllint.dom_builder.prototype.initialize (parser)

function htmllint.dom_builder.prototype.onattribute (name, value)

function htmllint.dom_builder.prototype.onclosetag ()

function htmllint.dom_builder.prototype.onerror (error)

function htmllint.dom_builder.prototype.onopentag (name, attribs)

function htmllint.dom_builder.prototype.onprocessinginstruction (name, data)

function htmllint.dom_builder.prototype.start (htmlText)

module htmllint.fig_req_figcaption

function htmllint.fig_req_figcaption.lint (ele, opts)

module htmllint.focusable_tabindex_style

function htmllint.focusable_tabindex_style.end ()

function htmllint.focusable_tabindex_style.getTabIndexStyle (element)

function htmllint.focusable_tabindex_style.isDisabled (element)

function htmllint.focusable_tabindex_style.lint (element, opts)

module htmllint.head_valid_content_model

function htmllint.head_valid_content_model.lint (elt, opts)

module htmllint.href_style

function htmllint.href_style.lint (element, opts)

module htmllint.html_valid_content_model

function htmllint.html_valid_content_model.lint (elt, opts)

module htmllint.id_class_no_ad

function htmllint.id_class_no_ad.lint (attr, opts)

module htmllint.id_no_dup

function htmllint.id_no_dup.end ()

function htmllint.id_no_dup.lint (element, opts)

module htmllint.id_style

function htmllint.id_style.lint (attr, opts)

module htmllint.img_req_alt

function htmllint.img_req_alt.lint (element, opts)

module htmllint.img_req_src

function htmllint.img_req_src.lint (element, opts)

module htmllint.indent_style

function htmllint.indent_style.end ()

function htmllint.indent_style.lint (line, opts)

module htmllint.index

function htmllint.index.applyRules (rules, element, opts)

function htmllint.index.checkLangTag (l)

function htmllint.index.getFormatTest (name)

function htmllint.index.getLineColFunc (htmlText, lineCol)

function htmllint.index.hasNonEmptyAttr (tag, attr, allowNull)

function htmllint.index.inputIndices (attributes, openTag, openIndex)

function htmllint.index.isBooleanAttr (name)

function htmllint.index.isLabeable (ele)

function htmllint.index.isSelfClosing (element)

function htmllint.index.isVoidElement (tagName)

function htmllint.index.matchFilter (data, rule)

function htmllint.index.parseHtmlAttrs (attrs)

function htmllint.index.shred (html)

module htmllint.inline_config

function htmllint.inline_config (newBasis)

module htmllint.inline_config.prototype

function htmllint.inline_config.prototype.addConfig (config)

function htmllint.inline_config.prototype.clear ()

function htmllint.inline_config.prototype.feedComment (element)

function htmllint.inline_config.prototype.getOptsAtIndex (newIndex)

function htmllint.inline_config.prototype.reset (newBasis)

module htmllint.input_radio_req_name

function htmllint.input_radio_req_name.lint (element, opts)

module htmllint.input_req_label

function htmllint.input_req_label.end ()

function htmllint.input_req_label.lint (element, opts)

module htmllint.is_labeable

function htmllint.is_labeable.isLabeable (ele)

module htmllint.is_void_element

function htmllint.is_void_element.isVoidElement (tagName)

module htmllint.label_req_for

function htmllint.label_req_for.buildIdMap (originElement)

function htmllint.label_req_for.end ()

function htmllint.label_req_for.hasValidChild (ele)

function htmllint.label_req_for.lint (ele, opts)

module htmllint.lang

function htmllint.lang.lint (element, opts)

module htmllint.lang_tag

function htmllint.lang_tag.checkLangTag (l)

module htmllint.line

function htmllint.line.lint (lines, opts, inlineConfigs)

module htmllint.line_end_style

function htmllint.line_end_style.lint (line, opts)

module htmllint.line_max_len

function htmllint.line_max_len.lint (line, opts)

module htmllint.match_filter

function htmllint.match_filter.matchFilter (data, rule)

module htmllint.messages

function htmllint.messages.renderIssue (issue)

function htmllint.messages.renderMsg (code, data)

module htmllint.page_title

function htmllint.page_title.lint (elt, opts)

module htmllint.relative_line_col

function htmllint.relative_line_col.getLineColFunc (htmlText, lineCol)

module htmllint.rule_list

function htmllint.rule_list ()

function htmllint.rule_list.fromRuleMap (ruleMap)

module htmllint.rule_list.prototype

function htmllint.rule_list.prototype.addRule (rule)

function htmllint.rule_list.prototype.forEach (func)

function htmllint.rule_list.prototype.getRule (ruleName)

function htmllint.rule_list.prototype.getSubscribers (subName)

function htmllint.rule_list.prototype.removeRule (ruleName)

function htmllint.rule_list.prototype.subscribeRule (rule)

function htmllint.rule_list.prototype.unsubscribeRule (rule)

module htmllint.shred

function htmllint.shred (html)

module htmllint.spec_char_escape

function htmllint.spec_char_escape.lint (element, opts)

module htmllint.table_req_caption

function htmllint.table_req_caption.lint (ele, opts)

module htmllint.table_req_header

function htmllint.table_req_header.lint (ele, opts)

module htmllint.tag

function htmllint.tag.lint (element, opts)

module htmllint.tag_bans

function htmllint.tag_bans.lint (element, opts)

module htmllint.tag_close

function htmllint.tag_close.lint (element, opts)

module htmllint.tag_name_lowercase

function htmllint.tag_name_lowercase.lint (element, opts)

module htmllint.tag_utils

function htmllint.tag_utils.hasNonEmptyAttr (tag, attr, allowNull)

function htmllint.tag_utils.isSelfClosing (element)

[ this document was created with utility2 ]