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

package/lib/permitted-contents/utils.js

@@ -0,0 +1,184 @@
+"use strict";
+var _Collection_locked, _Collection_matched, _Collection_nodes, _Collection_origin;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnsupportedError = exports.Collection = exports.isTransparent = exports.isChoice = exports.isZeroOrMore = exports.isOneOrMore = exports.isOptional = exports.isRequire = exports.matches = exports.isModel = exports.getChildNodesWithoutWhitespaces = void 0;
+const tslib_1 = require("tslib");
+const selector_1 = require("@markuplint/selector");
+const ansi_colors_1 = require("ansi-colors");
+const represent_transparent_nodes_1 = require("./represent-transparent-nodes");
+const getChildNodesWithoutWhitespacesCaches = new Map();
+function getChildNodesWithoutWhitespaces(el) {
+    let nodes = getChildNodesWithoutWhitespacesCaches.get(el);
+    if (nodes) {
+        return nodes;
+    }
+    nodes = Array.from(el.childNodes).filter(node => {
+        return !(node.is(node.TEXT_NODE) && node.isWhitespace());
+    });
+    getChildNodesWithoutWhitespacesCaches.set(el, nodes);
+    return nodes;
+}
+exports.getChildNodesWithoutWhitespaces = getChildNodesWithoutWhitespaces;
+function isModel(model) {
+    if (typeof model === 'string') {
+        return true;
+    }
+    let modelMode = false;
+    for (const m of model) {
+        if (typeof m === 'string') {
+            modelMode = true;
+            continue;
+        }
+        if (modelMode) {
+            throw new TypeError(`Invalid schema: ${JSON.stringify(model)}`);
+        }
+    }
+    return modelMode;
+}
+exports.isModel = isModel;
+function matches(selector, node, specs) {
+    const selectorResult = (0, selector_1.createSelector)(selector, specs).search(node);
+    const matched = selectorResult.filter((r) => r.matched);
+    if (matched.length) {
+        return {
+            matched: true,
+        };
+    }
+    const not = selectorResult
+        .map(r => { var _a; return (r.matched ? [] : (_a = r.not) !== null && _a !== void 0 ? _a : []); })
+        .flat()
+        .map(descendants)
+        .flat()
+        .shift();
+    return {
+        matched: false,
+        not,
+    };
+}
+exports.matches = matches;
+function descendants(selectorResult) {
+    let nodes = selectorResult.nodes.slice();
+    while (selectorResult.has.length) {
+        for (const dep of selectorResult.has) {
+            if (!dep.has.length) {
+                nodes = dep.nodes;
+                continue;
+            }
+            selectorResult = dep;
+            continue;
+        }
+        break;
+    }
+    return nodes;
+}
+function isRequire(content) {
+    return 'require' in content;
+}
+exports.isRequire = isRequire;
+function isOptional(content) {
+    return 'optional' in content;
+}
+exports.isOptional = isOptional;
+function isOneOrMore(content) {
+    return 'oneOrMore' in content;
+}
+exports.isOneOrMore = isOneOrMore;
+function isZeroOrMore(content) {
+    return 'zeroOrMore' in content;
+}
+exports.isZeroOrMore = isZeroOrMore;
+function isChoice(content) {
+    return 'choice' in content;
+}
+exports.isChoice = isChoice;
+function isTransparent(content) {
+    return 'transparent' in content;
+}
+exports.isTransparent = isTransparent;
+class Collection {
+    constructor(origin) {
+        _Collection_locked.set(this, new Set());
+        _Collection_matched.set(this, new Set());
+        _Collection_nodes.set(this, void 0);
+        _Collection_origin.set(this, void 0);
+        tslib_1.__classPrivateFieldSet(this, _Collection_origin, origin.slice(), "f");
+        tslib_1.__classPrivateFieldSet(this, _Collection_nodes, new Set(tslib_1.__classPrivateFieldGet(this, _Collection_origin, "f")), "f");
+    }
+    get matched() {
+        return Array.from(tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f"));
+    }
+    get matchedCount() {
+        return tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f").size;
+    }
+    get nodes() {
+        return tslib_1.__classPrivateFieldGet(this, _Collection_origin, "f").slice();
+    }
+    get unmatched() {
+        return Array.from(tslib_1.__classPrivateFieldGet(this, _Collection_nodes, "f")).filter(n => !tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f").has(n));
+    }
+    addMatched(nodes) {
+        const i = tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f").size;
+        for (const node of nodes) {
+            if (!tslib_1.__classPrivateFieldGet(this, _Collection_nodes, "f").has(node)) {
+                throw new ReferenceError(`External Node: ${node.nodeName}`);
+            }
+            tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f").add(node);
+        }
+        return i < tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f").size;
+    }
+    back() {
+        tslib_1.__classPrivateFieldSet(this, _Collection_matched, new Set(tslib_1.__classPrivateFieldGet(this, _Collection_locked, "f")), "f");
+    }
+    lock() {
+        tslib_1.__classPrivateFieldSet(this, _Collection_locked, new Set(tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f")), "f");
+    }
+    max(max) {
+        const sliced = Array.from(tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f")).slice(max);
+        sliced.forEach(n => tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f").delete(n));
+    }
+    toString(highlightExtraNodes = false) {
+        const out = [];
+        for (const n of tslib_1.__classPrivateFieldGet(this, _Collection_origin, "f")) {
+            const raw = n.is(n.TEXT_NODE) ? `:text(${n.raw.replace(/\n/g, '\\n')})` : n.raw;
+            if (tslib_1.__classPrivateFieldGet(this, _Collection_locked, "f").has(n)) {
+                if (represent_transparent_nodes_1.transparentMode.has(n)) {
+                    out.push(ansi_colors_1.bgBlue.bold(raw));
+                }
+                else {
+                    out.push(ansi_colors_1.bgGreen.bold(raw));
+                }
+                continue;
+            }
+            if (tslib_1.__classPrivateFieldGet(this, _Collection_matched, "f").has(n)) {
+                if (represent_transparent_nodes_1.transparentMode.has(n)) {
+                    out.push(ansi_colors_1.blue.bold(raw));
+                }
+                else {
+                    out.push(ansi_colors_1.green.bold(raw));
+                }
+                continue;
+            }
+            if (highlightExtraNodes) {
+                if (represent_transparent_nodes_1.transparentMode.has(n)) {
+                    out.push(ansi_colors_1.bgMagenta.bold(raw));
+                }
+                else {
+                    out.push(ansi_colors_1.bgRed.bold(raw));
+                }
+                continue;
+            }
+            if (represent_transparent_nodes_1.transparentMode.has(n)) {
+                out.push((0, ansi_colors_1.cyan)(raw));
+            }
+            else {
+                out.push(raw);
+            }
+        }
+        return `[ ${out.join(', ')} ]`;
+    }
+}
+exports.Collection = Collection;
+_Collection_locked = new WeakMap(), _Collection_matched = new WeakMap(), _Collection_nodes = new WeakMap(), _Collection_origin = new WeakMap();
+class UnsupportedError extends Error {
+}
+exports.UnsupportedError = UnsupportedError;

package/lib/require-accessible-name/index.js

@@ -8,6 +8,10 @@ exports.default = (0, ml_core_1.createRule)({
     },
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
+            var _a;
+            if (((_a = el.pretenderContext) === null || _a === void 0 ? void 0 : _a.type) === 'pretender') {
+                return;
+            }
             if ((0, helpers_1.accnameMayBeMutable)(el, document)) {
                 return;
             }
@@ -19,7 +23,7 @@ exports.default = (0, ml_core_1.createRule)({
             if (!roleSpec || !roleSpec.accessibleNameRequired) {
                 return;
             }
-            const hasAccessibleName = !!el.getAccessibleName().trim();
+            const hasAccessibleName = !!el.getAccessibleName(el.rule.option.ariaVersion).trim();
             if (!hasAccessibleName) {
                 report({ scope: el, message: t('Require {0}', 'accessible name') });
             }

package/lib/required-attr/index.js

@@ -12,7 +12,7 @@ exports.default = (0, ml_core_1.createRule)({
             const customRequiredAttrs = typeof el.rule.value === 'string' ? [el.rule.value] : el.rule.value;
             const attrSpec = (0, ml_core_1.getAttrSpecs)(el, document.specs);
             const attributeSpecs = {};
-            if (attrSpec && !el.isCustomElement) {
+            if (attrSpec && el.elementType === 'html') {
                 for (const spec of attrSpec) {
                     if (spec.required || spec.requiredEither || spec.condition) {
                         attributeSpecs[spec.name] = {

package/lib/use-list/index.js

@@ -54,12 +54,12 @@ exports.default = (0, ml_core_1.createRule)({
             '+', // plus signs
         ],
     },
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Text', textNode => {
             const text = (0, helpers_1.decodeCharRef)(textNode.raw.trim());
             if (!text) {
-                // emtpy
+                // empty
                 return;
             }
             if (text.length === 1) {

package/lib/wai-aria/checkings/implicit-role.js

@@ -4,13 +4,13 @@ exports.checkingImplicitRole = void 0;
 const ml_spec_1 = require("@markuplint/ml-spec");
 const checkingImplicitRole = ({ attr }) => t => {
     var _a;
-    const implictRole = (0, ml_spec_1.getImplicitRoleName)(attr.ownerElement, attr.rule.option.version, attr.ownerMLDocument.specs);
+    const implicitRole = (0, ml_spec_1.getImplicitRoleName)(attr.ownerElement, attr.rule.option.version, attr.ownerMLDocument.specs);
     const tokens = (_a = attr.tokenList) === null || _a === void 0 ? void 0 : _a.allTokens();
     if (!tokens) {
         return;
     }
     for (const token of tokens) {
-        if (implictRole === token.raw) {
+        if (implicitRole === token.raw) {
             return {
                 scope: token,
                 message: t('{0} is {1}', t('the "{0*}" {1}', token.raw, 'role'), t('{0} of {1}', 'the implicit role', t('the "{0*}" {1}', attr.ownerElement.localName, 'element'))),

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

@@ -28,36 +28,44 @@ const checkingRequiredOwnedElements = ({ el, role }) => t => {
         return;
     }
     // TODO: Needs to resolve `aria-own`
-    if (!el.children.length) {
+    if (el.isEmpty()) {
         return {
             scope: el,
-            message: t('{0}. Or, {1}', t('Require {0} to content', t('the {0*} {1}', t(role.requiredOwnedElements), 'role')), t('require {0}', 'aria-busy="true"')),
+            message: t('{0}. Or, {1}', t('require {0}', role.requiredOwnedElements.length === 1
+                ? t('the "{0*}" {1}', role.requiredOwnedElements[0], 'role')
+                : t('the {0}', 'roles') + `: ${t(role.requiredOwnedElements)}`), t('require {0}', 'aria-busy="true"')),
         };
     }
     const children = Array.from(el.childNodes).map(child => {
         if (child.is(child.ELEMENT_NODE)) {
             const computedChild = (0, ml_spec_1.getComputedRole)(child.ownerMLDocument.specs, child, child.rule.option.version);
             if (role.requiredOwnedElements.some(ownedRole => (0, ml_spec_1.isRequiredOwnedElement)(computedChild, ownedRole, child.ownerMLDocument.specs, child.rule.option.version))) {
-                return 'REQUIRED';
+                return [child, 'REQUIRED'];
             }
-            return 'OTHER';
+            return [child, 'OTHER'];
         }
-        else if (child.MARKUPLINT_PREPROCESSOR_BLOCK) {
-            return 'PB';
+        else if (child.is(child.MARKUPLINT_PREPROCESSOR_BLOCK)) {
+            return [child, 'PB'];
         }
-        return 'NO_ELEMENT';
+        return [null, 'NO_ELEMENT'];
     });
-    if (children.includes('PB')) {
-        return {
-            scope: el,
-            message: t('{0} expects {1}', t('the "{0*}" {1}', role.name, 'role'), t(role.requiredContextRole.map(ownedRole => t('the "{0*}" {1}', ownedRole, 'role')))),
-        };
+    /**
+     * > Any element that will be owned by the element with this role.
+     * > For example, an element with the role list
+     * > **will own at least one element** with the role listitem.
+     */
+    if (children.some(([, type]) => type === 'REQUIRED')) {
+        return;
     }
-    if (!children.includes('REQUIRED')) {
-        return {
-            scope: el,
-            message: t('{0} expects {1}', t('the "{0*}" {1}', role.name, 'role'), t('the {0*} {1}', t(role.requiredOwnedElements), 'roles')),
-        };
+    if (children.some(([, type]) => type === 'PB')) {
+        // TODO: https://github.com/markuplint/markuplint/issues/490
+        return;
     }
+    return {
+        scope: el,
+        message: t('{0} expects {1}', t('the "{0*}" {1}', role.name, 'role'), role.requiredOwnedElements.length === 1
+            ? t('the "{0*}" {1}', role.requiredOwnedElements[0], 'role')
+            : t('the {0}', 'roles') + `: ${t(role.requiredOwnedElements)}`),
+    };
 };
 exports.checkingRequiredOwnedElements = checkingRequiredOwnedElements;

package/lib/wai-aria/index.js

@@ -34,7 +34,7 @@ exports.default = (0, ml_core_1.createRule)({
             const roleAttr = el.getAttributeNode('role');
             const propAttrs = el.attributes.filter(attr => /^aria-/i.test(attr.name));
             const ariaAttrs = new helpers_1.Collection(roleAttr, ...propAttrs);
-            const elSpec = (0, ml_core_1.getSpec)(el, document.specs);
+            const elSpec = (0, ml_core_1.getSpec)(el, document.specs.specs);
             if (!elSpec) {
                 return;
             }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "3.0.0-alpha.0",
+	"version": "3.0.0-alpha.2",
 	"description": "Rules for markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -17,16 +17,17 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "3.0.0-alpha.0",
-		"@markuplint/ml-core": "3.0.0-alpha.0",
-		"@markuplint/ml-spec": "3.0.0-alpha.0",
-		"@markuplint/types": "3.0.0-alpha.0",
+		"@markuplint/html-spec": "3.0.0-alpha.2",
+		"@markuplint/ml-core": "3.0.0-alpha.2",
+		"@markuplint/ml-spec": "3.0.0-alpha.2",
+		"@markuplint/types": "3.0.0-alpha.2",
+		"@ungap/structured-clone": "^1.0.1",
 		"debug": "^4.3.4",
 		"html-entities": "^2.3.3",
-		"tslib": "^2.3.1"
+		"tslib": "^2.4.0"
 	},
 	"devDependencies": {
 		"@types/debug": "^4.1.7"
 	},
-	"gitHead": "d32c522e016888e20bcbb5f09352c006b964f193"
+	"gitHead": "830bf8187b81bf5ca2f5f09b6f85a98395a58bdb"
 }