@markuplint/rules 4.11.2 → 4.18.0

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

@@ -1,13 +1,36 @@
 import type { Options } from '../types.js';
 import type { AttrChecker } from '@markuplint/ml-core';
 import type { ARIAProperty, ARIARole } from '@markuplint/ml-spec';
+/**
+ * Checks whether the value of an ARIA property or state conforms to its expected type.
+ *
+ * ARIA properties have specific value types (token, token list, true/false, tristate,
+ * integer, number, string, ID reference, etc.). This checker validates the attribute
+ * value against the property's expected type and allowed enum values.
+ * Role-specific conditional value types are also considered.
+ *
+ * @param attr - The ARIA attribute node to inspect.
+ * @param role - The computed ARIA role, used to resolve conditional value types.
+ * @param propSpecs - The list of ARIA property specifications for value type lookup.
+ * @param booleanish - Whether the document supports booleanish attribute values (e.g., JSX).
+ * @returns A violation if the attribute value does not match the expected type.
+ */
 export declare const checkingValue: AttrChecker<boolean, Options, {
     role?: ARIARole | null;
     propSpecs: readonly ARIAProperty[];
     booleanish?: boolean;
 }>;
 /**
+ * Validates a raw ARIA value against the expected value type defined in the specification.
+ *
+ * Supports token, token list, string, ID reference, true/false, tristate,
+ * true/false/undefined, integer, and number value types.
  *
  * @see https://www.w3.org/TR/wai-aria-1.2/#propcharacteristic_value
+ * @param type - The ARIA value type (e.g., `"token"`, `"true/false"`, `"integer"`).
+ * @param value - The raw attribute value to validate.
+ * @param tokenEnum - The list of allowed token values for token-based types.
+ * @param booleanish - Whether empty string is accepted as a boolean `true` value.
+ * @returns `true` if the value is valid for the given type, `false` otherwise.
  */
 export declare function checkAriaValue(type: string, value: string, tokenEnum: readonly string[], booleanish?: boolean): boolean;

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

@@ -1,3 +1,17 @@
+/**
+ * Checks whether the value of an ARIA property or state conforms to its expected type.
+ *
+ * ARIA properties have specific value types (token, token list, true/false, tristate,
+ * integer, number, string, ID reference, etc.). This checker validates the attribute
+ * value against the property's expected type and allowed enum values.
+ * Role-specific conditional value types are also considered.
+ *
+ * @param attr - The ARIA attribute node to inspect.
+ * @param role - The computed ARIA role, used to resolve conditional value types.
+ * @param propSpecs - The list of ARIA property specifications for value type lookup.
+ * @param booleanish - Whether the document supports booleanish attribute values (e.g., JSX).
+ * @returns A violation if the attribute value does not match the expected type.
+ */
 export const checkingValue = ({ attr, role, propSpecs, booleanish }) => t => {
     if (attr.isDynamicValue) {
         return;
@@ -15,6 +29,15 @@ export const checkingValue = ({ attr, role, propSpecs, booleanish }) => t => {
                 : ''),
     };
 };
+/**
+ * Validates an ARIA property value against its specification, considering role-specific conditional types.
+ *
+ * @param propSpec - The ARIA property specification, or `undefined` if the property is unknown.
+ * @param currentValue - The current attribute value to validate.
+ * @param role - The name of the computed role, used to resolve conditional value types.
+ * @param booleanish - Whether booleanish values (empty string as `true`) are accepted.
+ * @returns An object containing the validation result and, for enum types, the allowed values.
+ */
 function checkAria(propSpec, currentValue, role, booleanish) {
     if (!propSpec) {
         return {
@@ -40,8 +63,17 @@ function checkAria(propSpec, currentValue, role, booleanish) {
     };
 }
 /**
+ * Validates a raw ARIA value against the expected value type defined in the specification.
+ *
+ * Supports token, token list, string, ID reference, true/false, tristate,
+ * true/false/undefined, integer, and number value types.
  *
  * @see https://www.w3.org/TR/wai-aria-1.2/#propcharacteristic_value
+ * @param type - The ARIA value type (e.g., `"token"`, `"true/false"`, `"integer"`).
+ * @param value - The raw attribute value to validate.
+ * @param tokenEnum - The list of allowed token values for token-based types.
+ * @param booleanish - Whether empty string is accepted as a boolean `true` value.
+ * @returns `true` if the value is valid for the given type, `false` otherwise.
  */
 export function checkAriaValue(type, value, tokenEnum, booleanish) {
     switch (type) {

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

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

@@ -17,6 +17,16 @@ import { checkingRequiredOwnedElements } from './checkings/required-owned-elemen
 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: {

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

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

package/lib/wai-aria/meta.js

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

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

@@ -1,14 +1,31 @@
 import type { ARIAVersion } from '@markuplint/ml-spec';
+/**
+ * Configuration options for the `wai-aria` rule.
+ *
+ * Each boolean flag enables or disables a specific WAI-ARIA validation check.
+ * The `version` field determines which ARIA specification version to validate against.
+ */
 export type Options = {
+    /** Whether to validate ARIA property and state values against their expected types. */
     checkingValue: boolean;
+    /** Whether to report usage of deprecated ARIA properties and states. */
     checkingDeprecatedProps: boolean;
+    /** Whether to report usage of deprecated ARIA roles. */
     checkingDeprecatedRole: boolean;
+    /** Whether to enforce the list of permitted ARIA roles for each element. */
     permittedAriaRoles: boolean;
+    /** Whether to verify that roles requiring specific owned elements contain them. */
     checkingRequiredOwnedElements: boolean;
+    /** Whether to warn when ARIA attributes are set on descendants of presentational-children roles. */
     checkingPresentationalChildren: boolean;
+    /** Whether to warn about focusable interactive elements hidden via `aria-hidden`. */
     checkingInteractionInHidden: boolean;
+    /** Whether to disallow explicitly setting a role that matches the element's implicit role. */
     disallowSetImplicitRole: boolean;
+    /** Whether to disallow explicitly setting ARIA properties that duplicate the element's native semantics. */
     disallowSetImplicitProps: boolean;
+    /** Whether to disallow explicitly setting an ARIA property to its default value. */
     disallowDefaultValue: boolean;
+    /** The WAI-ARIA specification version to validate against. */
     version: ARIAVersion;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "4.11.2",
+	"version": "4.18.0",
 	"description": "Built-in rules of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -24,18 +24,18 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "4.16.1",
-		"@markuplint/ml-core": "4.13.2",
-		"@markuplint/ml-spec": "4.10.1",
-		"@markuplint/selector": "4.7.7",
-		"@markuplint/shared": "4.4.12",
-		"@markuplint/types": "4.8.1",
-		"@types/debug": "4.1.12",
+		"@markuplint/html-spec": "4.18.0",
+		"@markuplint/ml-core": "4.18.0",
+		"@markuplint/ml-spec": "4.18.0",
+		"@markuplint/selector": "4.18.0",
+		"@markuplint/shared": "4.18.0",
+		"@markuplint/types": "4.18.0",
+		"@types/debug": "4.1.13",
 		"@ungap/structured-clone": "1.3.0",
 		"ansi-colors": "4.1.3",
-		"chrono-node": "2.8.4",
+		"chrono-node": "2.9.0",
 		"debug": "4.4.3",
-		"type-fest": "4.41.0"
+		"type-fest": "5.6.0"
 	},
-	"gitHead": "6213ea30269ef404f030e67bbcc7fc7443ec1060"
+	"gitHead": "1885af6349def3f19df975b9e9c399dd47361de1"
 }