@markuplint/rules 3.0.0-alpha.66 → 3.0.0-dev.176

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

@@ -1,2 +1,4 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+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,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
+const shared_1 = require("@markuplint/shared");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             const attrSpec = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
@@ -14,11 +15,7 @@ exports.default = (0, ml_core_1.createRule)({
             if (!spec) {
                 return;
             }
-            const ineffectiveConditions = spec.ineffective
-                ? Array.isArray(spec.ineffective)
-                    ? spec.ineffective
-                    : [spec.ineffective]
-                : [];
+            const ineffectiveConditions = (0, shared_1.toNoEmptyStringArrayFromStringOrArray)(spec.ineffective);
             if (ineffectiveConditions.some(selector => attr.ownerElement.matches(selector))) {
                 report({
                     scope: attr,

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

@@ -1,16 +1,44 @@
 import type { AttributeType } from '@markuplint/ml-spec';
-declare type Option = {
-    attrs?: Record<string, Rule>;
-    ignoreAttrNamePrefix?: string | string[];
+type Option = {
+	/**
+	 * @since 3.7.0
+	 */
+	allowAttrs?: (string | Attr)[] | Record<string, ValueRule>;
+	/**
+	 * @since 3.7.0
+	 */
+	disallowAttrs?: (string | Attr)[] | Record<string, ValueRule>;
+	ignoreAttrNamePrefix?: string | string[];
+	allowToAddPropertiesForPretender?: boolean;
+	/**
+	 * @deprecated Since version 3.7.0. Use `allowAttrs` or `disallowAttrs` instead.
+	 * This option (`attr`) is now considered ambiguous and may lead to confusion.
+	 * Please use the more explicit `allowAttrs` or `disallowAttrs` option
+	 * to specify allowed attributes for the `invalid-attr` rule.
+	 * @see {@link Option.allowAttrs}
+	 * @see {@link Option.disallowAttrs}
+	 */
+	attrs?: Record<
+		string,
+		| ValueRule
+		| {
+				disallowed: true;
+		  }
+	>;
 };
-declare type Rule = {
-    enum: [string, ...string[]];
-} | {
-    pattern: string;
-} | {
-    type: AttributeType;
-} | {
-    disallowed: true;
+type Attr = {
+	name: string;
+	value: AttributeType | ValueRule;
 };
-declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, Option>;
+type ValueRule =
+	| {
+			enum: [string, ...string[]];
+	  }
+	| {
+			pattern: string;
+	  }
+	| {
+			type: AttributeType;
+	  };
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<boolean, Option>>;
 export default _default;

package/lib/invalid-attr/index.js

@@ -9,14 +9,16 @@ exports.default = (0, ml_core_1.createRule)({
     defaultOptions: {},
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+            // Default
+            const allowToAddPropertiesForPretender = (_a = attr.rule.options.allowToAddPropertiesForPretender) !== null && _a !== void 0 ? _a : true;
             if (attr.isDirective) {
                 return;
             }
             const attrSpecs = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
             const attrName = attr.nameNode;
             const name = attr.name;
-            if (!attr.ownerElement.isCustomElement && attr.candidate) {
+            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);
@@ -31,50 +33,150 @@ exports.default = (0, ml_core_1.createRule)({
             }
             const valueNode = attr.valueNode;
             const value = attr.value;
-            if (attr.rule.option.ignoreAttrNamePrefix) {
-                const ignoreAttrNamePrefixes = Array.isArray(attr.rule.option.ignoreAttrNamePrefix)
-                    ? attr.rule.option.ignoreAttrNamePrefix
-                    : [attr.rule.option.ignoreAttrNamePrefix];
+            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 customRule = attr.rule.option.attrs ? attr.rule.option.attrs[name] : null;
-            if (customRule) {
-                if ('enum' in customRule) {
+            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] = { type: 'Any' };
+                            continue;
+                        }
+                        if (isValueRule(allowAttr.value)) {
+                            allowAttrs[allowAttr.name] = allowAttr.value;
+                            continue;
+                        }
+                        allowAttrs[allowAttr.name] = { type: allowAttr.value };
+                    }
+                }
+                else {
+                    for (const [attrName, valueRule] of Object.entries(attr.rule.options.allowAttrs)) {
+                        allowAttrs[attrName] = valueRule;
+                    }
+                }
+            }
+            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] = { type: 'Any' };
+                            continue;
+                        }
+                        if (isValueRule(disallowAttr.value)) {
+                            disallowAttrs[disallowAttr.name] = disallowAttr.value;
+                            continue;
+                        }
+                        disallowAttrs[disallowAttr.name] = { type: disallowAttr.value };
+                    }
+                }
+                else {
+                    for (const [attrName, valueRule] of Object.entries(attr.rule.options.disallowAttrs)) {
+                        disallowAttrs[attrName] = valueRule;
+                    }
+                }
+            }
+            if (attr.rule.options.attrs) {
+                for (const [attrName, valueRule] of Object.entries(attr.rule.options.attrs)) {
+                    if ('disallowed' in valueRule) {
+                        disallowAttrs[attrName] = { type: 'Any' };
+                    }
+                    else {
+                        allowAttrs[attrName] = valueRule;
+                    }
+                }
+            }
+            const allowValue = (_b = allowAttrs[name]) !== null && _b !== void 0 ? _b : null;
+            const disallowValue = (_c = disallowAttrs[name]) !== null && _c !== void 0 ? _c : null;
+            if (allowValue) {
+                if ('enum' in allowValue) {
                     invalid = (0, attr_check_1.attrCheck)(t, name.toLowerCase(), value, true, {
                         name,
                         type: {
-                            enum: customRule.enum,
+                            enum: allowValue.enum,
                         },
                         description: '',
                     });
                 }
-                else if ('pattern' in customRule) {
-                    if (!(0, helpers_1.match)(value, customRule.pattern)) {
+                else if ('pattern' in allowValue) {
+                    if (!(0, helpers_1.match)(value, allowValue.pattern)) {
+                        invalid = {
+                            invalidType: 'invalid-value',
+                            message: t('{0} is unmatched with the below patterns: {1}', t('the "{0*}" {1}', name, 'attribute'), allowValue.pattern),
+                        };
+                    }
+                }
+                else if ('type' in allowValue) {
+                    invalid = (0, attr_check_1.attrCheck)(t, name, value, true, { name, type: allowValue.type, description: '' });
+                }
+            }
+            else if (disallowValue) {
+                if ('enum' in disallowValue) {
+                    const checkResult = (0, attr_check_1.attrCheck)(t, name.toLowerCase(), value, true, {
+                        name,
+                        type: {
+                            enum: disallowValue.enum,
+                        },
+                        description: '',
+                    });
+                    if (checkResult === false) {
                         invalid = {
                             invalidType: 'invalid-value',
-                            message: t('{0} is unmatched with the below patterns: {1}', t('the "{0*}" {1}', name, 'attribute'), customRule.pattern),
+                            message: t('{0} is disallowed to accept the following values: {1}', t('the "{0*}" {1}', name, 'attribute'), t(disallowValue.enum)),
                         };
                     }
                 }
-                else if ('type' in customRule) {
-                    invalid = (0, attr_check_1.attrCheck)(t, name, value, true, { name, type: customRule.type, description: '' });
+                else if ('pattern' in disallowValue) {
+                    if ((0, helpers_1.match)(value, disallowValue.pattern)) {
+                        invalid = {
+                            invalidType: 'invalid-value',
+                            message: t('{0} is matched with the below disallowed patterns: {1}', t('the "{0*}" {1}', name, 'attribute'), disallowValue.pattern),
+                        };
+                    }
                 }
-                else if ('disallowed' in customRule && customRule.disallowed) {
-                    invalid = {
-                        invalidType: 'non-existent',
-                        message: t('{0} is disallowed', t('the "{0*}" {1}', name, 'attribute')),
-                    };
+                else if ('type' in disallowValue) {
+                    if (disallowValue.type === 'Any') {
+                        invalid = {
+                            invalidType: 'non-existent',
+                            message: t('{0} is disallowed', t('the "{0*}" {1}', name, 'attribute')),
+                        };
+                    }
+                    else {
+                        const checkResult = (0, attr_check_1.attrCheck)(t, name, value, true, {
+                            name,
+                            type: disallowValue.type,
+                            description: '',
+                        });
+                        if (checkResult === false) {
+                            invalid = {
+                                invalidType: 'invalid-value',
+                                message: t('{0} is disallowed', t('{0} of {1}', t('the {0}', 'type'), t('the "{0*}" {1}', name, 'attribute'))),
+                            };
+                        }
+                    }
                 }
             }
-            else if (!attr.ownerElement.isCustomElement && attrSpecs) {
+            else if (attr.ownerElement.elementType === 'html' && attrSpecs) {
                 log('Checking %s[%s="%s"]', attr.nodeName, name, value);
                 invalid = (0, helpers_1.isValidAttr)(t, name, value, attr.isDynamicValue || false, attr.ownerElement, attrSpecs, log);
             }
-            if (invalid) {
+            if (invalid !== false) {
                 switch (invalid.invalidType) {
+                    case 'disallowed-attr': {
+                        report({
+                            scope: attr,
+                            message: invalid.message,
+                        });
+                        break;
+                    }
                     case 'invalid-value': {
                         if (attr.isDynamicValue) {
                             break;
@@ -82,16 +184,19 @@ exports.default = (0, ml_core_1.createRule)({
                         report({
                             scope: attr,
                             message: invalid.message,
-                            line: ((_a = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startLine) !== null && _a !== void 0 ? _a : 0) + ((_c = (_b = invalid.loc) === null || _b === void 0 ? void 0 : _b.line) !== null && _c !== void 0 ? _c : 0),
-                            col: ((_d = invalid.loc) === null || _d === void 0 ? void 0 : _d.line)
-                                ? ((_e = invalid.loc) === null || _e === void 0 ? void 0 : _e.col) + 1
-                                : ((_f = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startCol) !== null && _f !== void 0 ? _f : 0) + ((_h = (_g = invalid.loc) === null || _g === void 0 ? void 0 : _g.col) !== null && _h !== void 0 ? _h : 0),
-                            raw: (_k = (_j = invalid.loc) === null || _j === void 0 ? void 0 : _j.raw) !== null && _k !== void 0 ? _k : value,
+                            line: ((_d = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startLine) !== null && _d !== void 0 ? _d : 0) + ((_f = (_e = invalid.loc) === null || _e === void 0 ? void 0 : _e.line) !== null && _f !== void 0 ? _f : 0),
+                            col: invalid.loc && invalid.loc.line > 0
+                                ? ((_g = invalid.loc) === null || _g === void 0 ? void 0 : _g.col) + 1
+                                : ((_h = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startCol) !== null && _h !== void 0 ? _h : 0) + ((_k = (_j = invalid.loc) === null || _j === void 0 ? void 0 : _j.col) !== null && _k !== void 0 ? _k : 0),
+                            raw: (_m = (_l = invalid.loc) === null || _l === void 0 ? void 0 : _l.raw) !== null && _m !== void 0 ? _m : value,
                         });
                         break;
                     }
                     case 'non-existent': {
-                        const spec = (0, ml_core_1.getSpec)(attr.ownerElement, document.specs);
+                        if (allowToAddPropertiesForPretender && ((_o = attr.ownerElement.pretenderContext) === null || _o === void 0 ? void 0 : _o.type) === 'origin') {
+                            return;
+                        }
+                        const spec = (0, ml_core_1.getSpec)(attr.ownerElement, document.specs.specs);
                         if (spec === null || spec === void 0 ? void 0 : spec.possibleToAddProperties) {
                             return;
                         }
@@ -108,3 +213,29 @@ exports.default = (0, ml_core_1.createRule)({
         });
     },
 });
+function isValueRule(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+value) {
+    if (typeof value === 'string') {
+        return false;
+    }
+    if ('enum' in value) {
+        if (Object.keys(value).length > 1) {
+            return false;
+        }
+        return true;
+    }
+    if ('token' in value) {
+        return false;
+    }
+    if ('pattern' in value) {
+        return true;
+    }
+    if (value.type === 'integer' || value.type === 'float') {
+        return false;
+    }
+    if (Object.keys(value).length > 1) {
+        return false;
+    }
+    return true;
+}

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

@@ -0,0 +1,4 @@
+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

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ml_core_1 = require("@markuplint/ml-core");
+const controlSelector = ["input:not([type='hidden' i])", 'select', 'textarea'].join(',');
+exports.default = (0, ml_core_1.createRule)({
+    defaultSeverity: 'warning',
+    async verify({ document, report, t }) {
+        await document.walkOn('Element', el => {
+            if (el.localName !== 'label') {
+                return;
+            }
+            if (el.children.length === 0 && !el.hasAttribute('for')) {
+                report({
+                    scope: el,
+                    message: t('{0} should associate with {1}', t('The "{0*}" {1}', 'label', 'element'), t('a {0}', 'control')),
+                });
+            }
+            const controls = el.querySelectorAll(controlSelector);
+            const secondControl = controls[1];
+            if (secondControl) {
+                report({
+                    scope: secondControl,
+                    message: t('{0} associates only {1}', t('The "{0*}" {1}', 'label', 'element'), t('first {0}', 'control')),
+                });
+            }
+        });
+    },
+});

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

@@ -1,8 +1,8 @@
-declare type Options = {
-    ignoreRoles: Roles[];
-    labelEachArea: boolean;
+type Options = {
+	ignoreRoles: Roles[];
+	labelEachArea: boolean;
 };
-declare type TopLevelRoles = 'banner' | 'main' | 'complementary' | 'contentinfo';
-declare type Roles = TopLevelRoles | 'form' | 'navigation' | 'region';
-declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, Options>;
+type TopLevelRoles = 'banner' | 'main' | 'complementary' | 'contentinfo';
+type Roles = TopLevelRoles | 'form' | 'navigation' | 'region';
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<boolean, Options>>;
 export default _default;

package/lib/landmark-roles/index.js

@@ -12,7 +12,7 @@ const selectors = {
 };
 const topLevelRoles = ['banner', 'main', 'complementary', 'contentinfo'];
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     defaultOptions: {
         ignoreRoles: [],
         labelEachArea: true,
@@ -72,7 +72,7 @@ exports.default = (0, ml_core_1.createRule)({
                 if (el.rule.disabled) {
                     continue;
                 }
-                if ((_a = el.rule.option.ignoreRoles) === null || _a === void 0 ? void 0 : _a.includes(role)) {
+                if ((_a = el.rule.options.ignoreRoles) === null || _a === void 0 ? void 0 : _a.includes(role)) {
                     continue;
                 }
                 if (el.isDescendantByUUIDList(uuidList)) {
@@ -93,7 +93,7 @@ exports.default = (0, ml_core_1.createRule)({
                 if (el.rule.disabled) {
                     continue;
                 }
-                if (!el.rule.option.labelEachArea) {
+                if (!el.rule.options.labelEachArea) {
                     continue;
                 }
                 if (!hasLabel(el)) {
@@ -106,13 +106,17 @@ exports.default = (0, ml_core_1.createRule)({
         }
     },
 });
-function landmarkRoleElementUUIDList(roleset) {
+function landmarkRoleElementUUIDList(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+roleset) {
     return Object.values(roleset)
         .map(elements => elements.map(element => element.uuid))
         .flat();
 }
-function hasLabel(el) {
-    const hasHeading = !!el.querySelectorAll('h1, h2, h3, h4, h5, h6').length;
+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;
     }

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

@@ -1,2 +1,4 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+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

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             var _a, _b;

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

@@ -1,2 +1,4 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 const helpers_1 = require("../helpers");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             var _a, _b, _c;

package/lib/no-empty-palpable-content/index.d.ts

@@ -0,0 +1,6 @@
+type Options = {
+	extendsExposableElements?: boolean;
+	ignoreIfAriaBusy?: boolean;
+};
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<boolean, Options>>;
+export default _default;

package/lib/no-empty-palpable-content/index.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ml_core_1 = require("@markuplint/ml-core");
+const ml_spec_1 = require("@markuplint/ml-spec");
+exports.default = (0, ml_core_1.createRule)({
+    defaultSeverity: 'warning',
+    defaultOptions: {
+        extendsExposableElements: true,
+        ignoreIfAriaBusy: true,
+    },
+    async verify({ document, report, t }) {
+        await document.walkOn('Element', el => {
+            /**
+             * Exception
+             *
+             * - The `textarea` element is possibly empty because a user inputs it.
+             */
+            if (el.localName === 'textarea') {
+                return;
+            }
+            if (!(0, ml_spec_1.isPalpableElement)(el, el.ownerMLDocument.specs, {
+                extendsSvg: false,
+                extendsExposableElements: el.rule.options.extendsExposableElements,
+            })) {
+                return;
+            }
+            if ((0, ml_spec_1.isNothingContentModel)(el)) {
+                return;
+            }
+            if (el.rule.options.ignoreIfAriaBusy && el.getAttribute('aria-busy') === 'true') {
+                return;
+            }
+            const isEmpty = Array.from(el.childNodes).every(node => node.is(node.TEXT_NODE) && node.isWhitespace());
+            if (isEmpty) {
+                report({
+                    scope: el,
+                    message: t('{0} should not {1}', t('the {0}', 'element'), 'empty'),
+                });
+            }
+        });
+    },
+});

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

@@ -1,2 +1,4 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+declare const _default: Readonly<
+	import('@markuplint/ml-core').RuleSeed<import('@markuplint/ml-core').RuleConfigValue, undefined>
+>;
 export default _default;

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

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         if (!document.isFragment) {
             return;

package/lib/no-refer-to-non-existent-id/index.d.ts

@@ -1,5 +1,10 @@
-import type { ARIAVersion } from '@markuplint/ml-spec';
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, {
-    ariaVersion: ARIAVersion;
-}>;
+declare const _default: Readonly<
+	import('@markuplint/ml-core').RuleSeed<
+		import('@markuplint/ml-core').RuleConfigValue,
+		{
+			ariaVersion: '1.1' | '1.2' | '1.3';
+			fragmentRefersNameAttr: boolean;
+		}
+	>
+>;
 export default _default;