@markuplint/rules 3.0.0-alpha.0 → 3.0.0-alpha.1

package/lib/indentation/index.js

@@ -1,208 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ml_core_1 = require("@markuplint/ml-core");
-exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
-    defaultValue: 2,
-    defaultOptions: {
-        alignment: true,
-        'indent-nested-nodes': true,
-    },
-    async verify(context) {
-        await context.document.walk(node => {
-            if (node.rule.disabled) {
-                return;
-            }
-            const indent = (0, ml_core_1.getIndent)(node);
-            if (indent) {
-                /**
-                 * Validate indent type and length.
-                 */
-                if (indent.type !== 'none') {
-                    const ms = node.rule.severity === 'error' ? 'must' : 'should';
-                    let spec = null;
-                    if (node.rule.value === 'tab' && indent.type !== 'tab') {
-                        spec = 'tab';
-                    }
-                    else if (typeof node.rule.value === 'number' && indent.type !== 'space') {
-                        spec = 'space';
-                    }
-                    else if (typeof node.rule.value === 'number' &&
-                        indent.type === 'space' &&
-                        indent.width % node.rule.value) {
-                        spec = context.translate('{0} width spaces', `${node.rule.value}`);
-                    }
-                    if (spec) {
-                        const message = context.translate(`{0} ${ms} be {1}`, 'Indentation', spec);
-                        context.report({
-                            scope: node,
-                            message,
-                            line: indent.line,
-                            col: 1,
-                            raw: indent.raw,
-                        });
-                        return;
-                    }
-                }
-                /**
-                 * Validate nested parent-children nodes.
-                 */
-                const nested = node.rule.option['indent-nested-nodes'];
-                if (!nested) {
-                    return;
-                }
-                const parent = node.syntaxicalParentNode;
-                if (parent) {
-                    const parentIndent = (0, ml_core_1.getIndent)(parent);
-                    const parentIndentWidth = parentIndent ? parentIndent.width : 0;
-                    const childIndentWidth = indent.width;
-                    const expectedWidth = node.rule.value === 'tab' ? 1 : node.rule.value;
-                    const diff = childIndentWidth - parentIndentWidth;
-                    if (nested === 'never') {
-                        if (diff !== 0) {
-                            const message = context.translate(diff < 1 ? 'Should increase indentation' : 'Should decrease indentation');
-                            context.report({
-                                scope: node,
-                                message,
-                                line: indent.line,
-                                col: 1,
-                                raw: indent.raw,
-                            });
-                        }
-                    }
-                    else {
-                        if (diff !== expectedWidth) {
-                            const message = context.translate(diff < 1 ? 'Should increase indentation' : 'Should decrease indentation');
-                            context.report({
-                                scope: node,
-                                message,
-                                line: indent.line,
-                                col: 1,
-                                raw: indent.raw,
-                            });
-                        }
-                    }
-                }
-            }
-            /**
-             * Validate alignment end-tags.
-             */
-            if (node instanceof ml_core_1.ElementCloseTag) {
-                const closeTag = node;
-                const startTag = closeTag.startTag;
-                if (!closeTag.rule.option.alignment) {
-                    return;
-                }
-                const closeTagIndent = (0, ml_core_1.getIndent)(closeTag);
-                if (!closeTagIndent) {
-                    return;
-                }
-                if (startTag.endLine === closeTag.endLine) {
-                    return;
-                }
-                const startTagIndent = (0, ml_core_1.getIndent)(startTag);
-                const endTagIndentationWidth = closeTagIndent ? closeTagIndent.width : 0;
-                const startTagIndentationWidth = startTagIndent ? startTagIndent.width : 0;
-                if (startTagIndentationWidth !== endTagIndentationWidth) {
-                    const message = context.translate('Start tag and end tag indentation should align');
-                    context.report({
-                        scope: closeTag,
-                        message,
-                        line: closeTagIndent ? closeTagIndent.line : closeTag.startLine,
-                        col: 1,
-                        raw: closeTagIndent ? closeTagIndent.raw : '',
-                    });
-                }
-            }
-        });
-    },
-    async fix({ document }) {
-        /**
-         * Validate indent type and length.
-         */
-        await document.walk(node => {
-            const indent = (0, ml_core_1.getIndent)(node);
-            if (!node.rule.disabled && indent) {
-                if (indent.type !== 'none') {
-                    const spec = node.rule.value === 'tab' ? '\t' : ' ';
-                    const baseWidth = node.rule.value === 'tab' ? 4 : node.rule.value;
-                    let width;
-                    if (node.rule.value === 'tab') {
-                        width = indent.type === 'tab' ? indent.width : Math.ceil(indent.width / baseWidth);
-                    }
-                    else {
-                        width =
-                            indent.type === 'tab'
-                                ? indent.width * baseWidth
-                                : Math.ceil(indent.width / baseWidth) * baseWidth;
-                    }
-                    const raw = indent.raw;
-                    const fixed = spec.repeat(width);
-                    if (raw !== fixed) {
-                        indent.fix(fixed);
-                    }
-                }
-            }
-        });
-        await document.walk(node => {
-            if (node.rule.disabled) {
-                return;
-            }
-            const indent = (0, ml_core_1.getIndent)(node);
-            if (indent) {
-                /**
-                 * Validate nested parent-children nodes.
-                 */
-                const nested = node.rule.option['indent-nested-nodes'];
-                if (!nested) {
-                    return;
-                }
-                const parent = node.syntaxicalParentNode;
-                if (!parent) {
-                    return;
-                }
-                const parentIndent = (0, ml_core_1.getIndent)(parent);
-                if (!parentIndent) {
-                    return;
-                }
-                const parentIndentWidth = parentIndent.width;
-                const childIndentWidth = indent.width;
-                const expectedWidth = node.rule.value === 'tab' ? 1 : node.rule.value;
-                const diff = childIndentWidth - parentIndentWidth;
-                if (nested === 'never') {
-                    if (diff !== 0) {
-                        const fixed = parentIndent.raw;
-                        indent.fix(fixed);
-                    }
-                }
-                else {
-                    if (diff !== expectedWidth) {
-                        const fixed = (node.rule.value === 'tab' ? '\t' : ' ').repeat(parentIndentWidth + expectedWidth);
-                        indent.fix(fixed);
-                    }
-                }
-            }
-        });
-        /**
-         * Validate alignment end-tags.
-         */
-        await document.walkOn('ElementCloseTag', endTag => {
-            if (!endTag.rule || !endTag.rule.option) {
-                return;
-            }
-            if (!endTag.rule.option.alignment) {
-                return;
-            }
-            const endTagIndent = (0, ml_core_1.getIndent)(endTag);
-            const startTagIndent = (0, ml_core_1.getIndent)(endTag.startTag);
-            if (endTagIndent && startTagIndent) {
-                const endTagIndentationWidth = endTagIndent.width;
-                const startTagIndentationWidth = startTagIndent.width;
-                if (startTagIndentationWidth !== endTagIndentationWidth) {
-                    const fixed = startTagIndent.raw;
-                    endTagIndent.fix(fixed);
-                }
-            }
-        });
-    },
-});

package/lib/permitted-contents/array.combination.d.ts

@@ -1 +0,0 @@
-export default function combination<T>(array: T[]): T[][];

package/lib/permitted-contents/array.combination.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function combination(array) {
-    // Unique
-    array = Array.from(new Set(array));
-    if (array.length <= 1) {
-        return [array];
-    }
-    // Sort
-    array.sort();
-    // Combination
-    const combinated = [];
-    for (const i1 of array) {
-        for (const i2 of array) {
-            for (const i3 of array) {
-                for (const i4 of array) {
-                    for (const i5 of array) {
-                        const item = Array.from(new Set([i1, i2, i3, i4, i5]));
-                        if (item.length === array.length) {
-                            const itemA = JSON.stringify(item);
-                            if (!combinated.includes(itemA)) {
-                                combinated.push(itemA);
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-    const result = combinated.map(i => JSON.parse(i));
-    return result;
-}
-exports.default = combination;

package/lib/permitted-contents/permitted-content.spec-to-regexp.d.ts

@@ -1,11 +0,0 @@
-import type { NamespaceURI } from '@markuplint/ml-ast';
-import type { MLMLSpec, PermittedContent } from '@markuplint/ml-spec';
-export default class ExpGenerator {
-    #private;
-    constructor(specs: MLMLSpec, id: number);
-    specToRegExp(contentRule: PermittedContent[] | boolean, parentExp?: RegExp | null, ownNS?: NamespaceURI): RegExp;
-    private _toPattern;
-    private _interleavePattern;
-    private _targetTags;
-    private _resolveTags;
-}

package/lib/permitted-contents/permitted-content.spec-to-regexp.js

@@ -1,230 +0,0 @@
-"use strict";
-var _ExpGenerator_id, _ExpGenerator_specs, _ExpGenerator_idCounter, _TagList_list;
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const ml_spec_1 = require("@markuplint/ml-spec");
-const helpers_1 = require("../helpers");
-const array_combination_1 = tslib_1.__importDefault(require("./array.combination"));
-const ALL = '(?:<[^>]+>)?';
-const ___TRANSPARENT___ = '___TRANSPARENT___';
-const ___InTRANSPARENT = '___InTRANSPARENT';
-const CUSTOM_ELEMENT = `(?:<[a-z](?:${helpers_1.rePCENChar})*\\-(?:${helpers_1.rePCENChar})*>)`;
-class ExpGenerator {
-    constructor(specs, id) {
-        _ExpGenerator_id.set(this, void 0);
-        _ExpGenerator_specs.set(this, void 0);
-        _ExpGenerator_idCounter.set(this, 0);
-        tslib_1.__classPrivateFieldSet(this, _ExpGenerator_id, id, "f");
-        tslib_1.__classPrivateFieldSet(this, _ExpGenerator_specs, specs, "f");
-    }
-    specToRegExp(contentRule, parentExp = null, ownNS = 'http://www.w3.org/1999/xhtml') {
-        if (contentRule === true) {
-            return new RegExp(`^(?:${ALL})+$`);
-        }
-        if (contentRule === false) {
-            return new RegExp('^$');
-        }
-        const parentPattern = parentExp ? parentExp.source.replace(/^\^|\$$/g, '') : ALL;
-        const pattern = this._toPattern(contentRule, null, ownNS, 1, 1).replace(___TRANSPARENT___, () => { var _a, _b; return `(?<TRANSPARENT_${tslib_1.__classPrivateFieldGet(this, _ExpGenerator_id, "f")}${tslib_1.__classPrivateFieldSet(this, _ExpGenerator_idCounter, (_b = tslib_1.__classPrivateFieldGet(this, _ExpGenerator_idCounter, "f"), _a = _b++, _b), "f"), _a}>${parentPattern})`; });
-        return new RegExp(`^${pattern}$`, 'i');
-    }
-    _toPattern(contentRule, ignore, ownNS, min, max) {
-        var _a, _b;
-        if (isTarget(contentRule)) {
-            return this._targetTags(contentRule, ignore, ownNS, min, max);
-        }
-        let notAllowedDescendantsNamedCapture = '';
-        const exp = [];
-        for (const nodeRule of contentRule) {
-            let pattern = '';
-            if (isRequiredContents(nodeRule)) {
-                if (nodeRule.notAllowedDescendants) {
-                    notAllowedDescendantsNamedCapture = nodeRule.notAllowedDescendants
-                        .map(r => r.replace('#', '_'))
-                        .join('_');
-                    if (nodeRule.require === '#transparent') {
-                        notAllowedDescendantsNamedCapture += `${___InTRANSPARENT}`;
-                    }
-                }
-                pattern = this._targetTags(nodeRule.require, nodeRule.ignore || null, ownNS, nodeRule.min || 1, nodeRule.max || nodeRule.min || 1);
-            }
-            else if (isOptionalContents(nodeRule)) {
-                if (nodeRule.notAllowedDescendants) {
-                    notAllowedDescendantsNamedCapture = nodeRule.notAllowedDescendants
-                        .map(r => r.replace('#', '_'))
-                        .join('_');
-                    if (nodeRule.optional === '#transparent') {
-                        notAllowedDescendantsNamedCapture += `${___InTRANSPARENT}`;
-                    }
-                }
-                pattern = this._targetTags(nodeRule.optional, nodeRule.ignore || null, ownNS, 0, nodeRule.max || 1);
-            }
-            else if (isOneOrMoreContents(nodeRule)) {
-                if (nodeRule.notAllowedDescendants) {
-                    notAllowedDescendantsNamedCapture = nodeRule.notAllowedDescendants
-                        .map(r => r.replace('#', '_'))
-                        .join('_');
-                    if (nodeRule.oneOrMore === '#transparent') {
-                        notAllowedDescendantsNamedCapture += `${___InTRANSPARENT}`;
-                    }
-                }
-                pattern = this._toPattern(nodeRule.oneOrMore, nodeRule.ignore || null, ownNS, 1, nodeRule.max || Infinity);
-            }
-            else if (isZeroOrMoreContents(nodeRule)) {
-                if (nodeRule.notAllowedDescendants) {
-                    notAllowedDescendantsNamedCapture = nodeRule.notAllowedDescendants
-                        .map(r => r.replace('#', '_'))
-                        .join('_');
-                    if (nodeRule.zeroOrMore === '#transparent') {
-                        notAllowedDescendantsNamedCapture += `${___InTRANSPARENT}`;
-                    }
-                }
-                pattern = this._toPattern(nodeRule.zeroOrMore, nodeRule.ignore || null, ownNS, 0, nodeRule.max || Infinity);
-            }
-            else if (isChoiceContents(nodeRule)) {
-                pattern = `(?:${nodeRule.choice.map(choice => this._toPattern(choice, null, ownNS, 1, 1)).join('|')})`;
-            }
-            else if (isInterleaveContents(nodeRule)) {
-                pattern = this._interleavePattern(nodeRule.interleave, ownNS);
-            }
-            exp.push(pattern);
-        }
-        const range = createRange(min, max);
-        const c = notAllowedDescendantsNamedCapture
-            ? `?<NAD_${tslib_1.__classPrivateFieldGet(this, _ExpGenerator_id, "f")}${tslib_1.__classPrivateFieldSet(this, _ExpGenerator_idCounter, (_b = tslib_1.__classPrivateFieldGet(this, _ExpGenerator_idCounter, "f"), _a = _b++, _b), "f"), _a}_${notAllowedDescendantsNamedCapture}>`
-            : '?:';
-        if (1 === exp.length && range === '') {
-            if (notAllowedDescendantsNamedCapture) {
-                return `(${c}${exp[0]})`;
-            }
-            return exp[0];
-        }
-        if (range === '') {
-            if (notAllowedDescendantsNamedCapture) {
-                return `(${c}${exp.join('')})`;
-            }
-            return exp.join('');
-        }
-        return `(${c}${exp.join('')})${range}`;
-    }
-    _interleavePattern(contents, ownNS) {
-        const interleave = contents.map(content => this._toPattern(content, null, ownNS, 1, 1));
-        const patterns = (0, array_combination_1.default)(interleave).map((pattern, i) => pattern.join('').replace(/(\(\?<[A-Z]+_)([0-9]+)_/g, ($0, $1, $2) => `${$1}${$2}${i}_`));
-        return join(patterns);
-    }
-    _targetTags(target, ignore, ownNS, min, max) {
-        const tagList = this._resolveTags(target, ownNS);
-        const ignoreList = ignore ? this._resolveTags(ignore, ownNS) : null;
-        if (ignoreList) {
-            ignoreList.forEach(ignore => tagList.delete(ignore));
-        }
-        return join(Array.from(tagList), createRange(min, max));
-    }
-    _resolveTags(target, ownNS) {
-        var _a, _b;
-        const list = Array.isArray(target) ? target : [target];
-        const tagList = new TagList();
-        for (const name of list) {
-            if (name !== '#text' && name[0] === '#') {
-                switch (name) {
-                    case '#transparent': {
-                        tagList.addPattern(___TRANSPARENT___);
-                        break;
-                    }
-                    case '#custom': {
-                        tagList.addPattern(CUSTOM_ELEMENT);
-                        break;
-                    }
-                    default: {
-                        const selectors = (0, ml_spec_1.contentModelCategoryToTagNames)(name, tslib_1.__classPrivateFieldGet(this, _ExpGenerator_specs, "f"));
-                        const counter = (tslib_1.__classPrivateFieldSet(this, _ExpGenerator_idCounter, (_b = tslib_1.__classPrivateFieldGet(this, _ExpGenerator_idCounter, "f"), _a = _b++, _b), "f"), _a);
-                        selectors.forEach(selector => {
-                            if (selector === '#custom') {
-                                tagList.addPattern(CUSTOM_ELEMENT);
-                                return;
-                            }
-                            if (/]$/i.test(selector)) {
-                                const [, tagName] = /^([^[\]]+)\[[^\]]+\]$/.exec(selector) || [];
-                                // ACM = Attributes by content model
-                                const exp = `(?<ACM_${tslib_1.__classPrivateFieldGet(this, _ExpGenerator_id, "f")}${counter}_${name.slice(1)}_${tagName}><${tagName}>)`;
-                                tagList.addPattern(exp);
-                                return;
-                            }
-                            tagList.addTag(selector, ownNS);
-                        });
-                    }
-                }
-                continue;
-            }
-            tagList.addTag(name, ownNS);
-        }
-        return tagList.result();
-    }
-}
-exports.default = ExpGenerator;
-_ExpGenerator_id = new WeakMap(), _ExpGenerator_specs = new WeakMap(), _ExpGenerator_idCounter = new WeakMap();
-class TagList {
-    constructor() {
-        _TagList_list.set(this, new Set());
-    }
-    addPattern(pattern) {
-        tslib_1.__classPrivateFieldGet(this, _TagList_list, "f").add(pattern);
-    }
-    addTag(tagNameOrSelector, ownNS) {
-        tagNameOrSelector = tagNameOrSelector.replace(/\|/g, ':');
-        tagNameOrSelector = tagNameOrSelector.replace(/^html:/i, '');
-        tslib_1.__classPrivateFieldGet(this, _TagList_list, "f").add(`<${tagNameOrSelector}>`);
-    }
-    result() {
-        return tslib_1.__classPrivateFieldGet(this, _TagList_list, "f");
-    }
-}
-_TagList_list = new WeakMap();
-function isRequiredContents(contents) {
-    return 'require' in contents;
-}
-function isOptionalContents(contents) {
-    return 'optional' in contents;
-}
-function isOneOrMoreContents(contents) {
-    return 'oneOrMore' in contents;
-}
-function isZeroOrMoreContents(contents) {
-    return 'zeroOrMore' in contents;
-}
-function isChoiceContents(contents) {
-    return 'choice' in contents;
-}
-function isInterleaveContents(contents) {
-    return 'interleave' in contents;
-}
-function createRange(min, max) {
-    let result = `{${min},${max}}`;
-    switch (result) {
-        case '{0,1}':
-            result = '?';
-            break;
-        case '{1,1}':
-            result = '';
-            break;
-        case '{0,Infinity}':
-            result = '*';
-            break;
-        case '{1,Infinity}':
-            result = '+';
-            break;
-    }
-    return result;
-}
-function isTarget(contentRule) {
-    if (typeof contentRule === 'string') {
-        return true;
-    }
-    return contentRule.some((i) => typeof i === 'string');
-}
-function join(pattern, range = '') {
-    if (1 === pattern.length && range === '') {
-        return pattern[0];
-    }
-    return `(?:${pattern.join('|')})${range}`;
-}

package/lib/permitted-contents/unfold-content-models-to-tags.d.ts

@@ -1,2 +0,0 @@
-import type { Category } from '@markuplint/ml-spec';
-export default function unfoldContentModelsToTags(contentModel: Category): string[];

package/lib/permitted-contents/unfold-content-models-to-tags.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const html_spec_1 = require("@markuplint/html-spec");
-function unfoldContentModelsToTags(contentModel) {
-    const tags = html_spec_1.def['#contentModels'][contentModel];
-    return tags && Array.isArray(tags) ? tags.sort() : [];
-}
-exports.default = unfoldContentModelsToTags;

package/lib/wai-aria/checkings/checking-required-owned-elements.d.ts

@@ -1,11 +0,0 @@
-import type { Options } from '../types';
-import type { ElementChecker } from '@markuplint/ml-core';
-import type { ARIARole } from '@markuplint/ml-spec';
-/**
- * Required Owned Elements
- *
- * @see https://w3c.github.io/aria/#mustContain
- */
-export declare const checkingRequiredOwnedElements: ElementChecker<boolean, Options, {
-    role?: ARIARole | null;
-}>;

package/lib/wai-aria/checkings/checking-required-owned-elements.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkingRequiredOwnedElements = void 0;
-const ml_spec_1 = require("@markuplint/ml-spec");
-/**
- * Required Owned Elements
- *
- * @see https://w3c.github.io/aria/#mustContain
- */
-const checkingRequiredOwnedElements = ({ el, role }) => t => {
-    if (!role) {
-        return;
-    }
-    if (!role.requiredOwnedElements.length) {
-        return;
-    }
-    /**
-     * > There may be times that required owned elements are missing,
-     * > for example, while editing or while loading a data set.
-     * > When a widget is missing required owned elements due to script execution or loading,
-     * > authors MUST mark a containing element with aria-busy equal to true.
-     * > For example, until a page is fully initialized and complete,
-     * > an author could mark the document element as busy.
-     *
-     * Stop to evaluate when it has `aria-busy=true` for it considers the contents are missing.
-     */
-    if (el.matches('[aria-busy="true" i]')) {
-        return;
-    }
-    // TODO: Needs to resolve `aria-own`
-    if (!el.children.length) {
-        return {
-            scope: el,
-            message: t('{0}. Or, {1}', t('Require {0} to content', t('the {0*} {1}', t(role.requiredOwnedElements), 'role')), t('require {0}', 'aria-busy="true"')),
-        };
-    }
-    const children = Array.from(el.childNodes).map(child => {
-        if (child.is(child.ELEMENT_NODE)) {
-            const computedChild = (0, ml_spec_1.getComputedRole)(child.ownerMLDocument.specs, child, child.rule.option.version);
-            if (role.requiredOwnedElements.some(ownedRole => (0, ml_spec_1.isRequiredOwnedElement)(computedChild, ownedRole, child.ownerMLDocument.specs, child.rule.option.version))) {
-                return 'REQUIRED';
-            }
-            return 'OTHER';
-        }
-        else if (child.MARKUPLINT_PREPROCESSOR_BLOCK) {
-            return 'PB';
-        }
-        return 'NO_ELEMENT';
-    });
-    if (children.includes('PB')) {
-        return {
-            scope: el,
-            message: t('{0} expects {1}', t('the "{0*}" {1}', role.name, 'role'), t(role.requiredContextRole.map(ownedRole => t('the "{0*}" {1}', ownedRole, 'role')))),
-        };
-    }
-    if (!children.includes('REQUIRED')) {
-        return {
-            scope: el,
-            message: t('{0} expects {1}', t('the "{0*}" {1}', role.name, 'role'), t('the {0*} {1}', t(role.requiredOwnedElements), 'roles')),
-        };
-    }
-};
-exports.checkingRequiredOwnedElements = checkingRequiredOwnedElements;