@markuplint/rules 3.0.0-dev.25 → 3.0.0-dev.290

package/lib/invalid-attr/index.js

@@ -1,21 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ml_core_1 = require("@markuplint/ml-core");
-const attr_check_1 = require("../attr-check");
-const debug_1 = require("../debug");
-const helpers_1 = require("../helpers");
-const log = debug_1.log.extend('invalid-attr');
-exports.default = (0, ml_core_1.createRule)({
+import { createRule, getAttrSpecs, getSpec } from '@markuplint/ml-core';
+import { attrCheck } from '../attr-check.js';
+import { log as ruleLog } from '../debug.js';
+import { isValidAttr, match } from '../helpers.js';
+const log = ruleLog.extend('invalid-attr');
+export default createRule({
     defaultOptions: {},
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
             // Default
-            const allowToAddPropertiesForPretender = (_a = attr.rule.options.allowToAddPropertiesForPretender) !== null && _a !== void 0 ? _a : true;
+            const allowToAddPropertiesForPretender = attr.rule.options.allowToAddPropertiesForPretender ?? true;
             if (attr.isDirective) {
                 return;
             }
-            const attrSpecs = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
+            const attrSpecs = getAttrSpecs(attr.ownerElement, document.specs);
             const attrName = attr.nameNode;
             const name = attr.name;
             if (attr.ownerElement.elementType === 'html' && attr.candidate) {
@@ -24,16 +21,16 @@ exports.default = (0, ml_core_1.createRule)({
                     t('Did you mean "{0}"?', attr.candidate);
                 report({
                     scope: attr,
-                    line: attrName === null || attrName === void 0 ? void 0 : attrName.startLine,
-                    col: attrName === null || attrName === void 0 ? void 0 : attrName.startCol,
-                    raw: attrName === null || attrName === void 0 ? void 0 : attrName.raw,
+                    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) {
+            if (attr.rule.options.ignoreAttrNamePrefix != null) {
                 const ignoreAttrNamePrefixes = Array.isArray(attr.rule.options.ignoreAttrNamePrefix)
                     ? attr.rule.options.ignoreAttrNamePrefix
                     : [attr.rule.options.ignoreAttrNamePrefix];
@@ -42,41 +39,141 @@ exports.default = (0, ml_core_1.createRule)({
                 }
             }
             let invalid = false;
-            const customRule = attr.rule.options.attrs ? attr.rule.options.attrs[name] : null;
-            if (customRule) {
-                if ('enum' in customRule) {
-                    invalid = (0, attr_check_1.attrCheck)(t, name.toLowerCase(), value, true, {
+            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 = allowAttrs[name] ?? null;
+            const disallowValue = disallowAttrs[name] ?? null;
+            if (allowValue) {
+                if ('enum' in allowValue) {
+                    invalid = 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 (!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 = attrCheck(t, name, value, true, { name, type: allowValue.type, description: '' });
+                }
+            }
+            else if (disallowValue) {
+                if ('enum' in disallowValue) {
+                    const checkResult = 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 (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 = 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.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);
+                invalid = 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;
@@ -84,28 +181,28 @@ exports.default = (0, ml_core_1.createRule)({
                         report({
                             scope: attr,
                             message: invalid.message,
-                            line: ((_b = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startLine) !== null && _b !== void 0 ? _b : 0) + ((_d = (_c = invalid.loc) === null || _c === void 0 ? void 0 : _c.line) !== null && _d !== void 0 ? _d : 0),
-                            col: ((_e = invalid.loc) === null || _e === void 0 ? void 0 : _e.line)
-                                ? ((_f = invalid.loc) === null || _f === void 0 ? void 0 : _f.col) + 1
-                                : ((_g = valueNode === null || valueNode === void 0 ? void 0 : valueNode.startCol) !== null && _g !== void 0 ? _g : 0) + ((_j = (_h = invalid.loc) === null || _h === void 0 ? void 0 : _h.col) !== null && _j !== void 0 ? _j : 0),
-                            raw: (_l = (_k = invalid.loc) === null || _k === void 0 ? void 0 : _k.raw) !== null && _l !== void 0 ? _l : value,
+                            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 && ((_m = attr.ownerElement.pretenderContext) === null || _m === void 0 ? void 0 : _m.type) === 'origin') {
+                        if (allowToAddPropertiesForPretender && attr.ownerElement.pretenderContext?.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) {
+                        const spec = getSpec(attr.ownerElement, document.specs.specs);
+                        if (spec?.possibleToAddProperties) {
                             return;
                         }
                         report({
                             scope: attr,
                             message: invalid.message,
-                            line: attrName === null || attrName === void 0 ? void 0 : attrName.startLine,
-                            col: attrName === null || attrName === void 0 ? void 0 : attrName.startCol,
-                            raw: attrName === null || attrName === void 0 ? void 0 : attrName.raw,
+                            line: attrName?.startLine,
+                            col: attrName?.startCol,
+                            raw: attrName?.raw,
                         });
                     }
                 }
@@ -113,3 +210,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

@@ -1,2 +1,2 @@
-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/label-has-control/index.js

@@ -1,8 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ml_core_1 = require("@markuplint/ml-core");
+import { createRule } from '@markuplint/ml-core';
 const controlSelector = ["input:not([type='hidden' i])", 'select', 'textarea'].join(',');
-exports.default = (0, ml_core_1.createRule)({
+export default createRule({
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {

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

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

package/lib/landmark-roles/index.js

@@ -1,6 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ml_core_1 = require("@markuplint/ml-core");
+import { createRule } from '@markuplint/ml-core';
 const selectors = {
     complementary: ['[role="complementary"]', 'aside'],
     contentinfo: ['[role="contentinfo"]'],
@@ -11,14 +9,13 @@ const selectors = {
     region: ['[role="region"]', 'section[aria-labelledby]', 'section[aria-label]', 'section[title]'],
 };
 const topLevelRoles = ['banner', 'main', 'complementary', 'contentinfo'];
-exports.default = (0, ml_core_1.createRule)({
+export default createRule({
     defaultSeverity: 'warning',
     defaultOptions: {
         ignoreRoles: [],
         labelEachArea: true,
     },
     verify({ document, report, t }) {
-        var _a;
         if (document.isFragment) {
             return;
         }
@@ -72,7 +69,7 @@ exports.default = (0, ml_core_1.createRule)({
                 if (el.rule.disabled) {
                     continue;
                 }
-                if ((_a = el.rule.options.ignoreRoles) === null || _a === void 0 ? void 0 : _a.includes(role)) {
+                if (el.rule.options.ignoreRoles?.includes(role)) {
                     continue;
                 }
                 if (el.isDescendantByUUIDList(uuidList)) {
@@ -106,13 +103,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,2 @@
-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

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ml_core_1 = require("@markuplint/ml-core");
-exports.default = (0, ml_core_1.createRule)({
+import { createRule, getAttrSpecs } from '@markuplint/ml-core';
+export default createRule({
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
-            var _a, _b;
-            const attrSpec = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
+            const attrSpec = getAttrSpecs(attr.ownerElement, document.specs);
             if (!attrSpec) {
                 return;
             }
@@ -29,12 +26,12 @@ exports.default = (0, ml_core_1.createRule)({
                 attr.valueNode,
                 attr.endQuote,
             ];
-            const extraRaw = extraTokens.reduce((raw, t) => { var _a; return raw + ((_a = t === null || t === void 0 ? void 0 : t.raw) !== null && _a !== void 0 ? _a : ''); }, '');
+            const extraRaw = extraTokens.reduce((raw, t) => raw + (t?.raw ?? ''), '');
             if (extraRaw) {
                 report({
                     scope: attr,
-                    line: (_a = attr.spacesBeforeEqual) === null || _a === void 0 ? void 0 : _a.startLine,
-                    col: (_b = attr.spacesBeforeEqual) === null || _b === void 0 ? void 0 : _b.startCol,
+                    line: attr.spacesBeforeEqual?.startLine,
+                    col: attr.spacesBeforeEqual?.startCol,
                     raw: extraRaw,
                     message: t('{0} is {1}', t('the "{0*}" {1}', name, 'attribute'), t('a {0}', 'boolean attribute')) +
                         t('. ') +

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

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

@@ -1,13 +1,10 @@
-"use strict";
-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)({
+import { createRule, getAttrSpecs } from '@markuplint/ml-core';
+import { toNormalizedValue } from '../helpers.js';
+export default createRule({
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
-            var _a, _b, _c;
-            const attrSpec = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
+            const attrSpec = getAttrSpecs(attr.ownerElement, document.specs);
             if (!attrSpec) {
                 return;
             }
@@ -18,14 +15,14 @@ exports.default = (0, ml_core_1.createRule)({
             if (!spec.defaultValue) {
                 return;
             }
-            const normalizedValue = (0, helpers_1.toNormalizedValue)(attr.value, spec);
-            const defaultValue = (0, helpers_1.toNormalizedValue)(spec.defaultValue, spec);
+            const normalizedValue = toNormalizedValue(attr.value, spec);
+            const defaultValue = toNormalizedValue(spec.defaultValue, spec);
             if (defaultValue === normalizedValue) {
                 report({
                     scope: attr,
-                    line: (_a = attr.valueNode) === null || _a === void 0 ? void 0 : _a.startLine,
-                    col: (_b = attr.valueNode) === null || _b === void 0 ? void 0 : _b.startCol,
-                    raw: (_c = attr.valueNode) === null || _c === void 0 ? void 0 : _c.raw,
+                    line: attr.valueNode?.startLine,
+                    col: attr.valueNode?.startCol,
+                    raw: attr.valueNode?.raw,
                     message: t('It is {0}', t('the {0}', 'default value')),
                 });
             }

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

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

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

@@ -1,8 +1,6 @@
-"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)({
+import { createRule } from '@markuplint/ml-core';
+import { isNothingContentModel, isPalpableElement } from '@markuplint/ml-spec';
+export default createRule({
     defaultSeverity: 'warning',
     defaultOptions: {
         extendsExposableElements: true,
@@ -10,13 +8,21 @@ exports.default = (0, ml_core_1.createRule)({
     },
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
-            if (!(0, ml_spec_1.isPalpableElement)(el, el.ownerMLDocument.specs, {
+            /**
+             * Exception
+             *
+             * - The `textarea` element is possibly empty because a user inputs it.
+             */
+            if (el.localName === 'textarea') {
+                return;
+            }
+            if (!isPalpableElement(el, el.ownerMLDocument.specs, {
                 extendsSvg: false,
                 extendsExposableElements: el.rule.options.extendsExposableElements,
             })) {
                 return;
             }
-            if ((0, ml_spec_1.isNothingContentModel)(el)) {
+            if (isNothingContentModel(el)) {
                 return;
             }
             if (el.rule.options.ignoreIfAriaBusy && el.getAttribute('aria-busy') === 'true') {

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

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

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

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

@@ -1,5 +1,5 @@
-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;