@markuplint/rules 3.7.0 → 3.8.0

package/lib/index.d.ts

@@ -20,32 +20,32 @@ declare const rules: {
         } | {
             pattern: string;
         } | {
-            type: import("packages/@markuplint/ml-spec/lib").AttributeType;
+            type: import("packages/@markuplint/ml-spec/src").AttributeType;
         }> | (string | {
             name: string;
-            value: ({
+            value: import("packages/@markuplint/ml-spec/src").AttributeType | ({
                 enum: [string, ...string[]];
             } | {
                 pattern: string;
             } | {
-                type: import("packages/@markuplint/ml-spec/lib").AttributeType;
-            }) | import("packages/@markuplint/ml-spec/lib").AttributeType;
+                type: import("packages/@markuplint/ml-spec/src").AttributeType;
+            });
         })[] | undefined;
         disallowAttrs?: Record<string, {
             enum: [string, ...string[]];
         } | {
             pattern: string;
         } | {
-            type: import("packages/@markuplint/ml-spec/lib").AttributeType;
+            type: import("packages/@markuplint/ml-spec/src").AttributeType;
         }> | (string | {
             name: string;
-            value: ({
+            value: import("packages/@markuplint/ml-spec/src").AttributeType | ({
                 enum: [string, ...string[]];
             } | {
                 pattern: string;
             } | {
-                type: import("packages/@markuplint/ml-spec/lib").AttributeType;
-            }) | import("packages/@markuplint/ml-spec/lib").AttributeType;
+                type: import("packages/@markuplint/ml-spec/src").AttributeType;
+            });
         })[] | undefined;
         ignoreAttrNamePrefix?: string | string[] | undefined;
         allowToAddPropertiesForPretender?: boolean | undefined;
@@ -54,7 +54,7 @@ declare const rules: {
         } | {
             pattern: string;
         } | {
-            type: import("packages/@markuplint/ml-spec/lib").AttributeType;
+            type: import("packages/@markuplint/ml-spec/src").AttributeType;
         }) | {
             disallowed: true;
         }> | undefined;
@@ -72,7 +72,7 @@ declare const rules: {
     }>>;
     readonly 'no-hard-code-id': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'no-refer-to-non-existent-id': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, {
-        ariaVersion: import("packages/@markuplint/ml-spec/lib").ARIAVersion;
+        ariaVersion: "1.1" | "1.2" | "1.3";
         fragmentRefersNameAttr: boolean;
     }>>;
     readonly 'no-use-event-handler-attr': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
@@ -81,14 +81,14 @@ declare const rules: {
     readonly 'permitted-contents': Readonly<import("@markuplint/ml-core").RuleSeed<import("./permitted-contents/types").TagRule[], import("./permitted-contents/types").Options>>;
     readonly 'placeholder-label-option': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;
     readonly 'require-accessible-name': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
-        ariaVersion: import("packages/@markuplint/ml-spec/lib").ARIAVersion;
+        ariaVersion: "1.1" | "1.2" | "1.3";
     }>>;
     readonly 'require-datetime': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
         langs?: import("./require-datetime/types").Lang[] | undefined;
     }>>;
     readonly 'required-attr': Readonly<import("@markuplint/ml-core").RuleSeed<string | (string | {
         name: string;
-        value: string | string[];
+        value?: string | string[] | undefined;
     })[], undefined>>;
     readonly 'required-element': Readonly<import("@markuplint/ml-core").RuleSeed<string[], {
         ignoreHasMutableContents: boolean;

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

@@ -1,37 +1,44 @@
 import type { AttributeType } from '@markuplint/ml-spec';
 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;
-    }>;
+	/**
+	 * @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;
+		  }
+	>;
 };
 type Attr = {
-    name: string;
-    value: AttributeType | ValueRule;
+	name: string;
+	value: AttributeType | ValueRule;
 };
-type ValueRule = {
-    enum: [string, ...string[]];
-} | {
-    pattern: string;
-} | {
-    type: AttributeType;
-};
-declare const _default: Readonly<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/no-refer-to-non-existent-id/index.d.ts

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

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

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
+const ml_spec_1 = require("@markuplint/ml-spec");
 const shared_1 = require("@markuplint/shared");
 const HYPERLINK_SELECTOR = 'a[href], area[href]';
 exports.default = (0, ml_core_1.createRule)({
     defaultOptions: {
-        ariaVersion: '1.2',
+        ariaVersion: ml_spec_1.ARIA_RECOMMENDED_VERSION,
         fragmentRefersNameAttr: false,
     },
     async verify({ document, report, t }) {

package/lib/permitted-contents/utils.d.ts

@@ -1,100 +1,51 @@
 import type { ChildNode, Element, Hints, MissingNodeReason, RepeatSign, Specs } from './types';
-import type {
-	PermittedContentPattern,
-	PermittedContentChoice,
-	PermittedContentOneOrMore,
-	PermittedContentOptional,
-	PermittedContentRequire,
-	PermittedContentTransparent,
-	PermittedContentZeroOrMore,
-	Model,
-} from '@markuplint/ml-spec';
+import type { PermittedContentPattern, PermittedContentChoice, PermittedContentOneOrMore, PermittedContentOptional, PermittedContentRequire, PermittedContentTransparent, PermittedContentZeroOrMore, Model } from '@markuplint/ml-spec';
 import type { ReadonlyDeep } from 'type-fest';
 export declare function getChildNodesWithoutWhitespaces(el: Element): ChildNode[];
 export declare function isModel(model: ReadonlyDeep<Model | PermittedContentPattern[]>): model is ReadonlyDeep<Model>;
-export declare function matches(
-	selector: string,
-	node: ChildNode,
-	specs: Specs,
-):
-	| {
-			matched: boolean;
-			not?: undefined;
-	  }
-	| {
-			matched: boolean;
-			not: ChildNode | undefined;
-	  };
-export declare function isRequire(
-	content: ReadonlyDeep<PermittedContentPattern>,
-): content is ReadonlyDeep<PermittedContentRequire>;
-export declare function isOptional(
-	content: ReadonlyDeep<PermittedContentPattern>,
-): content is ReadonlyDeep<PermittedContentOptional>;
-export declare function isOneOrMore(
-	content: ReadonlyDeep<PermittedContentPattern>,
-): content is ReadonlyDeep<PermittedContentOneOrMore>;
-export declare function isZeroOrMore(
-	content: ReadonlyDeep<PermittedContentPattern>,
-): content is ReadonlyDeep<PermittedContentZeroOrMore>;
-export declare function isChoice(
-	content: ReadonlyDeep<PermittedContentPattern>,
-): content is ReadonlyDeep<PermittedContentChoice>;
-export declare function isTransparent(
-	content: ReadonlyDeep<PermittedContentPattern>,
-): content is ReadonlyDeep<PermittedContentTransparent>;
-export declare function normalizeModel(
-	pattern:
-		| ReadonlyDeep<PermittedContentRequire>
-		| ReadonlyDeep<PermittedContentOptional>
-		| ReadonlyDeep<PermittedContentOneOrMore>
-		| ReadonlyDeep<PermittedContentZeroOrMore>,
-): {
-	model: ReadonlyDeep<PermittedContentPattern[] | Model>;
-	min: number;
-	max: number;
-	repeat: RepeatSign;
-	missingType: MissingNodeReason | undefined;
+export declare function matches(selector: string, node: ChildNode, specs: Specs): {
+    matched: boolean;
+    not?: undefined;
+} | {
+    matched: boolean;
+    not: ChildNode | undefined;
 };
-export declare function mergeHints(
-	a: Readonly<Hints>,
-	b: Readonly<Hints>,
-): Partial<{
-	missing:
-		| Partial<{
-				barelyMatchedElements?: number | undefined;
-				need?: string | undefined;
-		  }>
-		| undefined;
-	max?: number | undefined;
-	not?:
-		| import('packages/@markuplint/ml-core/lib').DocumentType<
-				import('./types').TagRule[],
-				import('./types').Options
-		  >
-		| import('packages/@markuplint/ml-core/lib/ml-dom/node/character-data').MLCharacterData<
-				import('./types').TagRule[],
-				import('./types').Options,
-				import('packages/@markuplint/ml-ast/lib').MLASTAbstractNode
-		  >
-		| import('packages/@markuplint/ml-core/lib').Element<import('./types').TagRule[], import('./types').Options>
-		| import('packages/@markuplint/ml-core/lib').Block<import('./types').TagRule[], import('./types').Options>
-		| undefined;
-	transparent?: Element | undefined;
+export declare function isRequire(content: ReadonlyDeep<PermittedContentPattern>): content is ReadonlyDeep<PermittedContentRequire>;
+export declare function isOptional(content: ReadonlyDeep<PermittedContentPattern>): content is ReadonlyDeep<PermittedContentOptional>;
+export declare function isOneOrMore(content: ReadonlyDeep<PermittedContentPattern>): content is ReadonlyDeep<PermittedContentOneOrMore>;
+export declare function isZeroOrMore(content: ReadonlyDeep<PermittedContentPattern>): content is ReadonlyDeep<PermittedContentZeroOrMore>;
+export declare function isChoice(content: ReadonlyDeep<PermittedContentPattern>): content is ReadonlyDeep<PermittedContentChoice>;
+export declare function isTransparent(content: ReadonlyDeep<PermittedContentPattern>): content is ReadonlyDeep<PermittedContentTransparent>;
+export declare function normalizeModel(pattern: ReadonlyDeep<PermittedContentRequire> | ReadonlyDeep<PermittedContentOptional> | ReadonlyDeep<PermittedContentOneOrMore> | ReadonlyDeep<PermittedContentZeroOrMore>): {
+    model: ReadonlyDeep<PermittedContentPattern[] | Model>;
+    min: number;
+    max: number;
+    repeat: RepeatSign;
+    missingType: MissingNodeReason | undefined;
+};
+export declare function mergeHints(a: Readonly<Hints>, b: Readonly<Hints>): Partial<{
+    missing: Partial<{
+        barelyMatchedElements?: number | undefined;
+        need?: string | undefined;
+    }> | undefined;
+    max?: number | undefined;
+    not?: import("packages/@markuplint/ml-core/lib").DocumentType<import("./types").TagRule[], import("./types").Options> | import("packages/@markuplint/ml-core/lib/ml-dom/node/character-data").MLCharacterData<import("./types").TagRule[], import("./types").Options, import("packages/@markuplint/ml-ast/src").MLASTAbstractNode> | import("packages/@markuplint/ml-core/lib").Element<import("./types").TagRule[], import("./types").Options> | import("packages/@markuplint/ml-core/lib").Block<import("./types").TagRule[], import("./types").Options> | undefined;
+    transparent?: Element | undefined;
 }>;
 export declare function cleanObject<T extends Object>(object: T): Partial<T>;
 export declare class Collection {
-	#private;
-	constructor(origin: readonly ChildNode[]);
-	get matched(): ChildNode[];
-	get matchedCount(): number;
-	get nodes(): ChildNode[];
-	get unmatched(): ChildNode[];
-	addMatched(nodes: ChildNode[]): boolean;
-	back(): void;
-	lock(): void;
-	max(max: number): void;
-	toString(highlightExtraNodes?: boolean): string;
+    #private;
+    constructor(origin: readonly ChildNode[]);
+    get matched(): ChildNode[];
+    get matchedCount(): number;
+    get nodes(): ChildNode[];
+    get unmatched(): ChildNode[];
+    addMatched(nodes: ChildNode[]): boolean;
+    back(): void;
+    lock(): void;
+    max(max: number): void;
+    toString(highlightExtraNodes?: boolean): string;
+}
+export declare class UnsupportedError extends Error {
 }
-export declare class UnsupportedError extends Error {}
 export declare function modelLog(model: ReadonlyDeep<Model | PermittedContentPattern[]>, repeat: RepeatSign): string;

package/lib/require-accessible-name/index.js

@@ -5,7 +5,7 @@ const ml_spec_1 = require("@markuplint/ml-spec");
 const helpers_1 = require("../helpers");
 exports.default = (0, ml_core_1.createRule)({
     defaultOptions: {
-        ariaVersion: '1.2',
+        ariaVersion: ml_spec_1.ARIA_RECOMMENDED_VERSION,
     },
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {

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

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

package/lib/required-attr/index.js

@@ -34,7 +34,7 @@ exports.default = (0, ml_core_1.createRule)({
                     if (Array.isArray(req.value)) {
                         values.push(...req.value);
                     }
-                    else {
+                    else if (req.value) {
                         values.push(req.value);
                     }
                 }

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

@@ -0,0 +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: readonly ARIAProperty[];
+}>;

package/lib/wai-aria/checkings/_.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkingRequiredProp = void 0;
+const checkingRequiredProp = ({ el, role, propSpecs }) => t => {
+    var _a;
+    if (!role) {
+        return;
+    }
+    if (role.isImplicit) {
+        return;
+    }
+    const requiredProps = role.ownedProperties.filter(s => s.required).map(s => s.name);
+    for (const requiredProp of requiredProps) {
+        const has = el.attributes.some(attr => {
+            const attrName = attr.name.toLowerCase();
+            return attrName === requiredProp;
+        });
+        if (!has) {
+            const propSpec = propSpecs.find(p => p.name === requiredProp);
+            return {
+                scope: el,
+                message: t('{0:c} on {1}', t('Require {0}', t('the "{0*}" {1}', requiredProp, `ARIA ${(_a = propSpec === null || propSpec === void 0 ? void 0 : propSpec.type) !== null && _a !== void 0 ? _a : 'property'}`)), t('the "{0*}" {1}', role.name, 'role')),
+            };
+        }
+    }
+};
+exports.checkingRequiredProp = checkingRequiredProp;

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: readonly ARIAProperty[];
-	}
->;
+export declare const checkingDisallowedProp: AttrChecker<boolean, Options, {
+    role: ARIARole | null;
+    propSpecs: readonly ARIAProperty[];
+}>;

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

@@ -0,0 +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: readonly ARIAProperty[];
+}>;

package/lib/wai-aria/checkings/required-prop copy.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkingRequiredProp = void 0;
+const checkingRequiredProp = ({ el, role, propSpecs }) => t => {
+    var _a;
+    if (!role) {
+        return;
+    }
+    if (role.isImplicit) {
+        return;
+    }
+    const requiredProps = role.ownedProperties.filter(s => s.required).map(s => s.name);
+    for (const requiredProp of requiredProps) {
+        const has = el.attributes.some(attr => {
+            const attrName = attr.name.toLowerCase();
+            return attrName === requiredProp;
+        });
+        if (!has) {
+            const propSpec = propSpecs.find(p => p.name === requiredProp);
+            return {
+                scope: el,
+                message: t('{0:c} on {1}', t('Require {0}', t('the "{0*}" {1}', requiredProp, `ARIA ${(_a = propSpec === null || propSpec === void 0 ? void 0 : propSpec.type) !== null && _a !== void 0 ? _a : 'property'}`)), t('the "{0*}" {1}', role.name, 'role')),
+            };
+        }
+    }
+};
+exports.checkingRequiredProp = checkingRequiredProp;

package/lib/wai-aria/checkings/unadopted-explicit-roles.d.ts

@@ -0,0 +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 checkingUnadoptedExplicitRoles: ElementChecker<boolean, Options, {
+    role?: (ARIARole & {
+        isImplicit?: boolean;
+    }) | null;
+    propSpecs: readonly ARIAProperty[];
+}>;

package/lib/wai-aria/checkings/unadopted-explicit-roles.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkingUnadoptedExplicitRoles = void 0;
+const checkingUnadoptedExplicitRoles = ({ el, role, propSpecs }) => t => {
+    if (!role) {
+        return;
+    }
+    if (role.name) {
+        console.log(el.localName, role.name);
+        return {
+            scope: el,
+            message: '',
+        };
+    }
+    return;
+};
+exports.checkingUnadoptedExplicitRoles = checkingUnadoptedExplicitRoles;

package/lib/wai-aria/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
+const ml_spec_1 = require("@markuplint/ml-spec");
 const helpers_1 = require("../helpers");
 const abstract_role_1 = require("./checkings/abstract-role");
 const default_value_1 = require("./checkings/default-value");
@@ -27,7 +28,7 @@ exports.default = (0, ml_core_1.createRule)({
         disallowSetImplicitRole: true,
         disallowSetImplicitProps: true,
         disallowDefaultValue: false,
-        version: '1.2',
+        version: ml_spec_1.ARIA_RECOMMENDED_VERSION,
     },
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "3.7.0",
+	"version": "3.8.0",
 	"description": "Built-in rules of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -20,10 +20,10 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "3.6.1",
-		"@markuplint/ml-core": "3.7.0",
-		"@markuplint/ml-spec": "3.6.1",
-		"@markuplint/selector": "3.6.1",
+		"@markuplint/html-spec": "3.7.0",
+		"@markuplint/ml-core": "3.8.0",
+		"@markuplint/ml-spec": "3.7.0",
+		"@markuplint/selector": "3.7.0",
 		"@markuplint/shared": "3.5.0",
 		"@markuplint/types": "3.5.1",
 		"@ungap/structured-clone": "^1.0.1",
@@ -36,5 +36,5 @@
 		"@types/debug": "^4.1.7",
 		"type-fest": "^3.6.1"
 	},
-	"gitHead": "884e8dbf60ec2a350761d5cda3cdc0725881b9dc"
+	"gitHead": "42b97b47d22b37437024e693a72a458e2963e261"
 }