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

package/lib/permitted-contents/matches-selector.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchesSelector = void 0;
+const ml_spec_1 = require("@markuplint/ml-spec");
+const debug_1 = require("./debug");
+const utils_1 = require("./utils");
+function matchesSelector(query, node, specs, options, depth) {
+    const nodeLog = debug_1.cmLog.extend(`node#${depth}`);
+    const { selector, hasText, hasCustom } = optCondition(query, specs);
+    if (node == null) {
+        if (hasText) {
+            nodeLog('<#text>.matches(%s) => ""', query);
+            return {
+                type: 'MATCHED_ZERO',
+                matched: node ? [node] : [],
+                unmatched: [],
+                zeroMatch: true,
+                query,
+                hint: {},
+            };
+        }
+        return {
+            type: 'MISSING_NODE',
+            matched: [],
+            unmatched: [],
+            zeroMatch: false,
+            query,
+            hint: {},
+        };
+    }
+    if (node.is(node.TEXT_NODE)) {
+        if (hasText) {
+            nodeLog('<#text>.matches(%s) => "%s"', query, node.raw.trim());
+            return {
+                type: 'MATCHED',
+                matched: [node],
+                unmatched: [],
+                zeroMatch: true,
+                query,
+                hint: {},
+            };
+        }
+        if (node.isWhitespace()) {
+            nodeLog('<#text>.matches(%s) => WHITESPACE', query);
+            return {
+                type: 'MATCHED',
+                matched: [node],
+                unmatched: [],
+                zeroMatch: true,
+                query,
+                hint: {},
+            };
+        }
+        // Disallows a text node
+        return {
+            type: 'UNEXPECTED_EXTRA_NODE',
+            matched: [],
+            unmatched: [node],
+            zeroMatch: false,
+            query,
+            hint: {},
+        };
+    }
+    if (node.is(node.MARKUPLINT_PREPROCESSOR_BLOCK)) {
+        nodeLog('%s.matches(%s) => PBlock', node.raw, query);
+        return {
+            type: 'MATCHED',
+            matched: [node],
+            unmatched: [],
+            zeroMatch: !!hasText,
+            query,
+            hint: {},
+        };
+    }
+    if (node.is(node.ELEMENT_NODE)) {
+        if (node.elementType !== 'html' && hasCustom) {
+            nodeLog('%s.matches(%s) => CustomElement', node.raw, query);
+            return {
+                type: 'MATCHED',
+                matched: [node],
+                unmatched: [],
+                zeroMatch: !!hasText,
+                query,
+                hint: {},
+            };
+        }
+        const result = (0, utils_1.matches)(selector, node, specs);
+        nodeLog('%s.matches(%s) => %s', node.raw, query, result.matched);
+        if (result.matched) {
+            return {
+                type: 'MATCHED',
+                matched: [node],
+                unmatched: [],
+                zeroMatch: !!hasText,
+                query,
+                hint: {},
+            };
+        }
+        if (hasText) {
+            return {
+                type: 'UNMATCHED_SELECTOR_BUT_MAY_EMPTY',
+                matched: [],
+                unmatched: [node],
+                zeroMatch: true,
+                query,
+                hint: {
+                    not: result.not,
+                },
+            };
+        }
+        return {
+            type: 'UNMATCHED_SELECTORS',
+            matched: [],
+            unmatched: [node],
+            zeroMatch: false,
+            query,
+            hint: {
+                not: result.not,
+            },
+        };
+    }
+    return {
+        type: 'MATCHED',
+        matched: [node],
+        unmatched: [],
+        zeroMatch: !!hasText,
+        query,
+        hint: {},
+    };
+}
+exports.matchesSelector = matchesSelector;
+const conditionWithoutSpecs = {
+    '#custom': {
+        selector: '#custom',
+        hasCustom: true,
+        hasText: false,
+    },
+    '#text': {
+        selector: '#text',
+        hasCustom: false,
+        hasText: true,
+    },
+};
+const optConditionSpecsBaseCaches = new Map();
+function optCondition(query, specs) {
+    var _a;
+    const condWithoutSpecs = conditionWithoutSpecs[query];
+    if (condWithoutSpecs) {
+        return condWithoutSpecs;
+    }
+    const queryCaches = (_a = optConditionSpecsBaseCaches.get(specs)) !== null && _a !== void 0 ? _a : new Map();
+    const cached = queryCaches.get(query);
+    if (cached) {
+        return cached;
+    }
+    let hasCustom = false;
+    let hasText = false;
+    const selector = query.replace(/^(?::model\(([^)]+)\)|#([a-z-]+))(.*)$/, (_, $model, _model, $last) => {
+        const _selectors = (0, ml_spec_1.contentModelCategoryToTagNames)(`#${$model !== null && $model !== void 0 ? $model : _model}`, specs.def);
+        if (_selectors.length === 0) {
+            throw new Error(`${$model !== null && $model !== void 0 ? $model : _model} is empty`);
+        }
+        const selectors = [];
+        for (const selector of _selectors) {
+            if (selector === '#custom') {
+                hasCustom = true;
+                continue;
+            }
+            if (selector === '#text') {
+                hasText = true;
+                continue;
+            }
+            selectors.push(selector);
+        }
+        return `:is(${selectors.join(',')})${$last !== null && $last !== void 0 ? $last : ''}`;
+    });
+    const result = {
+        selector,
+        hasCustom,
+        hasText,
+    };
+    queryCaches.set(query, result);
+    optConditionSpecsBaseCaches.set(specs, queryCaches);
+    return result;
+}

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

@@ -0,0 +1,13 @@
+import type { ChildNode, Options, Result, Specs } from './types';
+import type { PermittedContentPattern } from '@markuplint/ml-spec';
+/**
+ * Check ordered array
+ *
+ * @param contents
+ * @param nodes
+ * @param specs
+ * @param options
+ * @param depth
+ * @returns
+ */
+export declare function order(contents: ReadonlyArray<PermittedContentPattern>, nodes: ReadonlyArray<ChildNode>, specs: Specs, options: Options, depth: number): Result;

package/lib/permitted-contents/order.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.order = void 0;
+const helpers_1 = require("../helpers");
+const complex_branch_1 = require("./complex-branch");
+const debug_1 = require("./debug");
+const utils_1 = require("./utils");
+/**
+ * Check ordered array
+ *
+ * @param contents
+ * @param nodes
+ * @param specs
+ * @param options
+ * @param depth
+ * @returns
+ */
+function order(contents, nodes, specs, options, depth) {
+    var _a, _b, _c, _d;
+    const orderLog = debug_1.cmLog.extend(`order#${depth}`);
+    const btLog = debug_1.cmLog.extend(`backtrack#${depth}`);
+    const patterns = (0, helpers_1.deepCopy)(contents);
+    const collection = new utils_1.Collection(nodes);
+    orderLog('Starts: %s', collection);
+    let result = undefined;
+    let backtrackMode = false;
+    let afterBacktrack = false;
+    const unmatchedResults = [];
+    while (patterns.length) {
+        result = (0, complex_branch_1.complexBranch)(patterns[0], collection.unmatched, specs, options, depth);
+        collection.addMatched(result.matched);
+        orderLog('stack: %s', collection);
+        if (result.type !== 'UNEXPECTED_EXTRA_NODE' && result.type !== 'MATCHED' && result.type !== 'MATCHED_ZERO') {
+            unmatchedResults.push(result);
+            if (backtrackMode) {
+                collection.back();
+                btLog('🔙');
+                backtrackMode = false;
+                afterBacktrack = true;
+                continue;
+            }
+            orderLog('conformed (%s): %s', result.type, collection.toString(true));
+            const barelyMatchedResult = unmatchedResults.sort((a, b) => b.matched.length - a.matched.length)[0];
+            if (!barelyMatchedResult) {
+                throw new Error('Unreachable code');
+            }
+            return {
+                type: barelyMatchedResult.type,
+                matched: collection.matched,
+                unmatched: collection.unmatched,
+                zeroMatch: barelyMatchedResult.zeroMatch,
+                query: barelyMatchedResult.query,
+                hint: barelyMatchedResult.hint,
+            };
+        }
+        if (afterBacktrack) {
+            collection.lock();
+            afterBacktrack = false;
+        }
+        if (result.zeroMatch) {
+            backtrackMode = true;
+        }
+        else {
+            backtrackMode = false;
+        }
+        patterns.shift();
+    }
+    if (collection.unmatched.length) {
+        orderLog('Conformed (UNEXPECTED_EXTRA_NODE): %s', collection.toString(true));
+        return {
+            type: 'UNEXPECTED_EXTRA_NODE',
+            matched: collection.matched,
+            unmatched: collection.unmatched,
+            zeroMatch: false,
+            query: (_a = result === null || result === void 0 ? void 0 : result.query) !== null && _a !== void 0 ? _a : 'N/A',
+            hint: (_b = result === null || result === void 0 ? void 0 : result.hint) !== null && _b !== void 0 ? _b : {},
+        };
+    }
+    orderLog('Conformed: %s', collection);
+    return {
+        type: collection.matched.length ? 'MATCHED' : 'MATCHED_ZERO',
+        matched: collection.matched,
+        unmatched: collection.unmatched,
+        zeroMatch: false,
+        query: (_c = result === null || result === void 0 ? void 0 : result.query) !== null && _c !== void 0 ? _c : 'N/A',
+        hint: (_d = result === null || result === void 0 ? void 0 : result.hint) !== null && _d !== void 0 ? _d : {},
+    };
+}
+exports.order = order;

package/lib/permitted-contents/recursive-branch.d.ts

@@ -0,0 +1,4 @@
+import type { SelectorResult } from './matches-selector';
+import type { ChildNode, Options, Specs } from './types';
+import type { PermittedContentPattern, Model } from '@markuplint/ml-spec';
+export declare function recursiveBranch(model: Model | PermittedContentPattern[], nodes: readonly ChildNode[], specs: Specs, options: Options, depth: number): SelectorResult;

package/lib/permitted-contents/recursive-branch.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recursiveBranch = void 0;
+const matches_selector_1 = require("./matches-selector");
+const order_1 = require("./order");
+const utils_1 = require("./utils");
+function recursiveBranch(model, nodes, specs, options, depth) {
+    if (!(0, utils_1.isModel)(model)) {
+        return (0, order_1.order)(model, nodes, specs, options, depth + 1);
+    }
+    if (typeof model === 'string') {
+        return (0, matches_selector_1.matchesSelector)(model, nodes[0], specs, options, depth);
+    }
+    const collection = new utils_1.Collection(nodes);
+    let lastUnmatched = null;
+    for (const query of model) {
+        const result = (0, matches_selector_1.matchesSelector)(query, collection.unmatched[0], specs, options, depth);
+        collection.addMatched(result.matched);
+        if (result.type === 'MATCHED' || result.type === 'MATCHED_ZERO') {
+            return {
+                type: result.type,
+                matched: collection.matched,
+                unmatched: collection.unmatched,
+                zeroMatch: result.zeroMatch,
+                query: result.query,
+                hint: result.hint,
+            };
+        }
+        lastUnmatched = {
+            type: result.type,
+            matched: collection.matched,
+            unmatched: collection.unmatched,
+            zeroMatch: result.zeroMatch,
+            query: result.query,
+            hint: result.hint,
+        };
+    }
+    if (!lastUnmatched) {
+        throw new Error('Unreachable code');
+    }
+    return lastUnmatched;
+}
+exports.recursiveBranch = recursiveBranch;

package/lib/permitted-contents/represent-transparent-nodes.d.ts

@@ -0,0 +1,6 @@
+import type { ChildNode, Options, Result, Specs } from './types';
+export declare const transparentMode: Map<import("packages/@markuplint/ml-core/lib/ml-dom/node/child-node").MLChildNode<import("./types").TagRule[], Options>, true>;
+export declare function representTransparentNodes(nodes: ChildNode[], specs: Specs, options: Options): {
+    nodes: ChildNode[];
+    errors: Result[];
+};

package/lib/permitted-contents/represent-transparent-nodes.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.representTransparentNodes = exports.transparentMode = void 0;
+const ml_spec_1 = require("@markuplint/ml-spec");
+const order_1 = require("./order");
+const utils_1 = require("./utils");
+exports.transparentMode = new Map();
+function representTransparentNodes(nodes, specs, options) {
+    var _a;
+    const result = [];
+    const errors = [];
+    const parent = (_a = nodes[0]) === null || _a === void 0 ? void 0 : _a.parentElement;
+    if (parent) {
+        const { errors: parentErrors } = representTransparentNodes([parent], specs, options);
+        errors.push(...parentErrors);
+        // if (!Array.isArray(parentRes)) {
+        // 	return parentRes;
+        // }
+    }
+    for (const node of nodes) {
+        if (!node.is(node.ELEMENT_NODE)) {
+            result.push(node);
+            continue;
+        }
+        const models = (0, ml_spec_1.getContentModel)(node, specs.specs);
+        if (models == null || typeof models === 'boolean') {
+            result.push(node);
+            continue;
+        }
+        const noTransparentModels = models.filter(m => !(0, utils_1.isTransparent)(m));
+        if (noTransparentModels.length === models.length) {
+            result.push(node);
+            continue;
+        }
+        const collection = new utils_1.Collection((0, utils_1.getChildNodesWithoutWhitespaces)(node));
+        let unmatched;
+        if (noTransparentModels.length) {
+            const result = (0, order_1.order)(noTransparentModels, collection.unmatched, specs, options, Infinity);
+            unmatched = result.unmatched;
+        }
+        else {
+            unmatched = collection.unmatched;
+        }
+        const transparent = models.find(m => (0, utils_1.isTransparent)(m));
+        if (!transparent || !(0, utils_1.isTransparent)(transparent)) {
+            throw new Error('Unreachable code');
+        }
+        for (const _child of unmatched) {
+            const child = _child;
+            if (exports.transparentMode.has(child)) {
+                continue;
+            }
+            exports.transparentMode.set(child, true);
+            if (child.is(child.ELEMENT_NODE)) {
+                const transparentCondMatched = (0, utils_1.matches)(transparent.transparent, child, specs);
+                if (!transparentCondMatched.matched) {
+                    errors.push({
+                        type: 'TRANSPARENT_MODEL_DISALLOWS',
+                        matched: [],
+                        unmatched: [node],
+                        zeroMatch: false,
+                        query: transparent.transparent,
+                        hint: {
+                            not: transparentCondMatched.not,
+                            transparent: node,
+                        },
+                    });
+                    continue;
+                }
+            }
+            result.push(child);
+        }
+    }
+    return {
+        nodes: result,
+        errors,
+    };
+}
+exports.representTransparentNodes = representTransparentNodes;

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

@@ -0,0 +1,12 @@
+import type { ContentModelResult, Element, Options, Specs } from './types';
+import type { ContentModel } from '@markuplint/ml-spec';
+/**
+ * Check start
+ *
+ * @param contents
+ * @param el
+ * @param specs
+ * @param options
+ * @returns
+ */
+export declare function start(contents: ContentModel['contents'], el: Element, specs: Specs, options: Options): ContentModelResult[];

package/lib/permitted-contents/start.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.start = void 0;
+const order_1 = require("./order");
+const represent_transparent_nodes_1 = require("./represent-transparent-nodes");
+const utils_1 = require("./utils");
+/**
+ * Check start
+ *
+ * @param contents
+ * @param el
+ * @param specs
+ * @param options
+ * @returns
+ */
+function start(contents, el, specs, options) {
+    var _a;
+    if (contents === false) {
+        if (el.childNodes.length) {
+            return [
+                {
+                    type: 'VOID_ELEMENT',
+                    scope: el,
+                    query: ':not(*)',
+                    hint: {},
+                },
+            ];
+        }
+        return [
+            {
+                type: 'MATCHED',
+                scope: el,
+                query: '*',
+                hint: {},
+            },
+        ];
+    }
+    if (contents === true) {
+        // Allows all elements
+        return [
+            {
+                type: 'MATCHED',
+                scope: el,
+                query: '*',
+                hint: {},
+            },
+        ];
+    }
+    const { nodes, errors } = (0, represent_transparent_nodes_1.representTransparentNodes)((0, utils_1.getChildNodesWithoutWhitespaces)(el), specs, options);
+    const result = (0, order_1.order)(contents, nodes, specs, options, 0);
+    return [
+        {
+            type: result.type,
+            scope: result.type === 'MISSING_NODE_REQUIRED' || result.type === 'MISSING_NODE_ONE_OR_MORE'
+                ? el
+                : (_a = result.unmatched[0]) !== null && _a !== void 0 ? _a : el,
+            query: result.query,
+            hint: result.hint,
+        },
+        ...errors.map(error => {
+            var _a;
+            return ({
+                type: error.type,
+                scope: (_a = error.unmatched[0]) !== null && _a !== void 0 ? _a : el,
+                query: error.query,
+                hint: error.hint,
+            });
+        }),
+    ];
+}
+exports.start = start;

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

@@ -0,0 +1,2 @@
+import type { ChildNode, Options, Result, Specs } from './types';
+export declare function transparent(nodes: ChildNode[], specs: Specs, options: Options, depth: number): Result;

package/lib/permitted-contents/transparent.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transparent = void 0;
+const count_pattern_1 = require("./count-pattern");
+const debug_1 = require("./debug");
+const utils_1 = require("./utils");
+const transparentLog = debug_1.cmLog.extend('transparent');
+function transparent(nodes, specs, options, depth) {
+    var _a;
+    if (nodes.length === 0 || ((_a = nodes[0].parentElement) === null || _a === void 0 ? void 0 : _a.parentElement)) {
+        transparentLog('Skipped');
+        return {
+            type: nodes.length === 0 ? 'MATCHED_ZERO' : 'MATCHED',
+            matched: nodes.slice(),
+            unmatched: [],
+            zeroMatch: nodes.length === 0,
+            query: 'transparent',
+            hint: {},
+        };
+    }
+    transparentLog('Transparent model element is component root');
+    const collection = new utils_1.Collection(nodes);
+    const result = (0, count_pattern_1.countPattern)({ zeroOrMore: ':model(flow)' }, collection.unmatched, specs, options, depth);
+    collection.addMatched(result.matched);
+    return {
+        type: result.type,
+        matched: collection.matched,
+        unmatched: collection.unmatched,
+        zeroMatch: result.zeroMatch,
+        query: result.query,
+        hint: result.hint,
+    };
+}
+exports.transparent = transparent;

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

@@ -0,0 +1,45 @@
+import type { Element as _Element } from '@markuplint/ml-core';
+import type { ContentModel, MLMLSpec } from '@markuplint/ml-spec';
+export declare type Element = _Element<TagRule[], Options>;
+export declare type ChildNode = Element['childNodes'][0];
+export declare type Specs = {
+    cites: MLMLSpec['cites'];
+    def: MLMLSpec['def'];
+    specs: {
+        name: string;
+        contentModel: {
+            contents: MLMLSpec['specs'][0]['contentModel']['contents'];
+        };
+    }[];
+};
+export declare type ContentModelResult = {
+    type: MatchedReason | UnmatchedReason;
+    scope: ChildNode;
+    query: Result['query'];
+    hint: Result['hint'];
+};
+export declare type Result<T extends string = MatchedReason> = {
+    type: MatchedReason | UnmatchedReason | T;
+    matched: ChildNode[];
+    unmatched: ChildNode[];
+    zeroMatch: boolean;
+    query: string;
+    hint: {
+        max?: number;
+        not?: ChildNode;
+        transparent?: Element;
+    };
+};
+export declare type MatchedReason = 'MATCHED' | 'MATCHED_ZERO';
+export declare type UnmatchedReason = 'VOID_ELEMENT' | 'UNEXPECTED_EXTRA_NODE' | 'TRANSPARENT_MODEL_DISALLOWS' | MissingNodeReason;
+export declare type MissingNodeReason = 'MISSING_NODE_REQUIRED' | 'MISSING_NODE_ONE_OR_MORE';
+export declare type TransparentModel = {
+    el: Element;
+    additionalCondition: string;
+};
+export declare type TagRule = {
+    tag: string;
+} & ContentModel;
+export declare type Options = {
+    ignoreHasMutableChildren: boolean;
+};

package/lib/permitted-contents/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,32 @@
+import type { ChildNode, Element, Specs } from './types';
+import type { PermittedContentPattern, PermittedContentChoice, PermittedContentOneOrMore, PermittedContentOptional, PermittedContentRequire, PermittedContentTransparent, PermittedContentZeroOrMore, Model } from '@markuplint/ml-spec';
+export declare function getChildNodesWithoutWhitespaces(el: Element): ChildNode[];
+export declare function isModel(model: Model | PermittedContentPattern[]): model is Model;
+export declare function matches(selector: string, node: ChildNode, specs: Specs): {
+    matched: boolean;
+    not?: undefined;
+} | {
+    matched: boolean;
+    not: import("packages/@markuplint/ml-core/lib/ml-dom/node/child-node").MLChildNode<import("./types").TagRule[], import("./types").Options> | undefined;
+};
+export declare function isRequire(content: PermittedContentPattern): content is PermittedContentRequire;
+export declare function isOptional(content: PermittedContentPattern): content is PermittedContentOptional;
+export declare function isOneOrMore(content: PermittedContentPattern): content is PermittedContentOneOrMore;
+export declare function isZeroOrMore(content: PermittedContentPattern): content is PermittedContentZeroOrMore;
+export declare function isChoice(content: PermittedContentPattern): content is PermittedContentChoice;
+export declare function isTransparent(content: PermittedContentPattern): content is PermittedContentTransparent;
+export declare class Collection {
+    #private;
+    constructor(origin: readonly ChildNode[]);
+    get matched(): import("packages/@markuplint/ml-core/lib/ml-dom/node/child-node").MLChildNode<import("./types").TagRule[], import("./types").Options>[];
+    get matchedCount(): number;
+    get nodes(): import("packages/@markuplint/ml-core/lib/ml-dom/node/child-node").MLChildNode<import("./types").TagRule[], import("./types").Options>[];
+    get unmatched(): import("packages/@markuplint/ml-core/lib/ml-dom/node/child-node").MLChildNode<import("./types").TagRule[], import("./types").Options>[];
+    addMatched(nodes: ChildNode[]): boolean;
+    back(): void;
+    lock(): void;
+    max(max: number): void;
+    toString(highlightExtraNodes?: boolean): string;
+}
+export declare class UnsupportedError extends Error {
+}