@markuplint/rules 5.5.0 → 5.6.0

package/lib/wai-aria/checkings/contradictory-aria-prop.js

@@ -50,7 +50,7 @@ export const checkingContradictoryAriaProp = ({ attr, propSpecs, attrSpecs }) =>
             }
             return {
                 scope: attr,
-                message: t('{0} contradicts {1}', t('the "{0*}" {1}', attr.name, `ARIA ${propSpec.type}`), t('the current "{0}" {1}', equivalentHtmlAttr.htmlAttrName, 'attribute')),
+                message: t('{0} contradicts {1}', t('the "{0*}" {1}', attr.name, `ARIA ${propSpec.type}`), t('the current "{0*}" {1}', equivalentHtmlAttr.htmlAttrName, 'attribute')),
             };
         }
         else if (value === 'true' &&
@@ -58,7 +58,7 @@ export const checkingContradictoryAriaProp = ({ attr, propSpecs, attrSpecs }) =>
             htmlAttrSpec?.type === 'Boolean') {
             return {
                 scope: attr,
-                message: t('{0} contradicts {1}', t('the "{0*}" {1}', attr.name, `ARIA ${propSpec.type}`), t('the implicit "{0}" {1}', equivalentHtmlAttr.htmlAttrName, 'attribute')),
+                message: t('{0} contradicts {1}', t('the "{0*}" {1}', attr.name, `ARIA ${propSpec.type}`), t('the implicit "{0*}" {1}', equivalentHtmlAttr.htmlAttrName, 'attribute')),
             };
         }
     }

package/lib/wai-aria/checkings/redundant-aria-prop.js

@@ -44,7 +44,7 @@ export const checkingRedundantAriaProp = ({ attr, propSpecs, attrSpecs }) => t =
         if ((equivalentHtmlAttr.value == null && targetAttrValue === value) || equivalentHtmlAttr.value === value) {
             return {
                 scope: attr,
-                message: t('{0} has {1}', t('the "{0*}" {1}', attr.name, `ARIA ${propSpec.type}`), t('the same {0} as {1}', 'semantics', t('{0} or {1}', t('the current "{0}" {1}', equivalentHtmlAttr.htmlAttrName, 'attribute'), t('the implicit "{0}" {1}', equivalentHtmlAttr.htmlAttrName, 'attribute')))),
+                message: t('{0} has {1}', t('the "{0*}" {1}', attr.name, `ARIA ${propSpec.type}`), t('the same {0} as {1}', 'semantics', t('{0} or {1}', t('the current "{0*}" {1}', equivalentHtmlAttr.htmlAttrName, 'attribute'), t('the implicit "{0*}" {1}', equivalentHtmlAttr.htmlAttrName, 'attribute')))),
             };
         }
     }

package/lib/wai-aria/checkings/required-accessibility-parent-role.js

@@ -1,4 +1,5 @@
 import { ARIA_RECOMMENDED_VERSION, ariaSpecs } from '@markuplint/ml-spec';
+import { noTranslate } from '../../no-translate.js';
 /**
  * Checks whether an element with an explicit role satisfies its
  * "Required Accessibility Parent Role" (called "Required Context Role" in ARIA 1.2).
@@ -50,7 +51,7 @@ export const checkingRequiredAccessibilityParentRole = ({ el, computed }) => t =
                 message: t('{0} requires {1}', t('the "{0*}" {1}', roleSpec.name, 'role'), parentRoles.length === 1 && parentRoles[0]
                     ? t('an accessibility parent with the "{0*}" {1}', parentRoles[0], 'role')
                     : t('an accessibility parent with one of the {0}', 'roles') +
-                        `: ${t(parentRoles)}`),
+                        `: ${t(parentRoles.map(noTranslate))}`),
             };
         }
     }

package/lib/wai-aria/checkings/required-owned-elements.d.ts

@@ -11,6 +11,8 @@ import type { ARIARole } from '@markuplint/ml-spec';
  * preprocessor blocks, and mutable children from template engines.
  * For a pretended component, the owned elements are the ones the component renders
  * itself (`contents`) together with the children given to it, not the usage site alone.
+ * For a shadow host, they are the elements of its declarative shadow root, which is
+ * rendered in place of its light children (see `getOwnedChildNodes`).
  *
  * @see https://w3c.github.io/aria/#mustContain
  * @param el - The element node to inspect for allowed accessibility child roles.

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

@@ -1,5 +1,6 @@
-import { ARIA_RECOMMENDED_VERSION, getComputedRole, isRequiredOwnedElement, isTransparentForOwnership, } from '@markuplint/ml-spec';
+import { ARIA_RECOMMENDED_VERSION, getComposedParentElement, getComputedRole, isRequiredOwnedElement, isSlotElement, isTransparentForOwnership, } from '@markuplint/ml-spec';
 import { expandChildren, isContentMutable } from '../../permitted-contents/slot-content.js';
+import { noTranslate } from '../../no-translate.js';
 /**
  * Checks whether an element with a role that has "Allowed Accessibility Child Roles"
  * (called "Required Owned Elements" in ARIA 1.2) actually contains children
@@ -10,6 +11,8 @@ import { expandChildren, isContentMutable } from '../../permitted-contents/slot-
  * preprocessor blocks, and mutable children from template engines.
  * For a pretended component, the owned elements are the ones the component renders
  * itself (`contents`) together with the children given to it, not the usage site alone.
+ * For a shadow host, they are the elements of its declarative shadow root, which is
+ * rendered in place of its light children (see `getOwnedChildNodes`).
  *
  * @see https://w3c.github.io/aria/#mustContain
  * @param el - The element node to inspect for allowed accessibility child roles.
@@ -37,10 +40,12 @@ export const checkingRequiredOwnedElements = ({ el, role }) => t => {
         return;
     }
     // TODO: Needs to resolve `aria-owns` references to include virtually owned elements.
-    // Currently, only DOM-tree children are checked. Elements referenced via `aria-owns`
-    // should also be considered as owned elements per the ARIA specification.
+    // Currently, only the child nodes (those of the shadow root for a shadow host) are checked.
+    // Elements referenced via `aria-owns` should also be considered as owned elements per the
+    // ARIA specification.
     const ariaVersion = el.rule.options?.version ?? el.ownerMLDocument.ruleCommonSettings?.ariaVersion ?? ARIA_RECOMMENDED_VERSION;
-    const children = classifyChildren(el, role, ariaVersion);
+    const ownedChildNodes = getOwnedChildNodes(el);
+    const children = classifyChildren(el, ownedChildNodes, role, ariaVersion);
     if (children.some(([, type]) => type === 'BUSY' || type === 'UNKNOWN')) {
         return;
     }
@@ -71,30 +76,30 @@ export const checkingRequiredOwnedElements = ({ el, role }) => t => {
      */
     // A virtual slot wrapper stands for the component, whose nodes are the ones given to it.
     const component = el.pretenderContext?.type === 'origin' ? el.pretenderContext.origin : el;
-    if (component.hasMutableChildren(true) || isContentMutable(component, 'pretended')) {
+    if (isOwnedContentMutable(component)) {
         return;
     }
-    if (mayBeBeforeCreated(getOwnedChildNodes(el) ?? [])) {
+    if (mayBeBeforeCreated(ownedChildNodes ?? [])) {
         return {
             scope: component,
             message: t('{0}. Or, {1}', t('{0} requires {1}', t('the {0}', 'child element'), role.allowedAccessibilityChildRoles.length === 1 && role.allowedAccessibilityChildRoles[0]
                 ? t('the "{0*}" {1}', role.allowedAccessibilityChildRoles[0], 'role')
-                : t('the {0}', 'roles') + `: ${t(role.allowedAccessibilityChildRoles)}`), t('require {0}', 'aria-busy="true"')),
+                : t('the {0}', 'roles') + `: ${t(role.allowedAccessibilityChildRoles.map(noTranslate))}`), t('require {0*}', 'aria-busy="true"')),
         };
     }
     return {
         scope: component,
         message: t('{0} expects {1}', t('the "{0*}" {1}', role.name, 'role'), role.allowedAccessibilityChildRoles.length === 1 && role.allowedAccessibilityChildRoles[0]
             ? t('the "{0*}" {1}', role.allowedAccessibilityChildRoles[0], 'role')
-            : t('the {0}', 'roles') + `: ${t(role.allowedAccessibilityChildRoles)}`),
+            : t('the {0}', 'roles') + `: ${t(role.allowedAccessibilityChildRoles.map(noTranslate))}`),
     };
 };
 /**
- * Determines whether the element's children may not yet exist (e.g., empty or
+ * Determines whether the owned child nodes may not yet exist (e.g., empty or
  * containing only `<script>` / `<template>` elements that could dynamically create content).
  *
- * @param el - The element to inspect.
- * @returns `true` if the element is empty or only contains script/template children.
+ * @param childNodes - The child nodes the element owns (see `getOwnedChildNodes`).
+ * @returns `true` if the nodes are empty or only contain script/template elements.
  */
 function mayBeBeforeCreated(childNodes) {
     if (childNodes.every(child => child.is(child.TEXT_NODE) && child.textContent?.trim() === '')) {
@@ -112,14 +117,14 @@ function mayBeBeforeCreated(childNodes) {
  * are evaluated as if they were direct children of the owning element.
  *
  * @param el - The parent element whose children to classify.
+ * @param childNodes - The child nodes `el` owns, from `getOwnedChildNodes`.
  * @param role - The ARIA role of the parent, which defines allowed child roles.
  * @param version - The WAI-ARIA version for version-gated transparency behavior.
  * @returns An array of classified child nodes.
  */
 function classifyChildren(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
-el, role, version) {
-    const childNodes = getOwnedChildNodes(el);
+el, childNodes, role, version) {
     if (!childNodes) {
         return [[el, 'UNKNOWN']];
     }
@@ -130,24 +135,30 @@ el, role, version) {
                 result.push([child, 'BUSY']);
                 continue;
             }
+            if (isSlotElement(child)) {
+                result.push(...classifySlot(child, role, version));
+                continue;
+            }
             /**
-             * The role of a child is resolved against its DOM parent. A child that a pretender
-             * places somewhere other than under its DOM parent (a node given at the usage site
-             * that the component renders inside its slot wrapper, or an element a fragment
-             * component renders in place) would be judged against the wrong parent and lose
-             * its role, so it is resolved on its own.
+             * The role of a child is resolved against its parent in the accessibility tree,
+             * which is the host for a child at the top of a declarative shadow root. A child
+             * that a pretender places somewhere other than under that parent (a node given at
+             * the usage site that the component renders inside its slot wrapper, or an element
+             * a fragment component renders in place) would be judged against the wrong parent
+             * and lose its role, so it is resolved on its own.
              */
-            const computedChild = getComputedRole(child.ownerMLDocument.specs, child, version, child.parentElement !== el);
+            const computedChild = getComputedRole(child.ownerMLDocument.specs, child, version, getComposedParentElement(child) !== el);
             if (role.allowedAccessibilityChildRoles.some(ownedRole => isRequiredOwnedElement(computedChild.el, computedChild.role, ownedRole, child.ownerMLDocument.specs, version))) {
                 result.push([child, 'REQUIRED']);
                 continue;
             }
             if (isTransparentForOwnership(computedChild.role?.name, version)) {
-                if (isContentMutable(child, 'pretended')) {
+                const shadowRootTemplate = getShadowRootTemplate(child);
+                if (shadowRootTemplate !== 'unknown' && isContentMutable(shadowRootTemplate ?? child, 'pretended')) {
                     result.push([child, 'UNKNOWN']);
                     continue;
                 }
-                result.push(...classifyChildren(child, role, version));
+                result.push(...classifyChildren(child, getOwnedChildNodes(child), role, version));
                 continue;
             }
             result.push([child, 'OTHER']);
@@ -161,6 +172,45 @@ el, role, version) {
     }
     return result;
 }
+/**
+ * Classifies what a `slot` that the owned elements are looked for through renders: the nodes assigned to
+ * it, or its own children when none is, in its place. A slot is not an element of the accessibility tree.
+ *
+ * The slot is reached only through the elements that are transparent for ownership, so what it renders
+ * is owned by the element as if it were written in place of the slot. A slot that is not reached (one
+ * in a `p`, or in the content of a nested `template`) places nothing as an owned element, and is not
+ * looked at. Where the assignment is not known (a slot that is not in a shadow root, a framework's, manual
+ * assignment, template syntax among the light children), what it renders is not known: `UNKNOWN`.
+ *
+ * The light children assigned to the slot are not in the shadow root that the mutability gate reads
+ * (`isOwnedContentMutable`), so the template syntax and the mutable attributes in them are looked at
+ * here: a node that may not be what it is written as keeps the rule from deciding.
+ *
+ * > If slottables is the empty list, then append each slottable child of slot, in tree order, to slottables.
+ *
+ * @see https://dom.spec.whatwg.org/#find-flattened-slotables
+ * @param slot - The `slot` element
+ * @param role - The ARIA role of the owner, which defines allowed child roles.
+ * @param version - The WAI-ARIA version for version-gated transparency behavior.
+ * @returns The classified nodes the slot renders.
+ */
+function classifySlot(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+slot, role, version) {
+    const assigned = slot.getAssignedNodes();
+    if (!assigned) {
+        return [[slot, 'UNKNOWN']];
+    }
+    if (assigned.length === 0) {
+        return classifyChildren(slot, getOwnedChildNodes(slot), role, version);
+    }
+    const mutable = assigned.some(node => node.is(node.ELEMENT_NODE) &&
+        (node.hasMutableAttributes() || node.hasMutableChildren(true, isFlattenedSlot)));
+    if (mutable) {
+        return [[slot, 'UNKNOWN']];
+    }
+    return classifyChildren(slot, assigned, role, version);
+}
 /**
  * The child nodes that `el` owns as the page renders them.
  *
@@ -174,12 +224,37 @@ el, role, version) {
  * - Several slot wrappers leave the owner of each node unknown, so `null` is returned
  *   and nothing is claimed about the element.
  *
+ * A shadow host owns the child nodes of its declarative shadow root, of either mode, and
+ * nothing else: the shadow root is rendered in place of the light children, which include
+ * the `template` that declares it and what a pretended component renders itself. This
+ * comes first, as ml-core attaches the root to a pretended host that renders the children
+ * written in it in itself. A `template` written in a block or a `template` with a directive
+ * may not be rendered, so `null` is returned for it (`getShadowRootTemplate`). The light children
+ * are rendered only where a `slot` in the shadow root places them: the nodes assigned to it
+ * (`MLElement#getAssignedNodes`) are classified in its place, and the light children that
+ * no slot takes are not owned (`classifySlot`).
+ *
+ * `getRenderedChildNodes` of `@markuplint/ml-core` (the accessible name computation)
+ * resolves the rendered children in the same order, but does not expand fragment
+ * components.
+ *
+ * > […] the flat tree is the top-level DOM tree, but shadow hosts are filled with their shadow tree children instead of their light tree children […]
+ *
+ * @see https://drafts.csswg.org/css-shadow-1/#flattening
  * @param el - The element, or the virtual slot wrapper of a pretended component.
  * @returns The child nodes, or `null` when they cannot be known.
  */
 function getOwnedChildNodes(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 el) {
+    // The content of the `template` is the shadow root, and holds the same nodes as its children.
+    const shadowRootTemplate = getShadowRootTemplate(el);
+    if (shadowRootTemplate === 'unknown') {
+        return null;
+    }
+    if (shadowRootTemplate) {
+        return expandChildren(shadowRootTemplate, [...shadowRootTemplate.childNodes], 'pretended');
+    }
     const context = el.pretenderContext;
     if (context?.type === 'pretender') {
         const wrapper = context.slotContent?.wrapper;
@@ -201,3 +276,82 @@ el) {
     }
     return expandChildren(el, [...el.childNodes], 'pretended');
 }
+/**
+ * Whether a `slot` is one that `classifyChildren` cannot see: a parser that makes the `slot` of its
+ * framework a fragment (Vue, Astro) has it flattened out of the child nodes, and what it renders is
+ * not known. Any other `slot` is classified where the owned elements reach it (`classifySlot`), and
+ * one that is not reached places nothing as an owned element.
+ *
+ * @param slot - A `slot` element
+ * @returns `true` if the slot is flattened out of the child nodes
+ */
+function isFlattenedSlot(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+slot) {
+    return slot.isFragment;
+}
+/**
+ * Whether the nodes `el` owns may be rendered by something the markup does not show:
+ * template syntax, a mutable attribute or a component that no pretender resolved among them
+ * (`hasMutableChildren`), or a pretender whose `contents` are unknown (`isContentMutable`).
+ * For a shadow host they are read in the shadow root, as that is what it owns: a light
+ * child that no `slot` places is not rendered, mutable or not.
+ *
+ * A `slot` is not counted here unless it is flattened out of the child nodes (`isFlattenedSlot`):
+ * `classifySlot` reads what it renders where the owned elements are looked for through it, and a slot
+ * that is not reached places nothing as an owned element.
+ *
+ * @param el - The element, or the component a virtual slot wrapper stands for.
+ * @returns `true` when the owned nodes may differ from the markup.
+ */
+function isOwnedContentMutable(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+el) {
+    const template = getShadowRootTemplate(el);
+    if (template === 'unknown') {
+        return true;
+    }
+    const scope = template ?? el;
+    return scope.hasMutableChildren(true, isFlattenedSlot) || isContentMutable(scope, 'pretended');
+}
+/**
+ * The `template` element whose content is the declarative shadow root of `host`, which ml-core
+ * exposes without the element.
+ *
+ * ml-core finds the `template` through what a template engine renders away (a block, a
+ * `template` with a directive such as `v-if`), as the id lookups need a tree either way. Such
+ * a wrapper, or a conditional branch that leaves the `template` out, may render it or not,
+ * and the host owns the shadow root or its light children accordingly. So what the host owns
+ * is unknown unless the `template` is written right in the host and in every branch of its
+ * children (`conditionalChildNodes`), and no block among them has a range that the syntax
+ * tree does not give.
+ *
+ * @param host - An element.
+ * @returns The `template` element; `'unknown'` when it is written in such a wrapper; `null`
+ *   when no shadow root is attached to `host`.
+ */
+function getShadowRootTemplate(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+host) {
+    const shadowRoot = host.declarativeShadowRoot;
+    if (!shadowRoot) {
+        return null;
+    }
+    // A block without a behavior may be a marker of a language whose blocks the syntax tree does
+    // not nest (`{% if %}` … `{% endif %}`), so whether it encloses the `template` is not known.
+    for (const child of host.getPureChildNodes()) {
+        if (child.is(child.MARKUPLINT_PREPROCESSOR_BLOCK) && !child.blockBehavior) {
+            return 'unknown';
+        }
+    }
+    for (const child of host.childNodes) {
+        if (child.is(child.ELEMENT_NODE) && child.content === shadowRoot) {
+            if (child.syntacticalParentNode !== host) {
+                return 'unknown';
+            }
+            const branches = host.conditionalChildNodes();
+            return branches.every(branch => [...branch].includes(child)) ? child : 'unknown';
+        }
+    }
+    return 'unknown';
+}

package/lib/wai-aria/checkings/value.js

@@ -1,3 +1,4 @@
+import { noTranslate } from '../../no-translate.js';
 /**
  * Checks whether the value of an ARIA property or state conforms to its expected type.
  *
@@ -22,9 +23,9 @@ export const checkingValue = ({ attr, role, propSpecs }) => t => {
     }
     return {
         scope: attr,
-        message: t('{0:c} on {1}', t('{0} is {1:c}', t('the "{0}"', attr.value), 'disallowed'), t('the "{0*}" {1}', attr.name, `ARIA ${propSpec?.type ?? 'property'}`)) +
+        message: t('{0:c} on {1}', t('{0} is {1:c}', t('the "{0*}"', attr.value), 'disallowed'), t('the "{0*}" {1}', attr.name, `ARIA ${propSpec?.type ?? 'property'}`)) +
             ('enum' in result && result.enum.length > 0
-                ? t('. ') + t('Allowed values are: {0}', t(result.enum))
+                ? t('. ') + t('Allowed values are: {0}', t(result.enum.map(noTranslate)))
                 : ''),
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "5.5.0",
+	"version": "5.6.0",
 	"description": "Built-in rules of markuplint",
 	"repository": {
 		"type": "git",
@@ -31,13 +31,13 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "5.5.0",
-		"@markuplint/ml-config": "5.5.0",
-		"@markuplint/ml-core": "5.5.0",
-		"@markuplint/ml-spec": "5.5.0",
-		"@markuplint/selector": "5.5.0",
-		"@markuplint/shared": "5.5.0",
-		"@markuplint/types": "5.5.0",
+		"@markuplint/html-spec": "5.6.0",
+		"@markuplint/ml-config": "5.6.0",
+		"@markuplint/ml-core": "5.6.0",
+		"@markuplint/ml-spec": "5.6.0",
+		"@markuplint/selector": "5.6.0",
+		"@markuplint/shared": "5.6.0",
+		"@markuplint/types": "5.6.0",
 		"@mdn/browser-compat-data": "^8.1.8",
 		"@types/debug": "^4.1.13",
 		"ansi-colors": "^4.1.3",
@@ -47,5 +47,8 @@
 		"image-size": "^2.0.4",
 		"type-fest": "^5.10.0"
 	},
-	"gitHead": "fedebcfd56eaec4642e68643b2f9e10750d810e1"
+	"devDependencies": {
+		"@markuplint/test-tools": "5.6.0"
+	},
+	"gitHead": "eade3d7202682e567f3c1b6985478f1d4b5c5481"
 }