@markuplint/rules 2.4.8 → 2.4.9-canary.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "2.4.8",
+	"version": "2.4.9-canary.2+353c7e93",
 	"description": "Rules for markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -17,10 +17,10 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "2.9.1",
-		"@markuplint/ml-core": "2.3.6",
-		"@markuplint/ml-spec": "2.1.2",
-		"@markuplint/types": "2.2.1",
+		"@markuplint/html-spec": "2.9.2-canary.4+353c7e93",
+		"@markuplint/ml-core": "2.3.7-canary.4+353c7e93",
+		"@markuplint/ml-spec": "2.1.3-canary.4+353c7e93",
+		"@markuplint/types": "2.2.2-canary.4+353c7e93",
 		"debug": "^4.3.4",
 		"html-entities": "^2.3.3",
 		"tslib": "^2.3.1"
@@ -28,5 +28,5 @@
 	"devDependencies": {
 		"@types/debug": "^4.1.7"
 	},
-	"gitHead": "1f386374019d83312e9be45819662f594b8bd481"
+	"gitHead": "353c7e9360a16203b79539b2f5ffeca03ddc3e9e"
 }

package/lib/label-has-control/index.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
-export default _default;

package/lib/label-has-control/index.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ml_core_1 = require("@markuplint/ml-core");
-const controlSelector = ["input:not([type='hidden' i])", 'select', 'textarea'].join(',');
-exports.default = (0, ml_core_1.createRule)({
-    defaultSeverity: 'warning',
-    async verify({ document, report, t }) {
-        await document.walkOn('Element', el => {
-            if (el.localName !== 'label') {
-                return;
-            }
-            if (el.children.length === 0 && !el.hasAttribute('for')) {
-                report({
-                    scope: el,
-                    message: t('{0} should associate with {1}', t('The "{0*}" {1}', 'label', 'element'), t('a {0}', 'control')),
-                });
-            }
-            const controls = el.querySelectorAll(controlSelector);
-            const secondControl = controls[1];
-            if (secondControl) {
-                report({
-                    scope: secondControl,
-                    message: t('{0} associates only {1}', t('The "{0*}" {1}', 'label', 'element'), t('first {0}', 'control')),
-                });
-            }
-        });
-    },
-});

package/lib/no-empty-palpable-content/index.d.ts

@@ -1,6 +0,0 @@
-type Options = {
-    extendsExposableElements?: boolean;
-    ignoreIfAriaBusy?: boolean;
-};
-declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, Options>;
-export default _default;

package/lib/no-empty-palpable-content/index.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ml_core_1 = require("@markuplint/ml-core");
-const ml_spec_1 = require("@markuplint/ml-spec");
-exports.default = (0, ml_core_1.createRule)({
-    defaultSeverity: 'warning',
-    defaultOptions: {
-        extendsExposableElements: true,
-        ignoreIfAriaBusy: true,
-    },
-    async verify({ document, report, t }) {
-        await document.walkOn('Element', el => {
-            if (!(0, ml_spec_1.isPalpableElement)(el, el.ownerMLDocument.specs, {
-                extendsSvg: false,
-                extendsExposableElements: el.rule.option.extendsExposableElements,
-            })) {
-                return;
-            }
-            if ((0, ml_spec_1.isVoidElement)(el)) {
-                return;
-            }
-            if (el.rule.option.ignoreIfAriaBusy && el.getAttribute('aria-busy') === 'true') {
-                return;
-            }
-            const isEmpty = Array.from(el.childNodes).every(node => node.is(node.TEXT_NODE) && node.isWhitespace());
-            if (isEmpty) {
-                report({
-                    scope: el,
-                    message: t('{0} should not {1}', t('the {0}', 'element'), 'empty'),
-                });
-            }
-        });
-    },
-});

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

@@ -1,3 +0,0 @@
-import type { ChildNode, Options, Result, Specs } from './types';
-import type { PermittedContentChoice } from '@markuplint/ml-spec';
-export declare function choice(pattern: PermittedContentChoice, elements: ChildNode[], specs: Specs, options: Options, depth: number): Result;

package/lib/permitted-contents/choice.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.choice = void 0;
-const order_1 = require("./order");
-const utils_1 = require("./utils");
-function choice(pattern, elements, specs, options, depth) {
-    const collection = new utils_1.Collection(elements);
-    const unmatchedResults = [];
-    for (const some of pattern.choice) {
-        const result = (0, order_1.order)(some, collection.unmatched, specs, options, depth + 1);
-        if (result.type === 'UNEXPECTED_EXTRA_NODE' || result.type === 'MATCHED' || result.type === 'MATCHED_ZERO') {
-            collection.addMatched(result.matched);
-            return {
-                type: result.type,
-                matched: collection.matched,
-                unmatched: collection.unmatched,
-                zeroMatch: result.zeroMatch,
-                query: result.query,
-                hint: result.hint,
-            };
-        }
-        unmatchedResults.push(result);
-    }
-    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,
-    };
-}
-exports.choice = choice;

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

@@ -1,13 +0,0 @@
-import type { ChildNode, Options, Result, Specs } from './types';
-import type { PermittedContentPattern } from '@markuplint/ml-spec';
-/**
- * Check content condition
- *
- * @param pattern
- * @param elements
- * @param specs
- * @param options
- * @param depth
- * @returns
- */
-export declare function complexBranch(pattern: PermittedContentPattern, elements: ChildNode[], specs: Specs, options: Options, depth: number): Result;

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

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.complexBranch = void 0;
-const choice_1 = require("./choice");
-const count_pattern_1 = require("./count-pattern");
-const transparent_1 = require("./transparent");
-const utils_1 = require("./utils");
-/**
- * Check content condition
- *
- * @param pattern
- * @param elements
- * @param specs
- * @param options
- * @param depth
- * @returns
- */
-function complexBranch(pattern, elements, specs, options, depth) {
-    if ((0, utils_1.isChoice)(pattern)) {
-        return (0, choice_1.choice)(pattern, elements, specs, options, depth);
-    }
-    if ((0, utils_1.isTransparent)(pattern)) {
-        return (0, transparent_1.transparent)(elements, specs, options, depth);
-    }
-    return (0, count_pattern_1.countPattern)(pattern, elements, specs, options, depth);
-}
-exports.complexBranch = complexBranch;

package/lib/permitted-contents/content-model.d.ts

@@ -1,2 +0,0 @@
-import type { ContentModelResult, Element, Options, TagRule } from './types';
-export declare function contentModel(el: Element, rules: TagRule[], options: Options): ContentModelResult[];

package/lib/permitted-contents/content-model.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.contentModel = void 0;
-const ml_spec_1 = require("@markuplint/ml-spec");
-const start_1 = require("./start");
-function contentModel(el, rules, options) {
-    const model = createModel(el, rules);
-    if (model == null) {
-        return [
-            {
-                type: 'MATCHED',
-                scope: el,
-                query: '*',
-                hint: {},
-            },
-        ];
-    }
-    const result = (0, start_1.start)(model, el, el.ownerMLDocument.specs, options);
-    return result;
-}
-exports.contentModel = contentModel;
-function createModel(el, rules) {
-    const specs = cachedSpecs(el.ownerMLDocument.specs, rules);
-    const model = (0, ml_spec_1.getContentModel)(el, specs.specs);
-    return model;
-}
-const caches = new Map();
-function cachedSpecs(specs, rules) {
-    if (!rules.length) {
-        return specs;
-    }
-    const key = JSON.stringify(rules);
-    const cached = caches.get(key);
-    if (cached) {
-        return cached;
-    }
-    const merged = {
-        ...specs,
-        specs: [
-            ...specs.specs,
-            ...rules.map(tag => ({
-                name: tag.tag,
-                contentModel: tag,
-            })),
-        ],
-    };
-    caches.set(key, merged);
-    return merged;
-}

package/lib/permitted-contents/count-pattern.d.ts

@@ -1,13 +0,0 @@
-import type { ChildNode, Options, Result, Specs } from './types';
-import type { PermittedContentOneOrMore, PermittedContentOptional, PermittedContentRequire, PermittedContentZeroOrMore } from '@markuplint/ml-spec';
-/**
- * Check count
- *
- * @param pattern
- * @param elements
- * @param specs
- * @param options
- * @param depth
- * @returns
- */
-export declare function countPattern(pattern: PermittedContentOneOrMore | PermittedContentOptional | PermittedContentRequire | PermittedContentZeroOrMore, elements: readonly ChildNode[], specs: Specs, options: Options, depth: number): Result;

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

@@ -1,155 +0,0 @@
-"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

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

package/lib/permitted-contents/debug.js

@@ -1,5 +0,0 @@
-"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/matches-selector.d.ts

@@ -1,3 +0,0 @@
-import type { ChildNode, Options, Result, Specs } from './types';
-export 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;

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

@@ -1,185 +0,0 @@
-"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

@@ -1,13 +0,0 @@
-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;