@markuplint/rules 4.11.2 → 5.0.0-alpha.0

package/lib/heading-levels/index.js

@@ -1,8 +1,13 @@
 import { createRule } from '@markuplint/ml-core';
 import meta from './meta.js';
+/**
+ * Rule that validates heading levels (h1-h6) are not skipped.
+ *
+ * Ensures that heading elements appear in a sequential order without
+ * gaps (e.g., an h4 must not follow an h2 directly without an h3 in between).
+ */
 export default createRule({
     meta: meta,
-    defaultValue: true,
     defaultOptions: null,
     verify({ document, report, t }) {
         const headings = document.querySelectorAll('h1, h2, h3, h4, h5, h6');

package/lib/heading-levels/meta.d.ts

@@ -1,3 +1,4 @@
+/** Rule metadata for the `heading-levels` rule, categorized as validation. */
 declare const _default: {
     readonly category: "validation";
 };

package/lib/heading-levels/meta.js

@@ -1,3 +1,4 @@
+/** Rule metadata for the `heading-levels` rule, categorized as validation. */
 export default {
     category: 'validation',
 };

package/lib/helpers.d.ts

@@ -4,7 +4,27 @@ import type { PlainData } from '@markuplint/ml-config';
 import type { Element, RuleConfigValue, Document } from '@markuplint/ml-core';
 import type { Attribute } from '@markuplint/ml-spec';
 import type { WritableDeep } from 'type-fest';
+/**
+ * Tests whether an element matches the condition specified in an attribute spec.
+ * When the condition is `null` or `undefined`, the element is considered to match unconditionally.
+ *
+ * @template T - The rule configuration value type
+ * @template O - The rule options type
+ * @param node - The element to test against the condition
+ * @param condition - A CSS selector string or array of selector strings from the attribute specification;
+ *   if `null`/`undefined`, the function returns `true`
+ * @returns `true` if the element matches the condition (or no condition is given), `false` otherwise
+ */
 export declare function attrMatches<T extends RuleConfigValue, O extends PlainData>(node: Element<T, O>, condition: Attribute['condition']): boolean;
+/**
+ * Tests whether a string matches a given pattern. The pattern can be either
+ * a plain string (tested for exact equality) or a regular expression literal
+ * in the form `/pattern/flags`.
+ *
+ * @param needle - The string to test
+ * @param pattern - A plain string or a regex literal string (e.g. `/^foo/i`)
+ * @returns `true` if the needle matches the pattern
+ */
 export declare function match(needle: string, pattern: string): boolean;
 /**
  * PotentialCustomElementName
@@ -22,6 +42,22 @@ export declare function match(needle: string, pattern: string): boolean;
  * Originally, it is not possible to define a name including ASCII upper alphas in the custom element, but it is not treated as illegal by the HTML parser.
  */
 export declare const rePCENChar: string;
+/**
+ * Validates an attribute name/value pair against its specification.
+ * Checks attribute existence in the spec, value validity, conditional applicability,
+ * and skips validation for dynamic (template-interpolated) values when the error
+ * relates to an invalid value.
+ *
+ * @param t - The i18n translator for generating localized error messages
+ * @param name - The attribute name to validate
+ * @param value - The attribute value to validate
+ * @param isDynamicValue - Whether the value is dynamic (e.g. from a template expression);
+ *   if `true`, invalid-value errors are suppressed
+ * @param node - The element that owns the attribute
+ * @param attrSpecs - The list of attribute specifications to validate against
+ * @param log - Optional debug logger for diagnostic output
+ * @returns `false` if valid, or an `Invalid` object (or array of them) describing the violation
+ */
 export declare function isValidAttr(t: Translator, name: string, value: string, isDynamicValue: boolean, node: Element<any, any>, attrSpecs: readonly Attribute[], log?: Log): false | {
     invalidType: "non-existent" | "invalid-value" | "disallowed-attr";
     message: string;
@@ -39,14 +75,83 @@ export declare function isValidAttr(t: Translator, name: string, value: string,
         col: number;
     };
 }[];
+/**
+ * Normalizes an attribute value according to its specification rules.
+ * Applies case-folding, whitespace trimming, and separator normalization
+ * based on the attribute type definition.
+ *
+ * @param value - The raw attribute value to normalize
+ * @param spec - The attribute specification that defines normalization rules
+ *   (case sensitivity, separator type, whitespace handling)
+ * @returns The normalized attribute value
+ */
 export declare function toNormalizedValue(value: string, spec: Attribute): string;
+/**
+ * Determines whether an element's accessible name may change at runtime.
+ * Returns `true` if the element itself has mutable attributes or children,
+ * or if an associated `<label>` element has mutable content.
+ *
+ * @param el - The element whose accessible name stability is being checked
+ * @param document - The document containing the element, used to locate associated labels
+ * @returns `true` if the accessible name could change dynamically, `false` otherwise
+ */
 export declare function accnameMayBeMutable(el: Element<any, any>, document: Document<any, any>): boolean;
+export declare const labelable: string[];
+/**
+ * Finds the `<label>` element associated with a labelable form element.
+ * First checks for an ancestor `<label>`, then looks for a `<label>` whose
+ * `for` attribute references the element's `id`. Returns `null` if the
+ * element is not labelable or no associated label is found.
+ *
+ * @template V - The rule configuration value type
+ * @template O - The rule options type
+ * @param el - The element to find a label for (must be a labelable element)
+ * @param document - The document to search for labels with a matching `for` attribute
+ * @returns The associated `<label>` element, or `null` if none is found
+ */
 export declare function getOwnedLabel<V extends RuleConfigValue, O extends PlainData>(el: Element<V, O>, document: Document<V, O>): Element<V, O> | null;
+/**
+ * A generic, null-safe collection backed by a `Set`.
+ * Automatically filters out `null` and `undefined` values when items are added.
+ * Implements the iterable protocol so it can be used in `for...of` loops.
+ *
+ * @template T - The type of items stored in the collection
+ */
 export declare class Collection<T> {
     #private;
+    /**
+     * Creates a new collection, optionally pre-populated with the given items.
+     * Any `null` or `undefined` values are silently ignored.
+     *
+     * @param items - Initial items to add to the collection
+     */
     constructor(...items: readonly (T | null | undefined)[]);
+    /**
+     * Returns an iterator over the items in the collection.
+     *
+     * @returns An iterator that yields each item in insertion order
+     */
     [Symbol.iterator](): Iterator<T>;
+    /**
+     * Adds one or more items to the collection.
+     * Any `null` or `undefined` values are silently ignored.
+     *
+     * @param items - Items to add to the collection
+     */
     add(...items: readonly (T | null | undefined)[]): void;
+    /**
+     * Returns a frozen array snapshot of the collection's contents.
+     *
+     * @returns A read-only array containing all items in insertion order
+     */
     toArray(): readonly T[];
 }
+/**
+ * Creates a deep, writable copy of the given value using structured cloning.
+ * Strips read-only modifiers from the result type so the clone can be freely mutated.
+ *
+ * @template T - The type of the value to clone
+ * @param value - The value to deep-copy
+ * @returns A mutable deep clone of the input value
+ */
 export declare function deepCopy<T>(value: T): WritableDeep<T>;

package/lib/helpers.js

@@ -1,12 +1,15 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _Collection_items;
-// @ts-ignore
-import structuredClone from '@ungap/structured-clone';
 import { attrCheck } from './attr-check.js';
+/**
+ * Tests whether an element matches the condition specified in an attribute spec.
+ * When the condition is `null` or `undefined`, the element is considered to match unconditionally.
+ *
+ * @template T - The rule configuration value type
+ * @template O - The rule options type
+ * @param node - The element to test against the condition
+ * @param condition - A CSS selector string or array of selector strings from the attribute specification;
+ *   if `null`/`undefined`, the function returns `true`
+ * @returns `true` if the element matches the condition (or no condition is given), `false` otherwise
+ */
 export function attrMatches(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 node, condition) {
@@ -16,6 +19,15 @@ node, condition) {
     const condSelector = typeof condition === 'string' ? condition : condition.join(',');
     return node.matches(condSelector);
 }
+/**
+ * Tests whether a string matches a given pattern. The pattern can be either
+ * a plain string (tested for exact equality) or a regular expression literal
+ * in the form `/pattern/flags`.
+ *
+ * @param needle - The string to test
+ * @param pattern - A plain string or a regex literal string (e.g. `/^foo/i`)
+ * @returns `true` if the needle matches the pattern
+ */
 export function match(needle, pattern) {
     const matches = pattern.match(/^\/(.*)\/([gim])*$/);
     if (matches && matches[1]) {
@@ -60,15 +72,31 @@ export const rePCENChar = [
     '[\uFDF0-\uFFFD]',
     '[\uD800-\uDBFF][\uDC00-\uDFFF]',
 ].join('|');
+/**
+ * Validates an attribute name/value pair against its specification.
+ * Checks attribute existence in the spec, value validity, conditional applicability,
+ * and skips validation for dynamic (template-interpolated) values when the error
+ * relates to an invalid value.
+ *
+ * @param t - The i18n translator for generating localized error messages
+ * @param name - The attribute name to validate
+ * @param value - The attribute value to validate
+ * @param isDynamicValue - Whether the value is dynamic (e.g. from a template expression);
+ *   if `true`, invalid-value errors are suppressed
+ * @param node - The element that owns the attribute
+ * @param attrSpecs - The list of attribute specifications to validate against
+ * @param log - Optional debug logger for diagnostic output
+ * @returns `false` if valid, or an `Invalid` object (or array of them) describing the violation
+ */
 export function isValidAttr(t, name, value, isDynamicValue, 
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 node, attrSpecs, 
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 log) {
-    let invalid = false;
     const spec = attrSpecs.find(s => s.name.toLowerCase() === name.toLowerCase());
     log?.('Spec of the %s attr: %o', name, spec);
-    invalid = attrCheck(t, name, value, false, spec);
+    const allAttrNames = attrSpecs.map(s => s.name);
+    let invalid = attrCheck(t, name, value, false, spec, allAttrNames);
     if (invalid === false &&
         spec &&
         spec.condition != null &&
@@ -84,6 +112,16 @@ log) {
     }
     return invalid;
 }
+/**
+ * Normalizes an attribute value according to its specification rules.
+ * Applies case-folding, whitespace trimming, and separator normalization
+ * based on the attribute type definition.
+ *
+ * @param value - The raw attribute value to normalize
+ * @param spec - The attribute specification that defines normalization rules
+ *   (case sensitivity, separator type, whitespace handling)
+ * @returns The normalized attribute value
+ */
 export function toNormalizedValue(value, spec) {
     let normalized = value;
     if (!spec.caseSensitive) {
@@ -112,6 +150,15 @@ export function toNormalizedValue(value, spec) {
     }
     return normalized;
 }
+/**
+ * Determines whether an element's accessible name may change at runtime.
+ * Returns `true` if the element itself has mutable attributes or children,
+ * or if an associated `<label>` element has mutable content.
+ *
+ * @param el - The element whose accessible name stability is being checked
+ * @param document - The document containing the element, used to locate associated labels
+ * @returns `true` if the accessible name could change dynamically, `false` otherwise
+ */
 export function accnameMayBeMutable(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 el, 
@@ -126,7 +173,19 @@ document) {
     }
     return false;
 }
-const labelable = ['button', 'input:not([type=hidden])', 'meter', 'output', 'progress', 'select', 'textarea'];
+export const labelable = ['button', 'input:not([type=hidden])', 'meter', 'output', 'progress', 'select', 'textarea'];
+/**
+ * Finds the `<label>` element associated with a labelable form element.
+ * First checks for an ancestor `<label>`, then looks for a `<label>` whose
+ * `for` attribute references the element's `id`. Returns `null` if the
+ * element is not labelable or no associated label is found.
+ *
+ * @template V - The rule configuration value type
+ * @template O - The rule options type
+ * @param el - The element to find a label for (must be a labelable element)
+ * @param document - The document to search for labels with a matching `for` attribute
+ * @returns The associated `<label>` element, or `null` if none is found
+ */
 export function getOwnedLabel(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 el, 
@@ -144,26 +203,63 @@ document) {
     }
     return ownedLabel;
 }
+/**
+ * A generic, null-safe collection backed by a `Set`.
+ * Automatically filters out `null` and `undefined` values when items are added.
+ * Implements the iterable protocol so it can be used in `for...of` loops.
+ *
+ * @template T - The type of items stored in the collection
+ */
 export class Collection {
+    #items = new Set();
+    /**
+     * Creates a new collection, optionally pre-populated with the given items.
+     * Any `null` or `undefined` values are silently ignored.
+     *
+     * @param items - Initial items to add to the collection
+     */
     constructor(...items) {
-        _Collection_items.set(this, new Set());
         this.add(...items);
     }
-    [(_Collection_items = new WeakMap(), Symbol.iterator)]() {
-        return __classPrivateFieldGet(this, _Collection_items, "f").values();
+    /**
+     * Returns an iterator over the items in the collection.
+     *
+     * @returns An iterator that yields each item in insertion order
+     */
+    [Symbol.iterator]() {
+        return this.#items.values();
     }
+    /**
+     * Adds one or more items to the collection.
+     * Any `null` or `undefined` values are silently ignored.
+     *
+     * @param items - Items to add to the collection
+     */
     add(...items) {
         for (const item of items) {
             if (item == null) {
                 continue;
             }
-            __classPrivateFieldGet(this, _Collection_items, "f").add(item);
+            this.#items.add(item);
         }
     }
+    /**
+     * Returns a frozen array snapshot of the collection's contents.
+     *
+     * @returns A read-only array containing all items in insertion order
+     */
     toArray() {
-        return Object.freeze([...__classPrivateFieldGet(this, _Collection_items, "f")]);
+        return Object.freeze([...this.#items]);
     }
 }
+/**
+ * Creates a deep, writable copy of the given value using structured cloning.
+ * Strips read-only modifiers from the result type so the clone can be freely mutated.
+ *
+ * @template T - The type of the value to clone
+ * @param value - The value to deep-copy
+ * @returns A mutable deep clone of the input value
+ */
 export function deepCopy(value) {
     return structuredClone(value);
 }

package/lib/id-duplication/index.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Rule that checks for duplicate `id` attribute values within a document.
+ *
+ * Walks all elements and collects `id` values, reporting any that have
+ * already been seen. Dynamic values and directive attributes are excluded
+ * from the check.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
 export default _default;

package/lib/id-duplication/index.js

@@ -1,5 +1,12 @@
 import { createRule } from '@markuplint/ml-core';
 import meta from './meta.js';
+/**
+ * Rule that checks for duplicate `id` attribute values within a document.
+ *
+ * Walks all elements and collects `id` values, reporting any that have
+ * already been seen. Dynamic values and directive attributes are excluded
+ * from the check.
+ */
 export default createRule({
     meta: meta,
     async verify({ document, report, t }) {

package/lib/id-duplication/meta.d.ts

@@ -1,3 +1,4 @@
+/** Rule metadata for `id-duplication`: categorized as a validation rule. */
 declare const _default: {
     readonly category: "validation";
 };

package/lib/id-duplication/meta.js

@@ -1,3 +1,4 @@
+/** Rule metadata for `id-duplication`: categorized as a validation rule. */
 export default {
     category: 'validation',
 };

package/lib/index.d.ts

@@ -1,3 +1,15 @@
+/**
+ * @module @markuplint/rules
+ *
+ * Built-in rules for markuplint. This module exports a registry of all
+ * core lint rules that ship with markuplint, keyed by their rule name.
+ * Each rule implements the {@link AnyRuleSeed} interface and covers
+ * areas such as accessibility, HTML validity, naming conventions, and coding style.
+ */
+/**
+ * Registry of all built-in markuplint rules, mapping rule names to their seed definitions.
+ * Used by the markuplint core to initialize rule instances during linting.
+ */
 declare const rules: {
     readonly 'attr-duplication': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'attr-value-quotes': Readonly<import("@markuplint/ml-core").RuleSeed<import("./attr-value-quotes/index.js").Type, undefined>>;
@@ -5,6 +17,9 @@ declare const rules: {
     readonly 'case-sensitive-tag-name': Readonly<import("@markuplint/ml-core").RuleSeed<import("./case-sensitive-tag-name/index.js").Value, undefined>>;
     readonly 'character-reference': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'class-naming': Readonly<import("@markuplint/ml-core").RuleSeed<import("./class-naming/index.js").Value, undefined>>;
+    readonly 'correct-aspect-ratio': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
+        readonly documentRoot?: string;
+    }>>;
     readonly 'deprecated-attr': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'deprecated-element': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'disallowed-element': Readonly<import("@markuplint/ml-core").RuleSeed<string[], undefined>>;
@@ -18,53 +33,23 @@ declare const rules: {
     readonly 'invalid-attr': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
         allowAttrs?: (string | {
             name: string;
-            value: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType | ({
-                enum: [string, ...string[]];
-            } | {
-                pattern: string;
-            } | {
-                type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
-            });
-        })[] | Record<string, {
-            enum: [string, ...string[]];
-        } | {
-            pattern: string;
-        } | {
-            type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
-        }>;
+            value: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType | import("packages/@markuplint/types/lib/types.schema.js").Pattern;
+        })[] | Record<string, import("packages/@markuplint/ml-spec/lib/index.js").AttributeType | import("packages/@markuplint/types/lib/types.schema.js").Pattern>;
         disallowAttrs?: (string | {
             name: string;
-            value: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType | ({
-                enum: [string, ...string[]];
-            } | {
-                pattern: string;
-            } | {
-                type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
-            });
-        })[] | Record<string, {
-            enum: [string, ...string[]];
-        } | {
-            pattern: string;
-        } | {
-            type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
-        }>;
+            value: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType | import("packages/@markuplint/types/lib/types.schema.js").Pattern;
+        })[] | Record<string, import("packages/@markuplint/ml-spec/lib/index.js").AttributeType | import("packages/@markuplint/types/lib/types.schema.js").Pattern>;
         ignoreAttrNamePrefix?: string | string[];
         allowToAddPropertiesForPretender?: boolean;
-        attrs?: Record<string, ({
-            enum: [string, ...string[]];
-        } | {
-            pattern: string;
-        } | {
-            type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
-        }) | {
-            disallowed: true;
-        }>;
     }>>;
     readonly 'label-has-control': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'landmark-roles': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
         ignoreRoles: (("banner" | "main" | "complementary" | "contentinfo") | "form" | "navigation" | "region")[];
         labelEachArea: boolean;
     }>>;
+    readonly 'link-types': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
+        readonly allowMicroformats?: boolean | readonly string[];
+    }>>;
     readonly 'neighbor-popovers': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'no-ambiguous-navigable-target-names': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;
     readonly 'no-boolean-attr-value': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
@@ -78,28 +63,45 @@ declare const rules: {
     readonly 'no-hard-code-id': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'no-orphaned-end-tag': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, null>>;
     readonly 'no-refer-to-non-existent-id': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, {
-        ariaVersion: import("packages/@markuplint/ml-spec/lib/index.js").ARIAVersion;
+        ariaVersion: import("packages/@markuplint/ml-spec/lib/index.js").ARIAVersion | undefined;
         fragmentRefersNameAttr: boolean;
     }>>;
+    readonly 'no-unsupported-features': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
+        readonly browserslist?: string | readonly string[];
+        readonly browserslistConfig?: string;
+        readonly browserslistEnv?: string;
+        readonly ignoreFeatures?: readonly string[];
+        readonly checkExperimental?: boolean;
+        readonly checkNonStandard?: boolean;
+    }>>;
     readonly 'no-use-event-handler-attr': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
         ignore?: string | string[];
     }>>;
     readonly 'permitted-contents': Readonly<import("@markuplint/ml-core").RuleSeed<import("./permitted-contents/types.js").TagRule[], import("./permitted-contents/types.js").Options>>;
     readonly 'placeholder-label-option': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;
-    readonly 'require-accessible-name': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
-        ariaVersion: import("packages/@markuplint/ml-spec/lib/index.js").ARIAVersion;
+    readonly 'redundant-accessible-name': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, {
+        checkTitleFallback: boolean;
+        checkPlaceholderFallback: boolean;
+    }>>;
+    readonly 'require-accessible-name': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, {
+        ariaVersion: import("packages/@markuplint/ml-spec/lib/index.js").ARIAVersion | undefined;
     }>>;
     readonly 'require-datetime': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
         langs?: import("./require-datetime/types.js").Lang[];
     }>>;
+    readonly 'require-dialog-autofocus': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'required-attr': Readonly<import("@markuplint/ml-core").RuleSeed<string | (string | {
         name: string;
         value?: string | string[];
-    })[], undefined>>;
+    })[], {
+        readonly ignoreAttrs?: readonly string[];
+    }>>;
     readonly 'required-element': Readonly<import("@markuplint/ml-core").RuleSeed<string[], {
         ignoreHasMutableContents: boolean;
+        ignoreOmittedElements: boolean;
     }>>;
     readonly 'required-h1': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, import("./required-h1/index.js").Options>>;
+    readonly 'srcset-sizes-constraint': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;
     readonly 'table-row-column-alignment': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;
     readonly 'use-list': Readonly<import("@markuplint/ml-core").RuleSeed<readonly string[], {
         spaceNeededBullets?: string[];

package/lib/index.js

@@ -1,8 +1,17 @@
+/**
+ * @module @markuplint/rules
+ *
+ * Built-in rules for markuplint. This module exports a registry of all
+ * core lint rules that ship with markuplint, keyed by their rule name.
+ * Each rule implements the {@link AnyRuleSeed} interface and covers
+ * areas such as accessibility, HTML validity, naming conventions, and coding style.
+ */
 import AttrDuplication from './attr-duplication/index.js';
 import AttrValueQuotes from './attr-value-quotes/index.js';
 import CaseSensitiveAttrName from './case-sensitive-attr-name/index.js';
 import CaseSensitiveTagName from './case-sensitive-tag-name/index.js';
 import CharacterReference from './character-reference/index.js';
+import CorrectAspectRatio from './correct-aspect-ratio/index.js';
 import ClassNaming from './class-naming/index.js';
 import DeprecatedAttr from './deprecated-attr/index.js';
 import DeprecatedElement from './deprecated-element/index.js';
@@ -15,6 +24,7 @@ import IneffectiveAttr from './ineffective-attr/index.js';
 import InvalidAttr from './invalid-attr/index.js';
 import LabelHasControl from './label-has-control/index.js';
 import LandmarkRoles from './landmark-roles/index.js';
+import LinkTypes from './link-types/index.js';
 import NeighborPopovers from './neighbor-popovers/index.js';
 import NoAmbiguousNavigableTargetNames from './no-ambiguous-navigable-target-names/index.js';
 import NoBooleanAttrValue from './no-boolean-attr-value/index.js';
@@ -25,17 +35,25 @@ import NoEmptyPalpableContent from './no-empty-palpable-content/index.js';
 import NoHardCodeId from './no-hard-code-id/index.js';
 import NoOrphanedEndTag from './no-orphaned-end-tag/index.js';
 import NoReferToNonExistentId from './no-refer-to-non-existent-id/index.js';
+import NoUnsupportedFeatures from './no-unsupported-features/index.js';
 import NoUseEventHandlerAttr from './no-use-event-handler-attr/index.js';
 import PermittedContents from './permitted-contents/index.js';
 import PlaceholderLabelOption from './placeholder-label-option/index.js';
+import RedundantAccessibleName from './redundant-accessible-name/index.js';
 import RequireAccessibleName from './require-accessible-name/index.js';
 import RequireDatetime from './require-datetime/index.js';
+import RequireDialogAutofocus from './require-dialog-autofocus/index.js';
+import SrcsetSizesConstraint from './srcset-sizes-constraint/index.js';
 import RequiredAttr from './required-attr/index.js';
 import RequiredElement from './required-element/index.js';
 import RequiredH1 from './required-h1/index.js';
 import TableRowColumnAlignment from './table-row-column-alignment/index.js';
 import UseList from './use-list/index.js';
 import WaiAria from './wai-aria/index.js';
+/**
+ * Registry of all built-in markuplint rules, mapping rule names to their seed definitions.
+ * Used by the markuplint core to initialize rule instances during linting.
+ */
 const rules = {
     'attr-duplication': AttrDuplication,
     'attr-value-quotes': AttrValueQuotes,
@@ -43,6 +61,7 @@ const rules = {
     'case-sensitive-tag-name': CaseSensitiveTagName,
     'character-reference': CharacterReference,
     'class-naming': ClassNaming,
+    'correct-aspect-ratio': CorrectAspectRatio,
     'deprecated-attr': DeprecatedAttr,
     'deprecated-element': DeprecatedElement,
     'disallowed-element': DisallowedElement,
@@ -54,6 +73,7 @@ const rules = {
     'invalid-attr': InvalidAttr,
     'label-has-control': LabelHasControl,
     'landmark-roles': LandmarkRoles,
+    'link-types': LinkTypes,
     'neighbor-popovers': NeighborPopovers,
     'no-ambiguous-navigable-target-names': NoAmbiguousNavigableTargetNames,
     'no-boolean-attr-value': NoBooleanAttrValue,
@@ -64,14 +84,18 @@ const rules = {
     'no-hard-code-id': NoHardCodeId,
     'no-orphaned-end-tag': NoOrphanedEndTag,
     'no-refer-to-non-existent-id': NoReferToNonExistentId,
+    'no-unsupported-features': NoUnsupportedFeatures,
     'no-use-event-handler-attr': NoUseEventHandlerAttr,
     'permitted-contents': PermittedContents,
     'placeholder-label-option': PlaceholderLabelOption,
+    'redundant-accessible-name': RedundantAccessibleName,
     'require-accessible-name': RequireAccessibleName,
     'require-datetime': RequireDatetime,
+    'require-dialog-autofocus': RequireDialogAutofocus,
     'required-attr': RequiredAttr,
     'required-element': RequiredElement,
     'required-h1': RequiredH1,
+    'srcset-sizes-constraint': SrcsetSizesConstraint,
     'table-row-column-alignment': TableRowColumnAlignment,
     'use-list': UseList,
     'wai-aria': WaiAria,

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

@@ -1,2 +1,9 @@
+/**
+ * Rule that detects attributes that have no effect on their owner element.
+ *
+ * Checks each attribute's spec for ineffective conditions (CSS selectors)
+ * and reports when the owner element matches any of those conditions,
+ * meaning the attribute is present but has no practical effect.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
 export default _default;

package/lib/ineffective-attr/index.js

@@ -1,6 +1,13 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 import { toNoEmptyStringArrayFromStringOrArray } from '@markuplint/shared';
 import meta from './meta.js';
+/**
+ * Rule that detects attributes that have no effect on their owner element.
+ *
+ * Checks each attribute's spec for ineffective conditions (CSS selectors)
+ * and reports when the owner element matches any of those conditions,
+ * meaning the attribute is present but has no practical effect.
+ */
 export default createRule({
     meta: meta,
     defaultSeverity: 'warning',

package/lib/ineffective-attr/meta.d.ts

@@ -1,3 +1,4 @@
+/** Rule metadata for `ineffective-attr`: categorized as a style rule. */
 declare const _default: {
     readonly category: "style";
 };

package/lib/ineffective-attr/meta.js

@@ -1,3 +1,4 @@
+/** Rule metadata for `ineffective-attr`: categorized as a style rule. */
 export default {
     category: 'style',
 };