htmllint/lib/rules/label-req-for.js

An unofficial html5 linter.

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

module.exports = {
    name: 'label-req-for',
    filter: ['label'],
    on: ['tag'],
    desc: [
'If set, each `label` tab must have a `for` attribute.',
'This practice helps screen readers, and improves form element selection',
'by allowing the user to focus an input by clicking on the label.',
'',
'See [MDN: label element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label)',
'and [MDN: How to structure an HTML form](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Forms/How_to_structure_an_HTML_form).'
].join('\n'),
    process: proc.boolPlus('strict'),

    idmap: null
};

module.exports.end = function () {
    this.idmap = null;
};

module.exports.lint = function (ele, opts) {
    // whether or not all labels MUST have a for attr,
    // regardless of whether the label has children
    var strict = (opts[this.name] === 'strict'),
        hasFor = ele.attribs.hasOwnProperty('for');

    if (strict && !hasFor) {
        return new Issue('E019', ele.openLineCol);
    } else if (!strict && !hasFor && !this.hasValidChild(ele)) {
        return new Issue('E020', ele.openLineCol);
    }

    if (hasFor) {
        if (!this.idmap) {
            this.buildIdMap(ele);
        }

        var id = ele.attribs['for'].value,
            forElement = this.idmap[id];

        if (!forElement) {
            // the paired element does not exist
            return new Issue('E021', ele.openLineCol, { id: id });
        } else if (!knife.isLabeable(forElement)) {
            return new Issue('E022', ele.openLineCol, { id: id });
        }
    }

    return [];
};

module.exports.buildIdMap = function (originElement) {
    var rElem = originElement;
    while (rElem.parent !== null) {
        rElem = rElem.parent;
    }
    while (rElem.prev !== null) {
        rElem = rElem.prev;
    }

    var roots = [];
    while (rElem !== null) {
        roots.push(rElem);
        rElem = rElem.next;
    }

    var idmap = {};

    roots.forEach(function iterateElements(element) {
        if (element.attribs && element.attribs.id) {
            var id = element.attribs.id.value;

            if (!idmap.hasOwnProperty(id)) {
                idmap[id] = element;
            }
        }

        if (element.children) {
            element.children.forEach(iterateElements);
        }
    });

    this.idmap = idmap;
};

module.exports.hasValidChild = function (ele) {
    // test for any element to be labeable
    return lodash.some(ele.children, knife.isLabeable);
};