plugin.html-validate.bootstrap.js

const { Rule } = require('html-validate');
const { nodeIgnore } = require('./plugin.html-validate.utils');

/**
 * @typedef { import('html-validate').DOMReadyEvent } DOMReadyEvent
 */

const COLS_COUNT = 12;
const COLS_BREAKPOINTS = ['xs', 'sm', 'md', 'lg', 'xl', 'xxl'];

const makeColsClassList = (cols = COLS_COUNT, breakpoints = COLS_BREAKPOINTS) => {
    const colsNumbers = Array.from({ length: cols }, (value, index) => index + 1);
    return [
        ...colsNumbers.map((col) => `col-${col}`),
        'col',
        'col-auto',
        ...breakpoints
            .map((breakpoint) => [
                ...colsNumbers.map((col) => `col-${breakpoint}-${col}`),
                `col-${breakpoint}`,
                `col-${breakpoint}-auto`,
            ])
            .flat(),
    ];
};

const colSelector = (cols = COLS_COUNT, breakpoints = COLS_BREAKPOINTS) => {
    const classList = makeColsClassList(cols, breakpoints);
    return classList.map((className) => `.${className}`).join(', ');
};

/**
 * Abstract bootstrap rule
 */
class AbsRule extends Rule {
    /**
     * @param {object} options - plugin options
     */
    constructor(options) {
        super({
            ignore: '',
            cols: COLS_COUNT,
            breakpoints: COLS_BREAKPOINTS,
            ...options,
        });
        this.domReady = this.domReady.bind(this);
    }

    /**
     * Setup plugin events.
     */
    setup() {
        this.on('dom:ready', this.domReady);
    }
}

/**
 *  Lint `.container` disallow nesting.
 */
class ContainerNoNested extends AbsRule {
    /**
     * Lint html document.
     * @param {DOMReadyEvent.document} document - document object
     */
    domReady({ document }) {
        const containers = document.querySelectorAll('.container, .container-fluid');
        const ignores = this.options.ignore ? document.querySelectorAll(this.options.ignore) : [];
        containers.forEach((container) => {
            if (nodeIgnore(container, ignores) || !container.parent) {
                return;
            }

            if (
                container.parent.classList.contains('container') ||
                container.parent.classList.contains('container-fluid')
            ) {
                this.report(container, 'Containers (`.container` and `.container-fluid`) are not nestable.');
            }
        });
    }
}

/**
 * Lint `.col` without row.
 */
class ColNoRow extends AbsRule {
    /**
     * Lint html document.
     * @param {DOMReadyEvent.document} document - document object
     */
    domReady({ document }) {
        const selector = colSelector(this.options.cols, this.options.breakpoints);
        const cols = document.querySelectorAll(selector);
        const ignores = this.options.ignore ? document.querySelectorAll(this.options.ignore) : [];
        cols.forEach((col) => {
            if (nodeIgnore(col, ignores)) {
                return;
            }

            if (col.classList.contains('row')) {
                this.report(col, 'Found both `.row` and `.col-*-*` used on the same element.');
            }
            if (!col.parent || !col.parent.classList.contains('row')) {
                this.report(col, 'Not found `.row` for `.col`.');
            }
        });
    }
}

/**
 * Lint empty `.row`.
 */
class RowNoChilds extends AbsRule {
    /**
     * Lint html document.
     * @param {DOMReadyEvent.document} document - document object
     */
    domReady({ document }) {
        const cols = makeColsClassList(this.options.cols, this.options.breakpoints);
        const elements = document.querySelectorAll('.row > *');
        const ignores = this.options.ignore ? document.querySelectorAll(this.options.ignore) : [];
        elements.forEach((el) => {
            if (nodeIgnore(el, ignores)) {
                return;
            }

            if (!cols.some((className) => el.classList.contains(className))) {
                this.report(el, 'Only columns (`.col-*-*`) may be children of `.row`s.');
            }
        });
    }
}

/**
 * Lint `select` required `.form-select` class.
 */
class FormSelectNoFormControl extends Rule {
    /**
     * Lint html document.
     * @param {object} options - plugin options
     */
    constructor(options) {
        super({ ignore: '', ...options });
        this.domReady = this.domReady.bind(this);
    }

    /**
     * Setup plugin events.
     */
    setup() {
        this.on('dom:ready', this.domReady);
    }

    /**
     * Lint html document.
     * @param {DOMReadyEvent.document} document - document object
     */
    domReady({ document }) {
        const selects = document.querySelectorAll('select');
        const ignores = this.options.ignore ? document.querySelectorAll(this.options.ignore) : [];
        selects.forEach((select) => {
            if (nodeIgnore(select, ignores)) {
                return;
            }

            if (select.classList.contains('form-control')) {
                this.report(select, 'For <select> not allowed `form-control` class, use `form-select` instead.');
            }
        });
    }
}

/**
 * Lint `.form-control` allow only for `input` or `textarea`.
 */
class FormControlInputOnly extends Rule {
    /**
     * @param {object} options - plugin options
     */
    constructor(options) {
        super({ ignore: '', ...options });
        this.domReady = this.domReady.bind(this);
    }

    /**
     * Setup plugin events.
     */
    setup() {
        this.on('dom:ready', this.domReady);
    }

    /**
     * Lint html document.
     * @param {DOMReadyEvent.document} document - document object
     */
    domReady({ document }) {
        const controls = document.querySelectorAll('.form-control');
        const ignores = this.options.ignore ? document.querySelectorAll(this.options.ignore) : [];
        controls.forEach((control) => {
            if (nodeIgnore(control, ignores)) {
                return;
            }
            const nodeName = control.nodeName.toLowerCase();
            if (!(nodeName === 'input' || nodeName === 'textarea')) {
                this.report(control, 'Class `form-control` allowed only for input`s or textarea`s.');
            }
        });
    }
}

module.exports = {
    ColNoRow,
    RowNoChilds,
    ContainerNoNested,
    FormSelectNoFormControl,
    FormControlInputOnly,
};

module.exports.rules = {
    'bootstrap/col-no-row': ColNoRow,
    'bootstrap/row-no-childs': RowNoChilds,
    'bootstrap/container-no-nested': ContainerNoNested,
    'bootstrap/form-control-input-only': FormControlInputOnly,
    'bootstrap/form-select-no-form-control': FormSelectNoFormControl,
};