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

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

@@ -1,5 +0,0 @@
-/** Rule metadata for `deprecated-attr`: categorized as a validation rule. */
-declare const _default: {
-    readonly category: "validation";
-};
-export default _default;

package/lib/deprecated-attr/meta.js

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

package/lib/deprecated-element/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * Rule that reports the use of deprecated or obsolete HTML elements.
- *
- * Walks HTML and SVG elements and checks their spec status. Reports any
- * element that is marked as deprecated or obsolete in the HTML specification.
- */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
-export default _default;

package/lib/deprecated-element/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for `deprecated-element`: categorized as a validation rule. */
-declare const _default: {
-    readonly category: "validation";
-};
-export default _default;

package/lib/deprecated-element/meta.js

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

package/lib/disallowed-element/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * Rule that disallows elements matching the configured CSS selectors.
- *
- * Accepts an array of selector strings as its value. Queries the document
- * (and per-element overrides) for matching elements and reports each one
- * as disallowed.
- */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<string[], undefined>>;
-export default _default;

package/lib/disallowed-element/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for `disallowed-element`: categorized as a validation rule. */
-declare const _default: {
-    readonly category: "validation";
-};
-export default _default;

package/lib/disallowed-element/meta.js

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

package/lib/doctype/index.d.ts

@@ -1,15 +0,0 @@
-/** Configuration options for the doctype rule. */
-type Option = {
-    /** Whether to report obsolete doctypes that include a public or system identifier. */
-    denyObsoleteType: boolean;
-};
-/**
- * Rule that validates the presence and correctness of the document's DOCTYPE
- * declaration.
- *
- * Reports an error when no DOCTYPE is found (skipped for document fragments)
- * and when an obsolete DOCTYPE (one with a public or system identifier) is
- * declared.
- */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<"always", Option>>;
-export default _default;

package/lib/doctype/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for `doctype`: categorized as a validation rule. */
-declare const _default: {
-    readonly category: "validation";
-};
-export default _default;

package/lib/doctype/meta.js

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

package/lib/end-tag/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * Rule that checks for missing end tags on non-void HTML elements.
- *
- * Reports elements that are neither void nor self-closing and have no
- * closing tag. Omitted elements and elements in documents configured
- * with `endTag: 'never'` are excluded.
- */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;
-export default _default;

package/lib/end-tag/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for `end-tag`: categorized as a style rule. */
-declare const _default: {
-    readonly category: "style";
-};
-export default _default;

package/lib/end-tag/meta.js

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

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

@@ -1,8 +0,0 @@
-/**
- * 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).
- */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, null>>;
-export default _default;

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

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

package/lib/heading-levels/meta.js

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

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

@@ -1,9 +0,0 @@
-/**
- * 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/meta.d.ts

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

package/lib/id-duplication/meta.js

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

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

@@ -1,9 +0,0 @@
-/**
- * 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/meta.d.ts

@@ -1,6 +0,0 @@
-/** Rule metadata for `ineffective-attr`: categorized as a style rule. */
-declare const _default: {
-    readonly category: "style";
-    readonly fixable: true;
-};
-export default _default;

package/lib/ineffective-attr/meta.js

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

package/lib/invalid-attr/index.js

@@ -1,207 +0,0 @@
-import { createRule, getAttrSpecs, getSpec } from '@markuplint/ml-core';
-import { check, isEnum, isPattern } from '@markuplint/types';
-import { attrCheck } from '../attr-check.js';
-import { log as ruleLog } from '../debug.js';
-import { isValidAttr } 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` and `disallowAttrs`.
- * Non-existent attributes on elements that allow additional properties
- * (pretenders) can be optionally permitted.
- */
-export default createRule({
-    meta: meta,
-    defaultOptions: {},
-    async verify({ document, report, t }) {
-        await document.walkOn('Attr', attr => {
-            // Default
-            const allowToAddPropertiesForPretender = attr.rule.options.allowToAddPropertiesForPretender ?? true;
-            if (attr.isDirective) {
-                return;
-            }
-            // https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is
-            // "The is attribute must not be specified on an autonomous custom element"
-            if (attr.name === 'is' && attr.ownerElement.elementType === 'web-component') {
-                report({
-                    scope: attr,
-                    line: attr.nameNode?.startLine,
-                    col: attr.nameNode?.startCol,
-                    raw: attr.nameNode?.raw,
-                    message: t('The "{0}" attribute must not be specified on an autonomous custom element', 'is'),
-                });
-                return;
-            }
-            const attrSpecs = getAttrSpecs(attr.ownerElement, document.specs);
-            const attrName = attr.nameNode;
-            const name = attr.name;
-            if (attr.ownerElement.elementType === 'html' && attr.candidate) {
-                const message = t('{0} is {1:c}', t('the "{0*}" {1}', name, 'attribute'), 'disallowed') +
-                    t('. ') +
-                    t('Did you mean "{0}"?', attr.candidate);
-                report({
-                    scope: attr,
-                    line: attrName?.startLine,
-                    col: attrName?.startCol,
-                    raw: attrName?.raw,
-                    message: message,
-                });
-                return;
-            }
-            const valueNode = attr.valueNode;
-            const value = attr.value;
-            if (attr.rule.options.ignoreAttrNamePrefix != null) {
-                const ignoreAttrNamePrefixes = Array.isArray(attr.rule.options.ignoreAttrNamePrefix)
-                    ? attr.rule.options.ignoreAttrNamePrefix
-                    : [attr.rule.options.ignoreAttrNamePrefix];
-                if (ignoreAttrNamePrefixes.some(prefix => name.indexOf(prefix) === 0)) {
-                    return;
-                }
-            }
-            let invalid = false;
-            const allowAttrs = {};
-            const disallowAttrs = {};
-            if (attr.rule.options.allowAttrs) {
-                if (Array.isArray(attr.rule.options.allowAttrs)) {
-                    for (const allowAttr of attr.rule.options.allowAttrs) {
-                        if (typeof allowAttr === 'string') {
-                            allowAttrs[allowAttr] = 'Any';
-                            continue;
-                        }
-                        allowAttrs[allowAttr.name] = allowAttr.value;
-                    }
-                }
-                else {
-                    for (const [attrName, attrType] of Object.entries(attr.rule.options.allowAttrs)) {
-                        allowAttrs[attrName] = attrType;
-                    }
-                }
-            }
-            if (attr.rule.options.disallowAttrs) {
-                if (Array.isArray(attr.rule.options.disallowAttrs)) {
-                    for (const disallowAttr of attr.rule.options.disallowAttrs) {
-                        if (typeof disallowAttr === 'string') {
-                            disallowAttrs[disallowAttr] = 'Any';
-                            continue;
-                        }
-                        disallowAttrs[disallowAttr.name] = disallowAttr.value;
-                    }
-                }
-                else {
-                    for (const [attrName, attrType] of Object.entries(attr.rule.options.disallowAttrs)) {
-                        disallowAttrs[attrName] = attrType;
-                    }
-                }
-            }
-            const allowValue = allowAttrs[name] ?? null;
-            const disallowValue = disallowAttrs[name] ?? null;
-            if (allowValue !== null) {
-                invalid = attrCheck(t, name, value, true, {
-                    name,
-                    type: allowValue,
-                    description: '',
-                });
-            }
-            else if (disallowValue !== null) {
-                if (disallowValue === 'Any') {
-                    invalid = {
-                        invalidType: 'non-existent',
-                        message: t('{0} is disallowed', t('the "{0*}" {1}', name, 'attribute')),
-                    };
-                }
-                else {
-                    const checkResult = isPattern(disallowValue)
-                        ? check(value, disallowValue)
-                        : attrCheck(t, name, value, true, {
-                            name,
-                            type: disallowValue,
-                            description: '',
-                        });
-                    const isMatched = isPattern(disallowValue)
-                        ? checkResult.matched
-                        : checkResult === false;
-                    if (isMatched) {
-                        invalid = {
-                            invalidType: 'invalid-value',
-                            message: createDisallowMessage(t, name, disallowValue),
-                        };
-                    }
-                }
-            }
-            else if (attr.ownerElement.elementType === 'html' && attrSpecs) {
-                log('Checking %s[%s="%s"]', attr.nodeName, name, value);
-                invalid = isValidAttr(t, name, value, attr.isDynamicValue || false, attr.ownerElement, attrSpecs, log);
-            }
-            const invalidList = Array.isArray(invalid) ? invalid : [invalid];
-            for (const invalid of invalidList) {
-                if (invalid !== false) {
-                    switch (invalid.invalidType) {
-                        case 'disallowed-attr': {
-                            report({
-                                scope: attr,
-                                message: invalid.message,
-                            });
-                            break;
-                        }
-                        case 'invalid-value': {
-                            if (attr.isDynamicValue) {
-                                break;
-                            }
-                            report({
-                                scope: attr,
-                                message: invalid.message,
-                                line: (valueNode?.startLine ?? 0) + (invalid.loc?.line ?? 0),
-                                col: invalid.loc && invalid.loc.line > 0
-                                    ? invalid.loc?.col + 1
-                                    : (valueNode?.startCol ?? 0) + (invalid.loc?.col ?? 0),
-                                raw: invalid.loc?.raw ?? value,
-                            });
-                            break;
-                        }
-                        case 'non-existent': {
-                            if (allowToAddPropertiesForPretender &&
-                                attr.ownerElement.pretenderContext?.type === 'origin') {
-                                return;
-                            }
-                            const spec = getSpec(attr.ownerElement, document.specs.specs);
-                            if (spec?.possibleToAddProperties) {
-                                return;
-                            }
-                            report({
-                                scope: attr,
-                                message: invalid.message,
-                                line: attrName?.startLine,
-                                col: attrName?.startCol,
-                                raw: attrName?.raw,
-                            });
-                        }
-                    }
-                }
-            }
-        });
-    },
-});
-/**
- * Creates an appropriate disallow message based on the type structure.
- *
- * @param t - The i18n translator
- * @param name - The attribute name
- * @param type - The attribute type or pattern
- * @returns A localized message string
- */
-function createDisallowMessage(t, name, 
-// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
-type) {
-    if (isPattern(type)) {
-        return t('{0} is matched with the below disallowed patterns: {1}', t('the "{0*}" {1}', name, 'attribute'), type.pattern);
-    }
-    if (typeof type !== 'string' && isEnum(type)) {
-        return t('{0} is disallowed to accept the following values: {1}', t('the "{0*}" {1}', name, 'attribute'), t(type.enum));
-    }
-    return t('{0} is disallowed', t('{0} of {1}', t('the {0}', 'type'), t('the "{0*}" {1}', name, 'attribute')));
-}

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

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

package/lib/invalid-attr/meta.js

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

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

@@ -1,22 +0,0 @@
-/**
- * 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' | 'contentinfo';
-/** All recognized ARIA landmark roles for this rule. */
-type Roles = TopLevelRoles | 'complementary' | 'form' | 'navigation' | 'region';
-/**
- * Rule that validates proper usage of ARIA landmark roles.
- *
- * Checks that `banner`, `main`, 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,142 +0,0 @@
-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"]'],
-    form: ['[role="form"]', 'form[aria-labelledby]', 'form[aria-label]', 'form[title]'],
-    banner: ['[role="banner"]'],
-    main: ['[role="main"]', 'main'],
-    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', 'contentinfo'];
-/**
- * Rule that validates proper usage of ARIA landmark roles.
- *
- * Checks that `banner`, `main`, 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',
-    defaultOptions: {
-        ignoreRoles: [],
-        labelEachArea: true,
-    },
-    verify({ document, report, t }) {
-        if (document.isFragment) {
-            return;
-        }
-        const roles = {
-            complementary: [...document.querySelectorAll(selectors.complementary.join(','))],
-            contentinfo: [...document.querySelectorAll(selectors.contentinfo.join(','))],
-            form: [...document.querySelectorAll(selectors.form.join(','))],
-            banner: [...document.querySelectorAll(selectors.banner.join(','))],
-            main: [...document.querySelectorAll(selectors.main.join(','))],
-            navigation: [...document.querySelectorAll(selectors.navigation.join(','))],
-            region: [...document.querySelectorAll(selectors.region.join(','))],
-        };
-        /**
-         * `<header>`
-         *
-         * @cite https://www.w3.org/TR/wai-aria-practices/examples/landmarks/HTML5.html
-         *
-         * > When in context of the body element. The header element is not a banner landmark when it is a descendant of the following HTML sectioning elements:
-         * > - article
-         * > - aside
-         * > - main
-         * > - nav
-         * > - section
-         */
-        const headers = [...document.querySelectorAll('header')].filter(header => {
-            return !header.closest('article, aside, main, nav, section');
-        });
-        roles.banner.push(...headers);
-        /**
-         * `<footer>`
-         *
-         * @cite https://www.w3.org/TR/wai-aria-practices/examples/landmarks/HTML5.html
-         *
-         * > When in context of the body element. The footer element is not a contentinfo landmark when it is a descendant of the following HTML sectioning elements:
-         * > - article
-         * > - aside
-         * > - main
-         * > - nav
-         * > - section
-         */
-        const footers = [...document.querySelectorAll('footer')].filter(footer => {
-            return !footer.closest('article, aside, main, nav, section');
-        });
-        roles.contentinfo.push(...footers);
-        const uuidList = landmarkRoleElementUUIDList(roles);
-        // @cite https://www.w3.org/TR/wai-aria-practices/examples/landmarks/index.html
-        // > `banner`, `main`, `complementary` and `contentinfo` landmarks should be top level landmarks.
-        for (const role of topLevelRoles) {
-            const elements = roles[role];
-            for (const el of elements) {
-                if (el.rule.disabled) {
-                    continue;
-                }
-                if (el.rule.options.ignoreRoles?.includes(role)) {
-                    continue;
-                }
-                if (el.isDescendantByUUIDList(uuidList)) {
-                    report({
-                        scope: el,
-                        message: t('{0} should be {1}', t('the "{0*}" {1}', role, 'role'), 'top level'),
-                    });
-                }
-            }
-        }
-        for (const role of Object.keys(roles)) {
-            const roleEls = roles[role];
-            const duplicated = 1 < roleEls.length;
-            if (!duplicated) {
-                continue;
-            }
-            for (const el of roleEls) {
-                if (el.rule.disabled) {
-                    continue;
-                }
-                if (!el.rule.options.labelEachArea) {
-                    continue;
-                }
-                if (!hasLabel(el)) {
-                    report({
-                        scope: el,
-                        message: t('Require {0}', t('unique {0}', 'accessible name')),
-                    });
-                }
-            }
-        }
-    },
-});
-/**
- * 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) {
-    const hasHeading = el.querySelectorAll('h1, h2, h3, h4, h5, h6').length > 0;
-    if (hasHeading && el.matches('[aria-labelledby]')) {
-        return true;
-    }
-    return el.matches('[aria-label]');
-}

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

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

package/lib/landmark-roles/meta.js

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

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

@@ -1,10 +0,0 @@
-/**
- * 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/meta.d.ts

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

package/lib/neighbor-popovers/meta.js

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

package/lib/no-hard-code-id/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * Rule that disallows hard-coded `id` attribute values in document fragments.
- *
- * Only active for fragment documents (e.g., component templates). Reports
- * any `id` attribute whose value is a static string rather than a dynamic
- * or code-generated value, encouraging dynamic ID generation to avoid
- * collisions when fragments are reused.
- */
-declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
-export default _default;

package/lib/no-hard-code-id/meta.d.ts

@@ -1,5 +0,0 @@
-/** Rule metadata for `no-hard-code-id`: categorized as a maintainability rule. */
-declare const _default: {
-    readonly category: "maintainability";
-};
-export default _default;

package/lib/no-hard-code-id/meta.js

@@ -1,4 +0,0 @@
-/** Rule metadata for `no-hard-code-id`: categorized as a maintainability rule. */
-export default {
-    category: 'maintainability',
-};