@markuplint/rules 5.0.0-rc.2 → 5.0.0-rc.5

package/lib/wai-aria/index.d.ts

@@ -1,13 +0,0 @@
-import type { Options } from './types.js';
-/**
- * WAI-ARIA rule for markuplint.
- *
- * Validates the correct usage of WAI-ARIA roles, states, and properties
- * on HTML elements. This rule performs a comprehensive set of checks including
- * role validity, property values, required owned elements, and conformance
- * with the ARIA in HTML specification.
- *
- * Individual checks can be toggled on or off via the rule's options.
- */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria/index.js

@@ -1,115 +0,0 @@
-import { createRule, getAttrSpecs, getComputedRole, ariaSpecs, getSpec } from '@markuplint/ml-core';
-import { ARIA_RECOMMENDED_VERSION } from '@markuplint/ml-spec';
-import { Collection } from '../helpers.js';
-import { defaultOptions } from './default-options.js';
-import { checkingAbstractRole } from './checkings/abstract-role.js';
-import { checkingDefaultValue } from './checkings/default-value.js';
-import { checkingDeprecatedProps } from './checkings/deprecated-props.js';
-import { checkingDeprecatedRole } from './checkings/deprecated-role.js';
-import { checkingDisallowedProp } from './checkings/disallowed-prop.js';
-import { checkingImplicitProps } from './checkings/implicit-props.js';
-import { checkingImplicitRole } from './checkings/implicit-role.js';
-import { checkingInteractionInHidden } from './checkings/interaction-in-hidden.js';
-import { checkingNoGlobalProp } from './checkings/no-global-prop.js';
-import { checkingNonExistentRole } from './checkings/non-existent-role.js';
-import { checkingPermittedRoles } from './checkings/permitted-roles.js';
-import { checkingPresentationalChildren } from './checkings/presentational-children.js';
-import { checkingRequiredAccessibilityParentRole } from './checkings/required-accessibility-parent-role.js';
-import { checkingRequiredOwnedElements } from './checkings/required-owned-elements.js';
-import { checkingRequiredProp } from './checkings/required-prop.js';
-import { checkingValue } from './checkings/value.js';
-import meta from './meta.js';
-/**
- * WAI-ARIA rule for markuplint.
- *
- * Validates the correct usage of WAI-ARIA roles, states, and properties
- * on HTML elements. This rule performs a comprehensive set of checks including
- * role validity, property values, required owned elements, and conformance
- * with the ARIA in HTML specification.
- *
- * Individual checks can be toggled on or off via the rule's options.
- */
-export default createRule({
-    meta: meta,
-    defaultOptions,
-    async verify({ document, report, t }) {
-        await document.walkOn('Element', el => {
-            const roleAttr = el.getAttributeNode('role');
-            const propAttrs = el.attributes.filter(attr => /^aria-/i.test(attr.name));
-            const ariaAttrs = new Collection(roleAttr, ...propAttrs);
-            const elSpec = getSpec(el, document.specs.specs);
-            if (!elSpec) {
-                return;
-            }
-            if (!elSpec.globalAttrs['#ARIAAttrs']) {
-                for (const ariaAttr of ariaAttrs) {
-                    report({
-                        scope: ariaAttr,
-                        message: 'ARIA attribute is disallowed',
-                    });
-                }
-                return;
-            }
-            const ariaVersion = el.rule.options?.version ?? document.ruleCommonSettings?.ariaVersion ?? ARIA_RECOMMENDED_VERSION;
-            const computed = getComputedRole(document.specs, el, ariaVersion);
-            const { props: propSpecs } = ariaSpecs(document.specs, ariaVersion);
-            if (roleAttr) {
-                if (report(checkingNonExistentRole({ attr: roleAttr }))) {
-                    return;
-                }
-                if (report(checkingAbstractRole({ attr: roleAttr }))) {
-                    return;
-                }
-                if (el.rule.options.checkingRequiredAccessibilityParentRole) {
-                    report(checkingRequiredAccessibilityParentRole({ el, computed }));
-                }
-                report(checkingRequiredProp({ el, role: computed.role, propSpecs }));
-                if (el.rule.options.checkingDeprecatedRole) {
-                    report(checkingDeprecatedRole({ attr: roleAttr, role: computed.role }));
-                }
-                // If the explicit role duplicates the implicit role, surface only that
-                // (more specific) message. Otherwise fall through to the general
-                // permitted-roles check to avoid emitting two violations for the same
-                // offending token.
-                const implicitRoleViolated = el.rule.options.disallowSetImplicitRole && report(checkingImplicitRole({ attr: roleAttr }));
-                if (el.rule.options.permittedAriaRoles && !implicitRoleViolated) {
-                    report(checkingPermittedRoles({ attr: roleAttr }));
-                }
-            }
-            for (const attr of propAttrs) {
-                report(checkingDisallowedProp({
-                    attr,
-                    role: computed.role,
-                    propSpecs,
-                    disallowSetImplicitProps: el.rule.options.disallowSetImplicitProps,
-                }));
-                if (el.rule.options.checkingDeprecatedProps) {
-                    report(checkingDeprecatedProps({ attr, role: computed.role, propSpecs }));
-                }
-                if (el.rule.options.disallowSetImplicitProps) {
-                    const attrSpecs = getAttrSpecs(el, document.specs);
-                    report(checkingImplicitProps({ attr, propSpecs, attrSpecs }));
-                }
-                if (el.rule.options.checkingValue) {
-                    report(checkingValue({ attr, role: computed.role, propSpecs, booleanish: document.booleanish }));
-                }
-                if (el.rule.options.disallowDefaultValue) {
-                    report(checkingDefaultValue({ attr, propSpecs }));
-                }
-                if (!computed.role) {
-                    report(checkingNoGlobalProp({ attr, propSpecs }));
-                }
-            }
-            if (el.rule.options.checkingAllowedAccessibilityChildRoles &&
-                el.rule.options.checkingRequiredOwnedElements) {
-                report(checkingRequiredOwnedElements({ el, role: computed.role }));
-            }
-            if (el.rule.options.checkingPresentationalChildren) {
-                report(checkingPresentationalChildren({ el }));
-            }
-            if (el.rule.options.checkingInteractionInHidden) {
-                report(checkingInteractionInHidden({ el }));
-            }
-        });
-    },
-});

package/lib/wai-aria/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

package/lib/wai-aria/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};

package/lib/wai-aria-default-value/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when an ARIA property is explicitly set to its spec-defined default value. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-default-value/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria-default-value` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

package/lib/wai-aria-default-value/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria-default-value` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};

package/lib/wai-aria-deprecated-props/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when a deprecated ARIA property or state is used on a role. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-deprecated-props/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria-deprecated-props` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

package/lib/wai-aria-deprecated-props/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria-deprecated-props` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};

package/lib/wai-aria-disallowed-props/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when an ARIA property or state is not allowed on the element's computed role. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-disallowed-props/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria-disallowed-props` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

package/lib/wai-aria-disallowed-props/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria-disallowed-props` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};

package/lib/wai-aria-implicit-props/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when an ARIA property duplicates or contradicts semantics provided by a native HTML attribute. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-implicit-props/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria-implicit-props` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

package/lib/wai-aria-implicit-props/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria-implicit-props` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};

package/lib/wai-aria-implicit-role/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when the explicit role attribute duplicates the element's implicit role. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-interaction-in-hidden/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when focusable interactive elements are placed inside an aria-hidden subtree. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-interaction-in-hidden/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria-interaction-in-hidden` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

package/lib/wai-aria-interaction-in-hidden/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria-interaction-in-hidden` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};

package/lib/wai-aria-no-global-prop/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when a non-global ARIA property is used on an element without an explicit role. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-no-global-prop/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria-no-global-prop` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

package/lib/wai-aria-no-global-prop/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria-no-global-prop` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};

package/lib/wai-aria-non-existent-role/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when a role attribute value does not exist in the WAI-ARIA specification. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-permitted-roles/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when a role is not permitted on the element according to ARIA in HTML. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-presentational-children/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when ARIA attributes are set on descendants of roles with presentational children. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-presentational-children/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria-presentational-children` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

package/lib/wai-aria-presentational-children/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria-presentational-children` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};

package/lib/wai-aria-required-parent-role/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when an element with an explicit role is placed outside its required parent context. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-value/index.d.ts

@@ -1,4 +0,0 @@
-import type { Options } from '../wai-aria/types.js';
-/** Warns when an ARIA property or state value does not conform to its expected type. */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
-export default _default;

package/lib/wai-aria-value/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for the `wai-aria-value` rule, categorized under accessibility. */
-declare const _default: {
-    readonly category: "a11y";
-};
-export default _default;

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

@@ -1,4 +0,0 @@
-/** Rule metadata for the `wai-aria-value` rule, categorized under accessibility. */
-export default {
-    category: 'a11y',
-};