htmllint/lib/rules/tag-close.js

An unofficial html5 linter.

var knife = require('../knife'),
    Issue = require('../issue'),
    proc = require('../process_option');

module.exports = {
    name: 'tag-close',
    on: ['tag'],
    options: [{
        desc: [
'If set, tags must be closed. Because htmlparser2 does not match tags',
'case-insensitively, tags whose closing tag has a different case than the',
'opening tag may be detected by this option rather than `tag-name-match`.'
].join('\n'),
        process: proc.bool
    }, {
        name: 'tag-name-match',
        desc: 'If set, tag names must match (including case).',
        process: proc.bool
    }, {
        name: 'tag-self-close',
        desc: [
'* "always": Void elements must be self-closed with `/` (html4 style).',
'* "never": Void elements must not be self-closed with `/` (html5 style).',
'* `false`: No restriction.',
'',
'The void elements are `area`, `base`, `br`, `col`, `embed`, `hr`, `img`,',
'`input`, `keygen`, `link`, `menuitem`, `meta`, `param`, `source`, `track`,',
'and `wbr`.'
].join('\n'),
        process: proc.options(['always', 'never'])
    }]
};

module.exports.lint = function (element, opts) {
    // If the tag did not close itself
    if (!element.close ||
        element.name.toLowerCase() !== element.close.toLowerCase()) {
        if (knife.isVoidElement(element.name)) {
            var selfClose = knife.isSelfClosing(element);
            var style = opts['tag-self-close'];
            if ((style == 'always' && !selfClose) ||
                (style == 'never' && selfClose)) {
                return new Issue('E018', element.openLineCol,
                                 {expect: style});
            }
        } else {
            if (opts['tag-close']) {
                return new Issue('E042', element.openLineCol);
            }
        }
    } else {
        if (opts['tag-name-match'] && element.name !== element.close) {
            return new Issue('E030', element.closeLineCol);
        }
    }

    return [];
};