htmllint/lib/rules/spec-char-escape.js

An unofficial html5 linter.

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

module.exports = {
    name: 'spec-char-escape',
    on: ['dom'],
    filter: ['text', 'tag'],
    options: [{
        desc: 'If set, special characters in text and attributes (e.g. `>`) must be escaped.',
        process: proc.bool
    }, {
        name: 'text-ignore-regex',
        desc: [
'A string giving a regular expression, a RegExp object, or `false`. If',
'set, text matching the given regular expression is ignored by rules',
'which apply to raw text (currently, just `spec-char-escape`).',
'For example, `\\[{.*?}\\]` will exclude text wrapped in `[{...}]`.',
'Note that such text may still cause the input html to parse incorrectly,',
'which could result in errors in other rules later. To remove such text',
'before parsing, use `raw-ignore-regex`.'
].join('\n'),
        process: proc.regexGlobal,
        rules: []
    }]
};

// Messages for each group in the regex
var messages = [
    undefined,
    'an escape with invalid characters',
    'an unescaped angle bracket',
    'an ill-formed escape sequence'
];
var regex = /(&[^a-zA-Z0-9#;]*;)|([<>])|(&[a-zA-Z0-9#]*[^a-zA-Z0-9#;])/gm;

module.exports.lint = function (element, opts) {
    var issues = [],
        ignore = opts['text-ignore-regex'];

    function addIssues(text, lineCol, partDesc) {
        // Replace ignored parts with spaces (to preserve line/col numbering)
        text = text.replace(ignore,
            function(match) { return match.replace(/./g, ' '); }
        );
        var lineColFunc = knife.getLineColFunc(text, lineCol, 0),
            match;
        while (match = regex.exec(text)) {
            var i = 1; while (!match[i]) { i++; }
            issues.push(new Issue('E023', lineColFunc(match.index), {
                chars: match[i],
                part: partDesc,
                desc: messages[i]
            }));
        }
    }

    // if it's text - make sure it only has alphanumericals. If it has a &, a ; should follow.
    if (element.type === 'text' && element.data.length > 0) {
        addIssues(element.data, element.lineCol, 'text');
    }

    var attrs = element.attribs;
    if (attrs) {
        Object.keys(attrs).forEach(function (name) {
            var v = attrs[name];
            addIssues(v.value, v.valueLineCol, 'attribute value');
        });
    }
    return issues;
};