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

package/lib/permitted-contents/count-pattern.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.countPattern = void 0;
+const debug_1 = require("./debug");
+const recursive_branch_1 = require("./recursive-branch");
+const utils_1 = require("./utils");
+/**
+ * Check count
+ *
+ * @param pattern
+ * @param elements
+ * @param specs
+ * @param options
+ * @param depth
+ * @returns
+ */
+function countPattern(pattern, elements, specs, options, depth) {
+    var _a, _b, _c, _d, _e;
+    const ptLog = debug_1.cmLog.extend(`countPattern#${depth}`);
+    const collection = new utils_1.Collection(elements);
+    let min;
+    let max;
+    let model;
+    let type;
+    let _type;
+    if ((0, utils_1.isRequire)(pattern)) {
+        min = (_a = pattern.min) !== null && _a !== void 0 ? _a : 1;
+        max = Math.max((_b = pattern.max) !== null && _b !== void 0 ? _b : 1, min);
+        model = pattern.require;
+        type = 'MISSING_NODE_REQUIRED';
+        _type = 'require';
+    }
+    else if ((0, utils_1.isOptional)(pattern)) {
+        min = 0;
+        max = Math.max((_c = pattern.max) !== null && _c !== void 0 ? _c : 1, 1);
+        model = pattern.optional;
+        _type = 'optional';
+    }
+    else if ((0, utils_1.isOneOrMore)(pattern)) {
+        min = 1;
+        max = Math.max((_d = pattern.max) !== null && _d !== void 0 ? _d : Infinity, 1);
+        model = pattern.oneOrMore;
+        type = 'MISSING_NODE_ONE_OR_MORE';
+        _type = 'one or more';
+    }
+    else if ((0, utils_1.isZeroOrMore)(pattern)) {
+        min = 0;
+        max = Math.max((_e = pattern.max) !== null && _e !== void 0 ? _e : Infinity, 1);
+        model = pattern.zeroOrMore;
+        _type = 'zero or more';
+    }
+    else {
+        throw new Error('Unreachable code');
+    }
+    ptLog('%s: %o', _type, model);
+    let prevResult = null;
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+        ptLog('%s', collection);
+        const result = (0, recursive_branch_1.recursiveBranch)(model, collection.unmatched, specs, options, depth);
+        const added = collection.addMatched(result.matched);
+        if (result.type === 'UNMATCHED_SELECTOR_BUT_MAY_EMPTY') {
+            ptLog('MATCHED_ZERO: %s', result.query);
+            return {
+                type: 'MATCHED_ZERO',
+                matched: collection.matched,
+                unmatched: collection.unmatched,
+                zeroMatch: true,
+                query: result.query,
+                hint: result.hint,
+            };
+        }
+        if (max < collection.matchedCount) {
+            collection.max(max);
+            ptLog('UNEXPECTED_EXTRA_NODE (max: %s): %s', max, result.query);
+            return {
+                type: 'UNEXPECTED_EXTRA_NODE',
+                matched: collection.matched,
+                unmatched: collection.unmatched,
+                zeroMatch: result.zeroMatch,
+                query: result.query,
+                hint: {
+                    ...result.hint,
+                    max,
+                },
+            };
+        }
+        if (prevResult) {
+            if (result.type === 'MISSING_NODE_ONE_OR_MORE' ||
+                result.type === 'MISSING_NODE_REQUIRED' ||
+                result.type === 'TRANSPARENT_MODEL_DISALLOWS') {
+                ptLog('%s(continued): %s', result.type, collection);
+                return {
+                    type: result.type,
+                    matched: collection.matched,
+                    unmatched: collection.unmatched,
+                    zeroMatch: result.zeroMatch,
+                    query: result.query,
+                    hint: result.hint,
+                };
+            }
+            ptLog('%s(continued): %s', prevResult.type, collection);
+            return prevResult;
+        }
+        if (added && collection.unmatched.length > 0) {
+            continue;
+        }
+        if (collection.matchedCount + (result.zeroMatch ? 1 : 0) < min) {
+            const resultType = result.type === 'MISSING_NODE_REQUIRED' ||
+                result.type === 'MISSING_NODE_ONE_OR_MORE' ||
+                result.type === 'TRANSPARENT_MODEL_DISALLOWS'
+                ? result.type
+                : type !== null && type !== void 0 ? type : 'MISSING_NODE_REQUIRED';
+            ptLog('%s(in %s): %s', resultType, type, result.query);
+            return {
+                type: resultType,
+                matched: collection.matched,
+                unmatched: collection.unmatched,
+                zeroMatch: result.zeroMatch,
+                query: result.query,
+                hint: result.hint,
+            };
+        }
+        const resultType = collection.matched.length === 0 ? 'MATCHED_ZERO' : 'MATCHED';
+        const zeroMatch = result.zeroMatch || min === 0 || resultType === 'MATCHED_ZERO';
+        const matchedResult = {
+            type: resultType,
+            matched: collection.matched,
+            unmatched: collection.unmatched,
+            zeroMatch,
+            query: result.query,
+            hint: result.hint,
+        };
+        if (!prevResult && collection.unmatched.length) {
+            ptLog('continue checking');
+            prevResult = matchedResult;
+            continue;
+        }
+        ptLog('%s: %s', resultType, collection);
+        if (result.type === 'MISSING_NODE_REQUIRED' ||
+            result.type === 'MISSING_NODE_ONE_OR_MORE' ||
+            result.type === 'TRANSPARENT_MODEL_DISALLOWS') {
+            return {
+                type: result.type,
+                matched: collection.matched,
+                unmatched: collection.unmatched,
+                zeroMatch: result.zeroMatch,
+                query: result.query,
+                hint: result.hint,
+            };
+        }
+        return matchedResult;
+    }
+}
+exports.countPattern = countPattern;

package/lib/permitted-contents/debug.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="debug" />
+export declare const cmLog: import("debug").Debugger;

package/lib/permitted-contents/debug.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cmLog = void 0;
+const debug_1 = require("../debug");
+exports.cmLog = debug_1.log.extend('content-model');

package/lib/permitted-contents/index.d.ts

@@ -1,9 +1,3 @@
-import type { ContentModel } from '@markuplint/ml-spec';
-declare type TagRule = ContentModel & {
-    tag: string;
-};
-declare type Options = {
-    ignoreHasMutableChildren: boolean;
-};
+import type { Options, TagRule } from './types';
 declare const _default: import("@markuplint/ml-core").RuleSeed<TagRule[], Options>;
 export default _default;

package/lib/permitted-contents/index.js

@@ -1,281 +1,111 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const ml_core_1 = require("@markuplint/ml-core");
-const ml_spec_1 = require("@markuplint/ml-spec");
-const permitted_content_spec_to_regexp_1 = tslib_1.__importDefault(require("./permitted-content.spec-to-regexp"));
-const expMapOnNodeId = new Map();
+const content_model_1 = require("./content-model");
+const represent_transparent_nodes_1 = require("./represent-transparent-nodes");
 exports.default = (0, ml_core_1.createRule)({
     defaultValue: [],
     defaultOptions: {
         ignoreHasMutableChildren: true,
     },
     async verify({ document, report, t }) {
-        let idCounter = 0;
         await document.walkOn('Element', el => {
-            var _a;
+            var _a, _b, _c;
             if (!el.rule.value) {
                 return;
             }
             if (el.rule.option.ignoreHasMutableChildren && el.hasMutableChildren()) {
                 return;
             }
-            const specType = el.namespaceURI === 'http://www.w3.org/1999/xhtml'
-                ? 'HTML'
-                : el.namespaceURI === 'http://www.w3.org/2000/svg'
-                    ? 'SVG'
-                    : 'Any Language';
-            const childNodes = el.getChildElementsAndTextNodeWithoutWhitespaces();
-            const spec = !el.isCustomElement && ((_a = (0, ml_core_1.getSpec)(el, document.specs)) === null || _a === void 0 ? void 0 : _a.contentModel);
-            const expGen = new permitted_content_spec_to_regexp_1.default(document.specs, idCounter++);
-            if (spec) {
-                if (spec.descendantOf && !el.closest(spec.descendantOf)) {
-                    report({
-                        scope: el,
-                        message: t('{0} must be {1}', t('the "{0*}" {1}', el.localName, 'element'), t('{0} of {1}', 'descendant', t('the "{0*}" {1}', spec.descendantOf, 'element'))),
-                    });
-                    return;
-                }
-                let matched = false;
-                if (spec.conditional) {
-                    for (const conditional of spec.conditional) {
-                        matched = el.matches(conditional.condition);
-                        // console.log({ ...conditional, matched });
-                        if (matched) {
-                            try {
-                                const parentExp = getRegExpFromParentNode(document.specs, el, expGen);
-                                const exp = expGen.specToRegExp(conditional.contents, parentExp, el.namespaceURI);
-                                const conditionalResult = match(exp, childNodes, false, document.specs);
-                                if (!conditionalResult) {
-                                    const message = t('{0} is {1:c}', t('{0} of {1}', t('the {0}', 'content'), t('the "{0*}" {1}', el.localName, 'element')), 'invalid');
-                                    report({
-                                        scope: el,
-                                        message: specType !== 'Any Language'
-                                            ? t('{0} according to {1}', message, `the ${specType} specification`)
-                                            : message,
-                                        line: el.startLine,
-                                        col: el.startCol,
-                                        raw: el.raw,
-                                    });
-                                    break;
-                                }
-                            }
-                            catch (e) {
-                                if (e instanceof Error) {
-                                    // eslint-disable-next-line no-console
-                                    console.warn(el.raw, 'conditional', conditional, e.message);
-                                }
-                                else {
-                                    throw e;
-                                }
-                            }
-                        }
+            const results = (0, content_model_1.contentModel)(el, el.rule.value, el.rule.option);
+            for (const { type, scope, query, hint } of results) {
+                let message = '';
+                if (hint) {
+                    if (hint.max != null) {
+                        message =
+                            t('there is more content than it needs') +
+                                t('. ') +
+                                t('the max number of elements required is {0}', `${hint.max}`);
                     }
                 }
-                if (!matched) {
-                    try {
-                        const exp = getRegExpFromNode(document.specs, el, expGen);
-                        const specResult = match(exp, childNodes, false, document.specs);
-                        if (!specResult) {
-                            const message = t('{0} is {1:c}', t('{0} of {1}', t('the {0}', 'content'), t('the "{0*}" {1}', el.localName, 'element')), 'invalid');
-                            report({
-                                scope: el,
-                                message: specType !== 'Any Language'
-                                    ? t('{0} according to {1}', message, `the ${specType} specification`)
-                                    : message,
-                            });
-                        }
+                switch (type) {
+                    case 'MATCHED':
+                    case 'MATCHED_ZERO': {
+                        break;
                     }
-                    catch (e) {
-                        if (e instanceof Error) {
-                            // eslint-disable-next-line no-console
-                            console.warn(el.raw, 'HTML Spec', e.message);
-                        }
-                        else {
-                            throw e;
-                        }
+                    case 'MISSING_NODE_ONE_OR_MORE': {
+                        message =
+                            message ||
+                                t('Require {0}', t('one or more elements')) + t('. ') + '(' + t('Need "{0*}"', query) + ')';
+                        report({
+                            scope,
+                            message,
+                        });
+                        break;
                     }
-                }
-            }
-            for (const rule of el.rule.value) {
-                if (rule.tag.toLowerCase() !== el.localName.toLowerCase()) {
-                    continue;
-                }
-                const parentExp = getRegExpFromParentNode(document.specs, el, expGen);
-                try {
-                    const exp = expGen.specToRegExp(rule.contents, parentExp, el.namespaceURI);
-                    // Evaluate the custom element if the optional schema.
-                    const r = match(exp, childNodes, el.isCustomElement, document.specs);
-                    if (!r) {
+                    case 'MISSING_NODE_REQUIRED': {
+                        message =
+                            message ||
+                                t('Require {0}', t('an {0}', 'element')) + t('. ') + '(' + t('Need "{0*}"', query) + ')';
                         report({
-                            scope: el,
-                            message: t('{0} is {1:c}', t('{0} of {1}', t('the {0}', 'content'), t('the "{0*}" {1}', el.localName, 'element')), 'invalid'),
-                            line: el.startLine,
-                            col: el.startCol,
-                            raw: el.raw,
+                            scope,
+                            message,
                         });
-                        return;
+                        break;
                     }
-                }
-                catch (e) {
-                    if (e instanceof Error) {
-                        // eslint-disable-next-line no-console
-                        console.warn(el.raw, 'rule', rule, e.message);
+                    case 'UNEXPECTED_EXTRA_NODE': {
+                        const not = (_a = hint.not) !== null && _a !== void 0 ? _a : scope;
+                        message =
+                            message ||
+                                (represent_transparent_nodes_1.transparentMode.has(scope)
+                                    ? t('{0} is not allowed in {1} through the transparent model in this context', name(not, t), name(el, t))
+                                    : t('{0} is not allowed in {1} in this context', name(not, t), name(el, t)));
+                        report({
+                            scope: not,
+                            message,
+                        });
+                        break;
+                    }
+                    case 'TRANSPARENT_MODEL_DISALLOWS': {
+                        const not = (_b = hint.not) !== null && _b !== void 0 ? _b : scope;
+                        const tp = (_c = hint.transparent) !== null && _c !== void 0 ? _c : el;
+                        report({
+                            scope: not,
+                            message: t('{0} is {1} but {2}', name(tp, t), t('a {0}', 'transparent model'), t('also disallows {0} in this context', name(not, t))),
+                        });
+                        break;
+                    }
+                    case 'VOID_ELEMENT': {
+                        report({
+                            scope: el,
+                            message: t('{0} is {1}', t('the {0}', 'element'), t('a {0}', 'void element')),
+                        });
+                        break;
                     }
-                    else {
-                        throw e;
+                    default: {
+                        throw new Error('Unreachable code');
                     }
                 }
             }
+            represent_transparent_nodes_1.transparentMode.clear();
         });
-        expMapOnNodeId.clear();
     },
 });
-function normalization(el, evalCustomElement) {
-    return el
-        .map(node => {
-        // FIXME: https://github.com/markuplint/markuplint/issues/388
-        if (!evalCustomElement && node.is(node.ELEMENT_NODE) && node.isCustomElement) {
-            return '';
-        }
-        if (!node.is(node.ELEMENT_NODE)) {
-            return '<#text>';
-        }
-        const { localNameWithNS } = (0, ml_core_1.resolveNamespace)(node.localName, node.namespaceURI);
-        return `<${localNameWithNS}>`;
-    })
-        .join('');
-}
-function getRegExpFromNode(specs, el, expGen) {
-    var _a;
-    // console.log({ n: node.nodeName });
-    if (expMapOnNodeId.has(el.uuid)) {
-        return expMapOnNodeId.get(el.uuid);
+function name(scope, t) {
+    if (scope.is(scope.ELEMENT_NODE)) {
+        return t('the "{0}" {1}', scope.localName, 'element');
     }
-    const parentExp = el.parentNode ? getRegExpFromNode(specs, el.parentNode, expGen) : null;
-    const spec = el.nodeType === el.ELEMENT_NODE && !el.isCustomElement && ((_a = (0, ml_core_1.getSpec)(el, specs)) === null || _a === void 0 ? void 0 : _a.contentModel);
-    const contentRule = spec ? spec.contents : true;
-    const exp = expGen.specToRegExp(contentRule, parentExp, el.nodeType === el.ELEMENT_NODE ? el.namespaceURI : undefined);
-    expMapOnNodeId.set(el.uuid, exp);
-    return exp;
-}
-function getRegExpFromParentNode(specs, el, expGen) {
-    // console.log({ p: node.nodeName });
-    const parentExp = el.parentNode ? getRegExpFromNode(specs, el.parentNode, expGen) : null;
-    return parentExp;
-}
-const matchingCacheMap = new Map();
-function match(exp, childNodes, evalCustomElement, specs) {
-    const target = normalization(childNodes, evalCustomElement);
-    const cacheKey = target +
-        exp.source +
-        childNodes.map(n => (n.is(n.ELEMENT_NODE) ? n.toNormalizeString() : n.originRaw)).join('');
-    const res = matchingCacheMap.get(cacheKey);
-    if (res != null) {
-        return res;
+    if (scope.is(scope.TEXT_NODE)) {
+        return t('the {0}', 'text node');
     }
-    const matched = _match(target, exp, childNodes, specs);
-    matchingCacheMap.set(cacheKey, matched);
-    return matched;
-}
-function _match(target, exp, childNodes, specs) {
-    const result = exp.exec(target);
-    if (!result) {
-        return false;
+    if (scope.is(scope.CDATA_SECTION_NODE)) {
+        return t('the {0}', 'comment');
     }
-    const capGroups = result.groups;
-    // console.log({ exp, target, capGroups });
-    if (!capGroups) {
-        return true;
+    if (scope.is(scope.DOCUMENT_TYPE_NODE)) {
+        return t('the {0}', 'doctype');
     }
-    const groupNames = Object.keys(capGroups);
-    for (const groupName of groupNames) {
-        const matched = capGroups[groupName];
-        if (!matched) {
-            continue;
-        }
-        const [type, , ..._selector] = groupName.split(/(?<=[a-z0-9])_/gi);
-        // console.log({ type, _selector });
-        switch (type) {
-            case 'ACM': {
-                const [model, tag] = _selector;
-                const selectors = (0, ml_spec_1.contentModelCategoryToTagNames)(`#${model}`, specs).filter(selector => {
-                    const [, tagName] = /^([^[\]]+)(?:\[[^\]]+\])?$/.exec(selector) || [];
-                    return tagName.toLowerCase() === tag.toLowerCase();
-                });
-                for (const node of childNodes) {
-                    if (node.is(node.TEXT_NODE)) {
-                        continue;
-                    }
-                    if (node.nodeName.toLowerCase() !== tag.toLowerCase()) {
-                        continue;
-                    }
-                    for (const selector of selectors) {
-                        const matched = node.matches(selector);
-                        // console.log({ raw: node.raw, selector, matched });
-                        if (matched) {
-                            return true;
-                        }
-                    }
-                    return false;
-                }
-                break;
-            }
-            case 'NAD': {
-                let targetsMaybeIncludesNotAllowedDescendants = Array.from(new Set(matched.split(/><|<|>/g).filter(_ => _)));
-                const contents = new Set();
-                const transparentGroupName = groupNames.find(name => /^TRANSPARENT_[0-9]+$/.test(name));
-                const inTransparent = _selector.includes('__InTRANSPARENT')
-                    ? transparentGroupName && capGroups[transparentGroupName]
-                        ? capGroups[transparentGroupName].split(/><|<|>/g).filter(_ => _)
-                        : null
-                    : null;
-                _selector.forEach(content => {
-                    if (content[0] === '_') {
-                        (0, ml_spec_1.contentModelCategoryToTagNames)(content.replace('_', '#'), specs).forEach(tag => contents.add(tag));
-                        return;
-                    }
-                    contents.add(content);
-                });
-                const selectors = Array.from(contents);
-                targetsMaybeIncludesNotAllowedDescendants = targetsMaybeIncludesNotAllowedDescendants.filter(content => inTransparent ? inTransparent.includes(content) : true);
-                // console.log({
-                // 	groupName,
-                // 	matched,
-                // 	_selector,
-                // 	type,
-                // 	selectors,
-                // 	inTransparent,
-                // 	targetsMaybeIncludesNotAllowedDescendants,
-                // });
-                for (const node of childNodes) {
-                    for (const target of targetsMaybeIncludesNotAllowedDescendants) {
-                        if (node.is(node.TEXT_NODE)) {
-                            if (selectors.includes('#text')) {
-                                return false;
-                            }
-                            continue;
-                        }
-                        if (node.nodeName.toLowerCase() !== target.toLowerCase()) {
-                            continue;
-                        }
-                        for (const selector of selectors) {
-                            // console.log({ selector, target });
-                            // Self
-                            if (node.matches(selector)) {
-                                return false;
-                            }
-                            // Descendants
-                            const nodeList = node.querySelectorAll(selector);
-                            if (nodeList.length) {
-                                return false;
-                            }
-                        }
-                    }
-                }
-                break;
-            }
-        }
+    if (scope.is(scope.MARKUPLINT_PREPROCESSOR_BLOCK)) {
+        return t('the {0}', 'code block');
     }
-    return true;
+    return t('the {0}', 'node');
 }

package/lib/permitted-contents/matches-selector.d.ts

@@ -0,0 +1,3 @@
+import type { ChildNode, Options, Result, Specs } from './types';
+export declare type SelectorResult = Result<'UNMATCHED_SELECTOR_BUT_MAY_EMPTY' | 'MISSING_NODE' | 'UNMATCHED_SELECTORS'>;
+export declare function matchesSelector(query: string, node: ChildNode | undefined, specs: Specs, options: Options, depth: number): SelectorResult;