@markuplint/rules 3.3.1 → 3.5.0

package/lib/require-datetime/index.d.ts

@@ -1,6 +1,6 @@
 import type { Lang } from './types';
 type Options = {
-	langs?: Lang[];
+    langs?: Lang[];
 };
-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/require-datetime/types.d.ts

@@ -1,8 +1,8 @@
 export type DateTimeKey = 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second' | 'ms';
 export type DateTimeData = Partial<Record<DateTimeKey, number>>;
 export type DateTime = {
-	datetime: DateTimeData;
-	zone?: number;
+    datetime: DateTimeData;
+    zone?: number;
 };
 /**
  * @see https://github.com/wanasit/chrono#locales

package/lib/require-datetime/utils.d.ts

@@ -7,5 +7,5 @@ import type { DateTime, Lang } from './types';
  * @param base Reference date for a test
  * @returns
  */
-export declare function parseADatetime(content: string, langs: Lang[], base?: Date): DateTime | null;
+export declare function parseADatetime(content: string, langs: readonly Lang[], base?: Readonly<Date>): DateTime | null;
 export declare function getCandidateDatetimeString(content: string, langs?: Lang[]): string | null;

package/lib/require-datetime/utils.js

@@ -98,13 +98,15 @@ function toDatetimeString(date) {
 }
 function parseTryMultipleLangs(content, langs, base) {
     for (const lang of langs) {
-        // eslint-disable-next-line import/namespace
         const results = chrono[lang].casual.parse(content, base);
         // Is not multiple datetime contents
         if (results.length < 1) {
             continue;
         }
         const result = results[0];
+        if (!result) {
+            continue;
+        }
         // Is not a range or period
         if (result.end) {
             continue;

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

@@ -1,7 +1,7 @@
 type RequiredAttributes = string | (string | Attr)[];
 type Attr = {
-	name: string;
-	value: string | string[];
+    name: string;
+    value: string | string[];
 };
-declare const _default: import('@markuplint/ml-core').RuleSeed<RequiredAttributes, null>;
+declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<RequiredAttributes, undefined>>;
 export default _default;

package/lib/required-attr/index.js

@@ -6,6 +6,7 @@ exports.default = (0, ml_core_1.createRule)({
     defaultValue: [],
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
+            var _a;
             if (el.hasSpreadAttr) {
                 return;
             }
@@ -54,7 +55,7 @@ exports.default = (0, ml_core_1.createRule)({
                     invalid = (0, helpers_1.attrMatches)(el, spec.condition) && didntHave;
                 }
                 else if (spec.required) {
-                    const selector = Array.isArray(spec.required) ? spec.required.join(',') : spec.required;
+                    const selector = typeof spec.required === 'string' ? spec.required : spec.required.join(',');
                     invalid = el.matches(selector) && didntHave;
                 }
                 if (invalid) {
@@ -71,17 +72,19 @@ exports.default = (0, ml_core_1.createRule)({
                         const expects = spec.values.length === 1 ? t(spec.values) : t('either {0}', t(spec.values));
                         const message = t('{0} expects {1}', t('the "{0*}" {1}', spec.name, 'attribute'), expects);
                         const attrToken = el.getAttributeToken(spec.name);
-                        const valueToken = attrToken[0].valueNode;
+                        const valueToken = (_a = attrToken[0]) === null || _a === void 0 ? void 0 : _a.valueNode;
                         const token = valueToken || attrToken[0];
-                        report({
-                            scope: {
-                                rule: el.rule,
-                                raw: token.raw,
-                                startCol: token.startCol,
-                                startLine: token.startLine,
-                            },
-                            message,
-                        });
+                        if (token) {
+                            report({
+                                scope: {
+                                    rule: el.rule,
+                                    raw: token.raw,
+                                    startCol: token.startCol,
+                                    startLine: token.startLine,
+                                },
+                                message,
+                            });
+                        }
                     }
                 }
             }

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

@@ -1,5 +1,5 @@
 type Options = {
-	ignoreHasMutableContents: boolean;
+    ignoreHasMutableContents: boolean;
 };
-declare const _default: import('@markuplint/ml-core').RuleSeed<string[], Options>;
+declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<string[], Options>>;
 export default _default;

package/lib/required-element/index.js

@@ -7,6 +7,7 @@ exports.default = (0, ml_core_1.createRule)({
         ignoreHasMutableContents: true,
     },
     async verify({ document, report, t }) {
+        var _a, _b;
         const hasMutableContent = document.nodeList.some(n => n.is(n.ELEMENT_NODE) && n.hasMutableChildren());
         if (!hasMutableContent) {
             for (const query of document.rule.value) {
@@ -17,7 +18,7 @@ exports.default = (0, ml_core_1.createRule)({
                         message,
                         line: 1,
                         col: 1,
-                        raw: document.nodeList[0].raw.slice(0, 1),
+                        raw: (_b = (_a = document.nodeList[0]) === null || _a === void 0 ? void 0 : _a.raw.slice(0, 1)) !== null && _b !== void 0 ? _b : '',
                     });
                 }
             }

package/lib/required-h1/index.d.ts

@@ -1,6 +1,6 @@
 export interface Options {
-	'expected-once': boolean;
-	'in-document-fragment': boolean;
+    'expected-once': boolean;
+    'in-document-fragment': 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/required-h1/index.js

@@ -7,6 +7,7 @@ exports.default = (0, ml_core_1.createRule)({
         'in-document-fragment': false,
     },
     async verify({ document, report, t }) {
+        var _a, _b;
         const h1Stack = [];
         if (document.nodeList.length === 0) {
             return;
@@ -25,10 +26,10 @@ exports.default = (0, ml_core_1.createRule)({
                 message,
                 line: 1,
                 col: 1,
-                raw: document.nodeList[0].raw.slice(0, 1),
+                raw: (_b = (_a = document.nodeList[0]) === null || _a === void 0 ? void 0 : _a.raw.slice(0, 1)) !== null && _b !== void 0 ? _b : '',
             });
         }
-        else if (document.rule.options['expected-once'] && h1Stack.length > 1) {
+        else if (document.rule.options['expected-once'] && h1Stack.length > 1 && h1Stack[1]) {
             const message = t('{0} is {1:c}', t('the "{0*}" {1}', 'h1', 'element'), 'duplicated');
             report({
                 message,

package/lib/use-list/index.d.ts

@@ -1,6 +1,6 @@
-type Bullets = string[];
+type Bullets = readonly string[];
 type Options = {
-	spaceNeededBullets?: string[];
+    spaceNeededBullets?: string[];
 };
-declare const _default: import('@markuplint/ml-core').RuleSeed<Bullets, Options>;
+declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<Bullets, Options>>;
 export default _default;

package/lib/use-list/index.js

@@ -78,15 +78,16 @@ exports.default = (0, ml_core_1.createRule)({
     },
 });
 function isMayListItem(text, bullets, spaceNeededBullets) {
+    var _a;
     const textArray = Array.from(text);
-    const firstLetter = textArray[0];
+    const firstLetter = (_a = textArray[0]) !== null && _a !== void 0 ? _a : '';
     const isBullet = bullets.includes(firstLetter);
     const needSpace = spaceNeededBullets.includes(firstLetter);
     const continuous = firstLetter === textArray[1];
     if (continuous) {
         return false;
     }
-    if (isBullet && needSpace) {
+    if (isBullet && needSpace && text[1]) {
         const secondLetter = text[1];
         const isSpace = /^\s$/.test(secondLetter);
         return isSpace;

package/lib/wai-aria/checkings/default-value.d.ts

@@ -1,10 +1,6 @@
 import type { Options } from '../types';
 import type { AttrChecker } from '@markuplint/ml-core';
 import type { ARIAProperty } from '@markuplint/ml-spec';
-export declare const checkingDefaultValue: AttrChecker<
-	boolean,
-	Options,
-	{
-		propSpecs: ARIAProperty[];
-	}
->;
+export declare const checkingDefaultValue: AttrChecker<boolean, Options, {
+    propSpecs: readonly ARIAProperty[];
+}>;

package/lib/wai-aria/checkings/deprecated-props.d.ts

@@ -1,11 +1,7 @@
 import type { Options } from '../types';
 import type { AttrChecker } from '@markuplint/ml-core';
 import type { ARIAProperty, ARIARole } from '@markuplint/ml-spec';
-export declare const checkingDeprecatedProps: AttrChecker<
-	boolean,
-	Options,
-	{
-		role: ARIARole | null;
-		propSpecs: ARIAProperty[];
-	}
->;
+export declare const checkingDeprecatedProps: AttrChecker<boolean, Options, {
+    role: ARIARole | null;
+    propSpecs: readonly ARIAProperty[];
+}>;

package/lib/wai-aria/checkings/disallowed-prop.d.ts

@@ -1,11 +1,7 @@
 import type { Options } from '../types';
 import type { AttrChecker } from '@markuplint/ml-core';
 import type { ARIAProperty, ARIARole } from '@markuplint/ml-spec';
-export declare const checkingDisallowedProp: AttrChecker<
-	boolean,
-	Options,
-	{
-		role: ARIARole | null;
-		propSpecs: ARIAProperty[];
-	}
->;
+export declare const checkingDisallowedProp: AttrChecker<boolean, Options, {
+    role: ARIARole | null;
+    propSpecs: readonly ARIAProperty[];
+}>;

package/lib/wai-aria/checkings/disallowed-prop.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkingDisallowedProp = void 0;
+const ml_spec_1 = require("@markuplint/ml-spec");
 const checkingDisallowedProp = ({ attr, role, propSpecs }) => t => {
-    var _a;
+    var _a, _b, _c, _d;
     if (!role) {
         return;
     }
@@ -10,13 +11,36 @@ const checkingDisallowedProp = ({ attr, role, propSpecs }) => t => {
         return;
     }
     const statesAndProp = role.ownedProperties.find(p => p.name === attr.name);
+    const propSpec = propSpecs.find(p => p.name === attr.name);
+    const elAriaSpec = (0, ml_spec_1.getARIA)(attr.ownerMLDocument.specs, attr.ownerElement.localName, attr.ownerElement.namespaceURI, attr.rule.options.version, attr.ownerElement.matches.bind(attr.ownerElement));
+    if ((elAriaSpec === null || elAriaSpec === void 0 ? void 0 : elAriaSpec.properties) && ((_a = elAriaSpec === null || elAriaSpec === void 0 ? void 0 : elAriaSpec.properties) === null || _a === void 0 ? void 0 : _a.without)) {
+        for (const ignore of elAriaSpec.properties.without) {
+            if (ignore.name === attr.name) {
+                return {
+                    scope: attr,
+                    message: t('{0:c} on {1}', t(ignore.type === 'must-not'
+                        ? '{0} must not {1}'
+                        : ignore.type === 'should-not'
+                            ? '{0} should not {1}'
+                            : '{0} is not recommended to {1}', 
+                    // {0}
+                    t('the "{0*}" {1}', attr.name, `ARIA ${(_b = propSpec === null || propSpec === void 0 ? void 0 : propSpec.type) !== null && _b !== void 0 ? _b : 'property'}`), 
+                    // {1}
+                    'use'), t('the "{0*}" {1}', attr.ownerElement.localName, 'element')) +
+                        (ignore.alt
+                            ? t('. ') +
+                                t('{0} if you {1} {2}', t(ignore.alt.method === 'remove-attr' ? 'Remove {0}' : 'Add {0}', t('the "{0*}" {1}', ignore.alt.target, 'attribute')), 'use', t('the {0}', `ARIA ${(_c = propSpec === null || propSpec === void 0 ? void 0 : propSpec.type) !== null && _c !== void 0 ? _c : 'property'}`))
+                            : ''),
+                };
+            }
+        }
+    }
     if (statesAndProp) {
         return;
     }
-    const propSpec = propSpecs.find(p => p.name === attr.name);
     return {
         scope: attr,
-        message: t('{0:c} on {1}', t('{0} is {1:c}', t('the "{0*}" {1}', attr.name, `ARIA ${(_a = propSpec === null || propSpec === void 0 ? void 0 : propSpec.type) !== null && _a !== void 0 ? _a : 'property'}`), 'disallowed'), t('the "{0*}" {1}', role.name, 'role')),
+        message: t('{0:c} on {1}', t('{0} is {1:c}', t('the "{0*}" {1}', attr.name, `ARIA ${(_d = propSpec === null || propSpec === void 0 ? void 0 : propSpec.type) !== null && _d !== void 0 ? _d : 'property'}`), 'disallowed'), t('the "{0*}" {1}', role.name, 'role')),
     };
 };
 exports.checkingDisallowedProp = checkingDisallowedProp;

package/lib/wai-aria/checkings/implicit-props.d.ts

@@ -1,11 +1,7 @@
 import type { Options } from '../types';
 import type { AttrChecker } from '@markuplint/ml-core';
 import type { ARIAProperty, Attribute } from '@markuplint/ml-spec';
-export declare const checkingImplicitProps: AttrChecker<
-	boolean,
-	Options,
-	{
-		propSpecs: ARIAProperty[];
-		attrSpecs: Attribute[] | null;
-	}
->;
+export declare const checkingImplicitProps: AttrChecker<boolean, Options, {
+    propSpecs: readonly ARIAProperty[];
+    attrSpecs: readonly Attribute[] | null;
+}>;

package/lib/wai-aria/checkings/interaction-in-hidden.js

@@ -34,7 +34,9 @@ const checkingInteractionInHidden = ({ el }) => t => {
     };
 };
 exports.checkingInteractionInHidden = checkingInteractionInHidden;
-function getClosestAriaHidden(el) {
+function getClosestAriaHidden(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+el) {
     let current = el;
     while (current) {
         const ariaHidden = current.getAttributeNode('aria-hidden');

package/lib/wai-aria/checkings/no-global-prop.d.ts

@@ -1,10 +1,6 @@
 import type { Options } from '../types';
 import type { AttrChecker } from '@markuplint/ml-core';
 import type { ARIAProperty } from '@markuplint/ml-spec';
-export declare const checkingNoGlobalProp: AttrChecker<
-	boolean,
-	Options,
-	{
-		propSpecs: ARIAProperty[];
-	}
->;
+export declare const checkingNoGlobalProp: AttrChecker<boolean, Options, {
+    propSpecs: readonly ARIAProperty[];
+}>;

package/lib/wai-aria/checkings/presentational-children.js

@@ -46,7 +46,9 @@ const checkingPresentationalChildren = ({ el }) => t => {
     };
 };
 exports.checkingPresentationalChildren = checkingPresentationalChildren;
-function getAncestorHasPresentationalChildren(el) {
+function getAncestorHasPresentationalChildren(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+el) {
     var _a;
     let current = el.parentElement;
     while (current) {

package/lib/wai-aria/checkings/required-owned-elements.d.ts

@@ -6,10 +6,6 @@ import type { ARIARole } from '@markuplint/ml-spec';
  *
  * @see https://w3c.github.io/aria/#mustContain
  */
-export declare const checkingRequiredOwnedElements: ElementChecker<
-	boolean,
-	Options,
-	{
-		role?: ARIARole | null;
-	}
->;
+export declare const checkingRequiredOwnedElements: ElementChecker<boolean, Options, {
+    role?: ARIARole | null;
+}>;

package/lib/wai-aria/checkings/required-owned-elements.js

@@ -34,7 +34,7 @@ const checkingRequiredOwnedElements = ({ el, role }) => t => {
                 return [child, 'BUSY'];
             }
             const computedChild = (0, ml_spec_1.getComputedRole)(child.ownerMLDocument.specs, child, child.rule.options.version);
-            if (role.requiredOwnedElements.some(ownedRole => (0, ml_spec_1.isRequiredOwnedElement)(computedChild, ownedRole, child.ownerMLDocument.specs, child.rule.options.version))) {
+            if (role.requiredOwnedElements.some(ownedRole => (0, ml_spec_1.isRequiredOwnedElement)(computedChild.el, computedChild.role, ownedRole, child.ownerMLDocument.specs, child.rule.options.version))) {
                 return [child, 'REQUIRED'];
             }
             return [child, 'OTHER'];
@@ -78,20 +78,22 @@ const checkingRequiredOwnedElements = ({ el, role }) => t => {
     if (mayBeBeforeCreated(el)) {
         return {
             scope: el,
-            message: t('{0}. Or, {1}', t('require {0}', role.requiredOwnedElements.length === 1
+            message: t('{0}. Or, {1}', t('require {0}', role.requiredOwnedElements.length === 1 && role.requiredOwnedElements[0]
                 ? t('the "{0*}" {1}', role.requiredOwnedElements[0], 'role')
                 : t('the {0}', 'roles') + `: ${t(role.requiredOwnedElements)}`), t('require {0}', 'aria-busy="true"')),
         };
     }
     return {
         scope: el,
-        message: t('{0} expects {1}', t('the "{0*}" {1}', role.name, 'role'), role.requiredOwnedElements.length === 1
+        message: t('{0} expects {1}', t('the "{0*}" {1}', role.name, 'role'), role.requiredOwnedElements.length === 1 && role.requiredOwnedElements[0]
             ? t('the "{0*}" {1}', role.requiredOwnedElements[0], 'role')
             : t('the {0}', 'roles') + `: ${t(role.requiredOwnedElements)}`),
     };
 };
 exports.checkingRequiredOwnedElements = checkingRequiredOwnedElements;
-function mayBeBeforeCreated(el) {
+function mayBeBeforeCreated(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+el) {
     if (el.isEmpty()) {
         return true;
     }

package/lib/wai-aria/checkings/required-prop.d.ts

@@ -1,15 +1,9 @@
 import type { Options } from '../types';
 import type { ElementChecker } from '@markuplint/ml-core';
 import type { ARIAProperty, ARIARole } from '@markuplint/ml-spec';
-export declare const checkingRequiredProp: ElementChecker<
-	boolean,
-	Options,
-	{
-		role?:
-			| (ARIARole & {
-					isImplicit?: boolean;
-			  })
-			| null;
-		propSpecs: ARIAProperty[];
-	}
->;
+export declare const checkingRequiredProp: ElementChecker<boolean, Options, {
+    role?: (ARIARole & {
+        isImplicit?: boolean;
+    }) | null;
+    propSpecs: readonly ARIAProperty[];
+}>;

package/lib/wai-aria/checkings/value.d.ts

@@ -1,17 +1,13 @@
 import type { Options } from '../types';
 import type { AttrChecker } from '@markuplint/ml-core';
 import type { ARIAProperty, ARIARole } from '@markuplint/ml-spec';
-export declare const checkingValue: AttrChecker<
-	boolean,
-	Options,
-	{
-		role?: ARIARole | null;
-		propSpecs: ARIAProperty[];
-		booleanish?: boolean;
-	}
->;
+export declare const checkingValue: AttrChecker<boolean, Options, {
+    role?: ARIARole | null;
+    propSpecs: readonly ARIAProperty[];
+    booleanish?: boolean;
+}>;
 /**
  *
  * @see https://www.w3.org/TR/wai-aria-1.2/#propcharacteristic_value
  */
-export declare function checkAriaValue(type: string, value: string, tokenEnum: string[], booleanish?: boolean): boolean;
+export declare function checkAriaValue(type: string, value: string, tokenEnum: readonly string[], booleanish?: boolean): boolean;

package/lib/wai-aria/index.d.ts

@@ -1,3 +1,3 @@
 import type { Options } from './types';
-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/wai-aria/types.d.ts

@@ -1,13 +1,13 @@
 import type { ARIAVersion } from '@markuplint/ml-spec';
 export type Options = {
-	checkingValue: boolean;
-	checkingDeprecatedProps: boolean;
-	permittedAriaRoles: boolean;
-	checkingRequiredOwnedElements: boolean;
-	checkingPresentationalChildren: boolean;
-	checkingInteractionInHidden: boolean;
-	disallowSetImplicitRole: boolean;
-	disallowSetImplicitProps: boolean;
-	disallowDefaultValue: boolean;
-	version: ARIAVersion;
+    checkingValue: boolean;
+    checkingDeprecatedProps: boolean;
+    permittedAriaRoles: boolean;
+    checkingRequiredOwnedElements: boolean;
+    checkingPresentationalChildren: boolean;
+    checkingInteractionInHidden: boolean;
+    disallowSetImplicitRole: boolean;
+    disallowSetImplicitProps: boolean;
+    disallowDefaultValue: boolean;
+    version: ARIAVersion;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "3.3.1",
+	"version": "3.5.0",
 	"description": "Built-in rules of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -20,11 +20,11 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "3.3.1",
-		"@markuplint/ml-core": "3.3.1",
-		"@markuplint/ml-spec": "3.3.0",
-		"@markuplint/selector": "3.3.0",
-		"@markuplint/types": "3.2.0",
+		"@markuplint/html-spec": "3.5.0",
+		"@markuplint/ml-core": "3.5.0",
+		"@markuplint/ml-spec": "3.5.0",
+		"@markuplint/selector": "3.5.0",
+		"@markuplint/types": "3.4.0",
 		"@ungap/structured-clone": "^1.0.1",
 		"ansi-colors": "^4.1.3",
 		"chrono-node": "^2.5.0",
@@ -33,7 +33,8 @@
 		"tslib": "^2.4.1"
 	},
 	"devDependencies": {
-		"@types/debug": "^4.1.7"
+		"@types/debug": "^4.1.7",
+		"type-fest": "^3.6.1"
 	},
-	"gitHead": "f19e7de726cf01d53342bc5513c30da75d28da63"
+	"gitHead": "0c47b2c2722f6823a17f36edbab98486275f8ab4"
 }