@markuplint/rules 4.11.2 → 4.18.0

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>>;
@@ -18,35 +30,35 @@ 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 | ({
+            value: import("@markuplint/ml-spec").AttributeType | ({
                 enum: [string, ...string[]];
             } | {
                 pattern: string;
             } | {
-                type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
+                type: import("@markuplint/ml-spec").AttributeType;
             });
         })[] | Record<string, {
             enum: [string, ...string[]];
         } | {
             pattern: string;
         } | {
-            type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
+            type: import("@markuplint/ml-spec").AttributeType;
         }>;
         disallowAttrs?: (string | {
             name: string;
-            value: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType | ({
+            value: import("@markuplint/ml-spec").AttributeType | ({
                 enum: [string, ...string[]];
             } | {
                 pattern: string;
             } | {
-                type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
+                type: import("@markuplint/ml-spec").AttributeType;
             });
         })[] | Record<string, {
             enum: [string, ...string[]];
         } | {
             pattern: string;
         } | {
-            type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
+            type: import("@markuplint/ml-spec").AttributeType;
         }>;
         ignoreAttrNamePrefix?: string | string[];
         allowToAddPropertiesForPretender?: boolean;
@@ -55,14 +67,14 @@ declare const rules: {
         } | {
             pattern: string;
         } | {
-            type: import("packages/@markuplint/ml-spec/lib/index.js").AttributeType;
+            type: import("@markuplint/ml-spec").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")[];
+        ignoreRoles: ("form" | ("main" | "banner" | "complementary" | "contentinfo") | "navigation" | "region")[];
         labelEachArea: boolean;
     }>>;
     readonly 'neighbor-popovers': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
@@ -78,7 +90,7 @@ 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("@markuplint/ml-spec").ARIAVersion;
         fragmentRefersNameAttr: boolean;
     }>>;
     readonly 'no-use-event-handler-attr': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
@@ -87,7 +99,7 @@ declare const rules: {
     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;
+        ariaVersion: import("@markuplint/ml-spec").ARIAVersion;
     }>>;
     readonly 'require-datetime': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
         langs?: import("./require-datetime/types.js").Lang[];
@@ -98,6 +110,7 @@ declare const rules: {
     })[], undefined>>;
     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 'table-row-column-alignment': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;

package/lib/index.js

@@ -1,3 +1,11 @@
+/**
+ * @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';
@@ -36,6 +44,10 @@ 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,

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',
 };

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

@@ -1,4 +1,7 @@
 import type { AttributeType } from '@markuplint/ml-spec';
+/**
+ * Configuration options for the `invalid-attr` rule.
+ */
 type Option = {
     /**
      * @since 3.7.0
@@ -8,7 +11,9 @@ type Option = {
      * @since 3.7.0
      */
     disallowAttrs?: (string | Attr)[] | Record<string, ValueRule>;
+    /** Attribute name prefix(es) to ignore during validation. */
     ignoreAttrNamePrefix?: string | string[];
+    /** Whether to allow additional properties for pretender elements (defaults to `true`). */
     allowToAddPropertiesForPretender?: boolean;
     /**
      * @deprecated Since version 3.7.0. Use `allowAttrs` or `disallowAttrs` instead.
@@ -22,10 +27,19 @@ type Option = {
         disallowed: true;
     }>;
 };
+/**
+ * Describes a single attribute with its name and expected value constraint.
+ */
 type Attr = {
+    /** The attribute name. */
     name: string;
+    /** The expected attribute value type or validation rule. */
     value: AttributeType | ValueRule;
 };
+/**
+ * A validation constraint for an attribute value, defined as either an
+ * enumerated list, a regex pattern, or a spec-based type.
+ */
 type ValueRule = {
     enum: [string, ...string[]];
 } | {
@@ -33,5 +47,15 @@ type ValueRule = {
 } | {
     type: AttributeType;
 };
+/**
+ * Rule that validates attributes against the HTML spec, allowed lists,
+ * and disallowed lists.
+ *
+ * Checks each attribute for: existence in the spec, correct value type,
+ * allowed/disallowed overrides from configuration, and typo suggestions
+ * via candidate matching. Supports `allowAttrs`, `disallowAttrs`, and
+ * the deprecated `attrs` option. Non-existent attributes on elements that
+ * allow additional properties (pretenders) can be optionally permitted.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Option>>;
 export default _default;

package/lib/invalid-attr/index.js

@@ -4,6 +4,16 @@ import { log as ruleLog } from '../debug.js';
 import { isValidAttr, match } from '../helpers.js';
 import meta from './meta.js';
 const log = ruleLog.extend('invalid-attr');
+/**
+ * Rule that validates attributes against the HTML spec, allowed lists,
+ * and disallowed lists.
+ *
+ * Checks each attribute for: existence in the spec, correct value type,
+ * allowed/disallowed overrides from configuration, and typo suggestions
+ * via candidate matching. Supports `allowAttrs`, `disallowAttrs`, and
+ * the deprecated `attrs` option. Non-existent attributes on elements that
+ * allow additional properties (pretenders) can be optionally permitted.
+ */
 export default createRule({
     meta: meta,
     defaultOptions: {},
@@ -216,6 +226,13 @@ export default createRule({
         });
     },
 });
+/**
+ * Determines whether the given value is a {@link ValueRule} (enum, pattern,
+ * or simple type constraint) as opposed to a raw {@link AttributeType}.
+ *
+ * @param value - The value to inspect.
+ * @returns `true` if the value is a {@link ValueRule}, `false` otherwise.
+ */
 function isValueRule(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 value) {

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

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

package/lib/invalid-attr/meta.js

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

package/lib/label-has-control/index.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Rule that validates `<label>` elements are properly associated with form controls.
+ *
+ * Checks that each label either wraps a control or has a `for` attribute,
+ * and warns when a label contains more than one form control (only the first
+ * is associated per the HTML spec).
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
 export default _default;

package/lib/label-has-control/index.js

@@ -1,6 +1,17 @@
 import { createRule } from '@markuplint/ml-core';
 import meta from './meta.js';
+/**
+ * CSS selector that matches form control elements eligible for label association.
+ * Excludes hidden inputs since they do not need labels.
+ */
 const controlSelector = ["input:not([type='hidden' i])", 'select', 'textarea'].join(',');
+/**
+ * Rule that validates `<label>` elements are properly associated with form controls.
+ *
+ * Checks that each label either wraps a control or has a `for` attribute,
+ * and warns when a label contains more than one form control (only the first
+ * is associated per the HTML spec).
+ */
 export default createRule({
     meta: meta,
     defaultSeverity: 'warning',

package/lib/label-has-control/meta.d.ts

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

package/lib/label-has-control/meta.js

@@ -1,3 +1,4 @@
+/** Rule metadata for the `label-has-control` rule, categorized as accessibility. */
 export default {
     category: 'a11y',
 };

package/lib/landmark-roles/index.d.ts

@@ -1,8 +1,22 @@
+/**
+ * Configuration options for the landmark-roles rule.
+ */
 type Options = {
+    /** Landmark roles to exclude from validation. */
     ignoreRoles: Roles[];
+    /** Whether to require a unique accessible name when duplicate landmark roles exist. */
     labelEachArea: boolean;
 };
+/** Landmark roles that should appear at the top level of the document. */
 type TopLevelRoles = 'banner' | 'main' | 'complementary' | 'contentinfo';
+/** All recognized ARIA landmark roles for this rule. */
 type Roles = TopLevelRoles | 'form' | 'navigation' | 'region';
+/**
+ * Rule that validates proper usage of ARIA landmark roles.
+ *
+ * Checks that `banner`, `main`, `complementary`, and `contentinfo` landmarks are
+ * top-level (not nested inside other landmarks), and that when duplicate landmarks
+ * of the same role exist, each has a unique accessible name.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Options>>;
 export default _default;

package/lib/landmark-roles/index.js

@@ -1,5 +1,6 @@
 import { createRule } from '@markuplint/ml-core';
 import meta from './meta.js';
+/** CSS selectors used to identify elements with each landmark role. */
 const selectors = {
     complementary: ['[role="complementary"]', 'aside'],
     contentinfo: ['[role="contentinfo"]'],
@@ -9,7 +10,15 @@ const selectors = {
     navigation: ['[role="navigation"]', 'nav'],
     region: ['[role="region"]', 'section[aria-labelledby]', 'section[aria-label]', 'section[title]'],
 };
+/** Roles that are required to be top-level landmarks per WAI-ARIA practices. */
 const topLevelRoles = ['banner', 'main', 'complementary', 'contentinfo'];
+/**
+ * Rule that validates proper usage of ARIA landmark roles.
+ *
+ * Checks that `banner`, `main`, `complementary`, and `contentinfo` landmarks are
+ * top-level (not nested inside other landmarks), and that when duplicate landmarks
+ * of the same role exist, each has a unique accessible name.
+ */
 export default createRule({
     meta: meta,
     defaultSeverity: 'warning',
@@ -105,11 +114,23 @@ export default createRule({
         }
     },
 });
+/**
+ * Collects all UUIDs of elements that have landmark roles.
+ *
+ * @param roleset - The mapping of roles to their matched elements.
+ * @returns A flat array of UUIDs for all landmark role elements.
+ */
 function landmarkRoleElementUUIDList(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 roleset) {
     return Object.values(roleset).flatMap(elements => elements.map(element => element.uuid));
 }
+/**
+ * Checks whether an element has an accessible label via `aria-label` or `aria-labelledby`.
+ *
+ * @param el - The landmark element to check.
+ * @returns `true` if the element has an accessible name, `false` otherwise.
+ */
 function hasLabel(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 el) {

package/lib/landmark-roles/meta.d.ts

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

package/lib/landmark-roles/meta.js

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

package/lib/neighbor-popovers/index.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Rule that detects perceptible content between a popover trigger and its target.
+ *
+ * When a `[popovertarget]` element or a `[commandfor]` element with a popover-related
+ * `command` attribute and its corresponding `[popover]` target exist in the DOM, any
+ * focusable elements, elements with accessible names, or non-whitespace text nodes
+ * between them are reported as violations.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
 export default _default;

package/lib/neighbor-popovers/index.js

@@ -2,13 +2,37 @@ import { createRule } from '@markuplint/ml-core';
 import { mayBeFocusable } from '@markuplint/ml-spec';
 import meta from './meta.js';
 // TODO: It will be received from config
+/** The ARIA specification version used for accessible name computation. */
 const ARIA_VERSION = '1.2';
+/**
+ * Command values from the Invoker Commands API that relate to popover behavior.
+ * Comparison is case-insensitive per the HTML spec.
+ */
+const POPOVER_COMMANDS = new Set(['toggle-popover', 'show-popover', 'hide-popover']);
+/**
+ * Rule that detects perceptible content between a popover trigger and its target.
+ *
+ * When a `[popovertarget]` element or a `[commandfor]` element with a popover-related
+ * `command` attribute and its corresponding `[popover]` target exist in the DOM, any
+ * focusable elements, elements with accessible names, or non-whitespace text nodes
+ * between them are reported as violations.
+ */
 export default createRule({
     meta: meta,
     verify({ document, report, t }) {
-        const triggers = document.querySelectorAll('[popovertarget]');
+        const triggers = document.querySelectorAll('[popovertarget], [commandfor]');
         Triggers: for (const trigger of triggers) {
-            const targetId = trigger.getAttribute('popovertarget');
+            let targetId = null;
+            const popovertarget = trigger.getAttribute('popovertarget');
+            if (popovertarget) {
+                targetId = popovertarget;
+            }
+            else {
+                const command = trigger.getAttribute('command');
+                if (command && POPOVER_COMMANDS.has(command.toLowerCase())) {
+                    targetId = trigger.getAttribute('commandfor');
+                }
+            }
             if (!targetId) {
                 continue;
             }

package/lib/neighbor-popovers/meta.d.ts

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

package/lib/neighbor-popovers/meta.js

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

package/lib/no-ambiguous-navigable-target-names/index.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Rule that warns against ambiguous navigable target names.
+ *
+ * Detects attribute values (e.g., `target`) that look like browsing context
+ * keywords (such as `_blank`, `_self`) but are missing the leading underscore,
+ * which would make them navigable target names instead of keywords. Suggests
+ * adding the underscore prefix when applicable.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;
 export default _default;

package/lib/no-ambiguous-navigable-target-names/index.js

@@ -1,6 +1,14 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 import { valueCheck } from '../attr-check.js';
 import meta from './meta.js';
+/**
+ * Rule that warns against ambiguous navigable target names.
+ *
+ * Detects attribute values (e.g., `target`) that look like browsing context
+ * keywords (such as `_blank`, `_self`) but are missing the leading underscore,
+ * which would make them navigable target names instead of keywords. Suggests
+ * adding the underscore prefix when applicable.
+ */
 export default createRule({
     meta: meta,
     defaultSeverity: 'warning',

package/lib/no-ambiguous-navigable-target-names/meta.d.ts

@@ -1,3 +1,4 @@
+/** Rule metadata for the `no-ambiguous-navigable-target-names` rule, categorized as accessibility. */
 declare const _default: {
     readonly category: "a11y";
 };

package/lib/no-ambiguous-navigable-target-names/meta.js

@@ -1,3 +1,4 @@
+/** Rule metadata for the `no-ambiguous-navigable-target-names` rule, categorized as accessibility. */
 export default {
     category: 'a11y',
 };

package/lib/no-boolean-attr-value/index.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Rule that disallows explicit values on boolean attributes.
+ *
+ * Checks each attribute against the HTML spec and reports when a boolean
+ * attribute (e.g., `disabled`, `checked`) is written with an explicit value
+ * such as `disabled="disabled"` instead of the bare attribute name.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
 export default _default;

package/lib/no-boolean-attr-value/index.js

@@ -1,5 +1,12 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 import meta from './meta.js';
+/**
+ * Rule that disallows explicit values on boolean attributes.
+ *
+ * Checks each attribute against the HTML spec and reports when a boolean
+ * attribute (e.g., `disabled`, `checked`) is written with an explicit value
+ * such as `disabled="disabled"` instead of the bare attribute name.
+ */
 export default createRule({
     meta: meta,
     defaultSeverity: 'warning',

package/lib/no-boolean-attr-value/meta.d.ts

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

package/lib/no-boolean-attr-value/meta.js

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

package/lib/no-consecutive-br/index.d.ts

@@ -1,2 +1,10 @@
+/**
+ * Rule that disallows consecutive `<br>` elements.
+ *
+ * Queries all `<br>` elements in the document and checks whether the next
+ * non-whitespace sibling is another `<br>`. Consecutive line breaks are
+ * typically a sign that a more semantic element (e.g., `<p>`) should be
+ * used instead, which is important for accessibility.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
 export default _default;

package/lib/no-consecutive-br/index.js

@@ -1,5 +1,13 @@
 import { createRule } from '@markuplint/ml-core';
 import meta from './meta.js';
+/**
+ * Rule that disallows consecutive `<br>` elements.
+ *
+ * Queries all `<br>` elements in the document and checks whether the next
+ * non-whitespace sibling is another `<br>`. Consecutive line breaks are
+ * typically a sign that a more semantic element (e.g., `<p>`) should be
+ * used instead, which is important for accessibility.
+ */
 export default createRule({
     meta: meta,
     defaultSeverity: 'warning',

package/lib/no-consecutive-br/meta.d.ts

@@ -1,3 +1,4 @@
+/** Rule metadata for `no-consecutive-br`: categorized as an accessibility rule. */
 declare const _default: {
     readonly category: "a11y";
 };

package/lib/no-consecutive-br/meta.js

@@ -1,3 +1,4 @@
+/** Rule metadata for `no-consecutive-br`: categorized as an accessibility rule. */
 export default {
     category: 'a11y',
 };

package/lib/no-default-value/index.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Rule that disallows explicitly setting an attribute to its default value.
+ *
+ * Looks up each attribute's default value from the spec and reports when
+ * the authored value matches the default, since the attribute can be
+ * omitted entirely for the same effect.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
 export default _default;

package/lib/no-default-value/index.js

@@ -1,6 +1,13 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 import { toNormalizedValue } from '../helpers.js';
 import meta from './meta.js';
+/**
+ * Rule that disallows explicitly setting an attribute to its default value.
+ *
+ * Looks up each attribute's default value from the spec and reports when
+ * the authored value matches the default, since the attribute can be
+ * omitted entirely for the same effect.
+ */
 export default createRule({
     meta: meta,
     defaultSeverity: 'warning',

package/lib/no-default-value/meta.d.ts

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

package/lib/no-default-value/meta.js

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

package/lib/no-duplicate-dt/index.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Rule that validates there are no duplicate `<dt>` elements within a `<dl>`.
+ *
+ * Iterates through each definition list and checks that no two `<dt>` elements
+ * (direct children or wrapped in `<div>`) share the same text content.
+ */
 declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
 export default _default;

package/lib/no-duplicate-dt/index.js

@@ -1,5 +1,11 @@
 import { createRule } from '@markuplint/ml-core';
 import meta from './meta.js';
+/**
+ * Rule that validates there are no duplicate `<dt>` elements within a `<dl>`.
+ *
+ * Iterates through each definition list and checks that no two `<dt>` elements
+ * (direct children or wrapped in `<div>`) share the same text content.
+ */
 export default createRule({
     meta: meta,
     verify({ document, report, t }) {

package/lib/no-duplicate-dt/meta.d.ts

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

package/lib/no-duplicate-dt/meta.js

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