@markuplint/rules 3.0.0-alpha.66 → 3.0.0-rc.0

package/lib/invalid-attr/index.d.ts

@@ -1,9 +1,10 @@
 import type { AttributeType } from '@markuplint/ml-spec';
-declare type Option = {
+type Option = {
     attrs?: Record<string, Rule>;
     ignoreAttrNamePrefix?: string | string[];
+    allowToAddPropertiesForPretender?: boolean;
 };
-declare type Rule = {
+type Rule = {
     enum: [string, ...string[]];
 } | {
     pattern: string;

package/lib/invalid-attr/index.js

@@ -9,14 +9,16 @@ exports.default = (0, ml_core_1.createRule)({
     defaultOptions: {},
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            // Default
+            const allowToAddPropertiesForPretender = (_a = attr.rule.option.allowToAddPropertiesForPretender) !== null && _a !== void 0 ? _a : true;
             if (attr.isDirective) {
                 return;
             }
             const attrSpecs = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
             const attrName = attr.nameNode;
             const name = attr.name;
-            if (!attr.ownerElement.isCustomElement && attr.candidate) {
+            if (attr.ownerElement.elementType === 'html' && attr.candidate) {
                 const message = t('{0} is {1:c}', t('the "{0*}" {1}', name, 'attribute'), 'disallowed') +
                     t('. ') +
                     t('Did you mean "{0}"?', attr.candidate);
@@ -69,7 +71,7 @@ exports.default = (0, ml_core_1.createRule)({
                     };
                 }
             }
-            else if (!attr.ownerElement.isCustomElement && attrSpecs) {
+            else if (attr.ownerElement.elementType === 'html' && attrSpecs) {
                 log('Checking %s[%s="%s"]', attr.nodeName, name, value);
                 invalid = (0, helpers_1.isValidAttr)(t, name, value, attr.isDynamicValue || false, attr.ownerElement, attrSpecs, log);
             }
@@ -82,16 +84,19 @@ exports.default = (0, ml_core_1.createRule)({
                         report({
                             scope: attr,
                             message: invalid.message,
-                            line: ((_a = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startLine) !== null && _a !== void 0 ? _a : 0) + ((_c = (_b = invalid.loc) === null || _b === void 0 ? void 0 : _b.line) !== null && _c !== void 0 ? _c : 0),
-                            col: ((_d = invalid.loc) === null || _d === void 0 ? void 0 : _d.line)
-                                ? ((_e = invalid.loc) === null || _e === void 0 ? void 0 : _e.col) + 1
-                                : ((_f = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startCol) !== null && _f !== void 0 ? _f : 0) + ((_h = (_g = invalid.loc) === null || _g === void 0 ? void 0 : _g.col) !== null && _h !== void 0 ? _h : 0),
-                            raw: (_k = (_j = invalid.loc) === null || _j === void 0 ? void 0 : _j.raw) !== null && _k !== void 0 ? _k : value,
+                            line: ((_b = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startLine) !== null && _b !== void 0 ? _b : 0) + ((_d = (_c = invalid.loc) === null || _c === void 0 ? void 0 : _c.line) !== null && _d !== void 0 ? _d : 0),
+                            col: ((_e = invalid.loc) === null || _e === void 0 ? void 0 : _e.line)
+                                ? ((_f = invalid.loc) === null || _f === void 0 ? void 0 : _f.col) + 1
+                                : ((_g = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startCol) !== null && _g !== void 0 ? _g : 0) + ((_j = (_h = invalid.loc) === null || _h === void 0 ? void 0 : _h.col) !== null && _j !== void 0 ? _j : 0),
+                            raw: (_l = (_k = invalid.loc) === null || _k === void 0 ? void 0 : _k.raw) !== null && _l !== void 0 ? _l : value,
                         });
                         break;
                     }
                     case 'non-existent': {
-                        const spec = (0, ml_core_1.getSpec)(attr.ownerElement, document.specs);
+                        if (allowToAddPropertiesForPretender && ((_m = attr.ownerElement.pretenderContext) === null || _m === void 0 ? void 0 : _m.type) === 'origin') {
+                            return;
+                        }
+                        const spec = (0, ml_core_1.getSpec)(attr.ownerElement, document.specs.specs);
                         if (spec === null || spec === void 0 ? void 0 : spec.possibleToAddProperties) {
                             return;
                         }

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

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

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

@@ -0,0 +1,28 @@
+"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/landmark-roles/index.d.ts

@@ -1,8 +1,8 @@
-declare type Options = {
+type Options = {
     ignoreRoles: Roles[];
     labelEachArea: boolean;
 };
-declare type TopLevelRoles = 'banner' | 'main' | 'complementary' | 'contentinfo';
-declare type Roles = TopLevelRoles | 'form' | 'navigation' | 'region';
+type TopLevelRoles = 'banner' | 'main' | 'complementary' | 'contentinfo';
+type Roles = TopLevelRoles | 'form' | 'navigation' | 'region';
 declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, Options>;
 export default _default;

package/lib/landmark-roles/index.js

@@ -12,7 +12,7 @@ const selectors = {
 };
 const topLevelRoles = ['banner', 'main', 'complementary', 'contentinfo'];
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     defaultOptions: {
         ignoreRoles: [],
         labelEachArea: true,

package/lib/no-boolean-attr-value/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             var _a, _b;

package/lib/no-default-value/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 const helpers_1 = require("../helpers");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             var _a, _b, _c;

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

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

@@ -0,0 +1,34 @@
+"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/no-hard-code-id/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         if (!document.isFragment) {
             return;

package/lib/no-use-event-handler-attr/index.d.ts

@@ -1,4 +1,4 @@
-declare type Options = {
+type Options = {
     ignore?: string | string[];
 };
 declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, Options>;

package/lib/no-use-event-handler-attr/index.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 const helpers_1 = require("../helpers");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     defaultOptions: {},
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
-            if (attr.ownerElement.isCustomElement) {
+            if (attr.ownerElement.elementType !== 'html') {
                 return;
             }
             const ignoreList = Array.isArray(attr.rule.option.ignore)

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

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

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

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

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

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

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

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

@@ -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;