@markuplint/rules 3.8.0 → 3.10.0

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

@@ -4,49 +4,49 @@ import type { ReadonlyDeep } from 'type-fest';
 export type Element = _Element<TagRule[], Options>;
 export type ChildNode = _ChildNode<TagRule[], Options>;
 export type Specs = {
-	readonly cites: MLMLSpec['cites'];
-	readonly def: MLMLSpec['def'];
-	readonly specs: readonly {
-		readonly name: string;
-		readonly contentModel: {
-			readonly contents: MLMLSpec['specs'][0]['contentModel']['contents'];
-		};
-	}[];
+    readonly cites: MLMLSpec['cites'];
+    readonly def: MLMLSpec['def'];
+    readonly specs: readonly {
+        readonly name: string;
+        readonly contentModel: {
+            readonly contents: MLMLSpec['specs'][0]['contentModel']['contents'];
+        };
+    }[];
 };
 export type ContentModelResult = {
-	type: MatchedReason | UnmatchedReason;
-	scope: ChildNode;
-	query: Result['query'];
-	hint: Result['hint'];
+    type: MatchedReason | UnmatchedReason;
+    scope: ChildNode;
+    query: Result['query'];
+    hint: Result['hint'];
 };
 export type Result<T extends string = MatchedReason> = {
-	type: MatchedReason | UnmatchedReason | T;
-	matched: ChildNode[];
-	unmatched: ChildNode[];
-	zeroMatch: boolean;
-	query: string;
-	hint: Hints;
+    type: MatchedReason | UnmatchedReason | T;
+    matched: ChildNode[];
+    unmatched: ChildNode[];
+    zeroMatch: boolean;
+    query: string;
+    hint: Hints;
 };
 export type Hints = {
-	max?: number;
-	not?: ChildNode;
-	transparent?: Element;
-	missing?: {
-		barelyMatchedElements?: number;
-		need?: string;
-	};
+    max?: number;
+    not?: ChildNode;
+    transparent?: Element;
+    missing?: {
+        barelyMatchedElements?: number;
+        need?: string;
+    };
 };
 export type MatchedReason = 'MATCHED' | 'MATCHED_ZERO';
 export type UnmatchedReason = 'NOTHING' | 'UNEXPECTED_EXTRA_NODE' | 'TRANSPARENT_MODEL_DISALLOWS' | MissingNodeReason;
 export type MissingNodeReason = 'MISSING_NODE_REQUIRED' | 'MISSING_NODE_ONE_OR_MORE';
 export type RepeatSign = '' | '?' | '+' | '*' | `{${number},${number}}`;
 export type TransparentModel = {
-	el: Element;
-	additionalCondition: string;
+    el: Element;
+    additionalCondition: string;
 };
 export type TagRule = {
-	readonly tag: string;
+    readonly tag: string;
 } & ReadonlyDeep<ContentModel>;
 export type Options = {
-	readonly ignoreHasMutableChildren: boolean;
+    readonly ignoreHasMutableChildren: boolean;
 };

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

@@ -29,7 +29,7 @@ export declare function mergeHints(a: Readonly<Hints>, b: Readonly<Hints>): Part
         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;
+    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 cleanObject<T extends Object>(object: T): Partial<T>;

package/lib/placeholder-label-option/index.d.ts

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

package/lib/require-accessible-name/index.d.ts

@@ -1,6 +1,6 @@
 import type { ARIAVersion } from '@markuplint/ml-spec';
 type Option = {
-	ariaVersion: ARIAVersion;
+    ariaVersion: ARIAVersion;
 };
-declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<boolean, Option>>;
+declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<boolean, Option>>;
 export default _default;

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: Readonly<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/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: Readonly<import('@markuplint/ml-core').RuleSeed<RequiredAttributes, undefined>>;
+declare const _default: Readonly<import("@markuplint/ml-core").RuleSeed<RequiredAttributes, undefined>>;
 export default _default;

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

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

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

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

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

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

@@ -1,9 +1,15 @@
 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[];
-}>;
+export declare const checkingRequiredProp: ElementChecker<
+	boolean,
+	Options,
+	{
+		role?:
+			| (ARIARole & {
+					isImplicit?: boolean;
+			  })
+			| null;
+		propSpecs: readonly ARIAProperty[];
+	}
+>;

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

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

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

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-prop copy.d.ts

@@ -1,9 +1,15 @@
 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[];
-}>;
+export declare const checkingRequiredProp: ElementChecker<
+	boolean,
+	Options,
+	{
+		role?:
+			| (ARIARole & {
+					isImplicit?: boolean;
+			  })
+			| null;
+		propSpecs: readonly ARIAProperty[];
+	}
+>;

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

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

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

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

@@ -1,22 +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: readonly 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: readonly 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: Readonly<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/lib/xxx/index.d.ts

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

package/lib/xxx/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ml_core_1 = require("@markuplint/ml-core");
+exports.default = (0, ml_core_1.createRule)({
+    defaultValue: true,
+    defaultOptions: null,
+    async verify({ document, report, t }) {
+        // Element
+        await document.walkOn("Element", (el) => {
+            const raw = el.raw.trim();
+            if (/./i.test(raw)) {
+                report({
+                    scope: el,
+                    message: t("It is {0}", "issue"),
+                });
+            }
+        });
+        // Attribute
+        await document.walkOn("Attr", (attr) => {
+            var _a, _b, _c;
+            if (/./i.test(attr.name)) {
+                report({
+                    scope: attr,
+                    line: (_a = attr.nameNode) === null || _a === void 0 ? void 0 : _a.startLine,
+                    col: (_b = attr.nameNode) === null || _b === void 0 ? void 0 : _b.startCol,
+                    raw: (_c = attr.nameNode) === null || _c === void 0 ? void 0 : _c.raw,
+                    message: t("It is {0}", "issue"),
+                });
+            }
+        });
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "3.8.0",
+	"version": "3.10.0",
 	"description": "Built-in rules of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -20,21 +20,19 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@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",
+		"@markuplint/html-spec": "3.9.0",
+		"@markuplint/ml-core": "3.10.0",
+		"@markuplint/ml-spec": "3.9.0",
+		"@markuplint/selector": "3.9.0",
+		"@markuplint/shared": "3.6.0",
+		"@markuplint/types": "3.7.0",
+		"@types/debug": "^4.1.7",
+		"@ungap/structured-clone": "^1.2.0",
 		"ansi-colors": "^4.1.3",
-		"chrono-node": "^2.5.0",
+		"chrono-node": "^2.6.3",
 		"debug": "^4.3.4",
-		"tslib": "^2.4.1"
-	},
-	"devDependencies": {
-		"@types/debug": "^4.1.7",
-		"type-fest": "^3.6.1"
+		"tslib": "^2.5.0",
+		"type-fest": "^3.10.0"
 	},
-	"gitHead": "42b97b47d22b37437024e693a72a458e2963e261"
+	"gitHead": "af370797bfc887e5a5a2ff57fbaa8392ac98ead2"
 }

package/test/attr-check.spec.js

@@ -0,0 +1,77 @@
+const { translator } = require('@markuplint/i18n');
+const { i18n } = require('markuplint');
+
+const { valueCheck } = require('../lib/attr-check');
+
+let t;
+
+beforeAll(async () => {
+	const locale = await i18n('en');
+	t = translator(locale);
+});
+
+test('OneCodePointChar List', () => {
+	expect(
+		valueCheck(t, 'accesskey', '@ 12', {
+			token: 'OneCodePointChar',
+			separator: 'space',
+			unique: true,
+		}),
+	).toStrictEqual([
+		'the "accesskey" attribute expects space-separated list. the the content of the list part includes unexpected characters. It expects one code point character (https://html.spec.whatwg.org/multipage/interaction.html#the-accesskey-attribute)',
+		{
+			col: 2,
+			line: 0,
+			raw: '12',
+		},
+	]);
+});
+
+test('BrowsingContextNameOrKeyword', () => {
+	expect(valueCheck(t, 'target', '', 'BrowsingContextNameOrKeyword')).toStrictEqual([
+		'the "target" attribute must not be empty. It expects either "_blank", "_self", "_parent", "_top", "browsing context name" (https://html.spec.whatwg.org/multipage/browsers.html#valid-browsing-context-name-or-keyword)',
+		{
+			col: 0,
+			line: 0,
+			raw: '',
+		},
+	]);
+});
+
+test('BCP47', () => {
+	expect(valueCheck(t, 'lang', '', 'BCP47')).toStrictEqual([
+		'the "lang" attribute must not be empty. It expects the BCP47 format (https://tools.ietf.org/rfc/bcp/bcp47.html)',
+		{
+			col: 0,
+			line: 0,
+			raw: '',
+		},
+	]);
+});
+
+test('DateTime', () => {
+	expect(valueCheck(t, 'datetime', '200-1-1', 'DateTime')).toStrictEqual([
+		'the year part of the "datetime" attribute expects four or more digits (https://html.spec.whatwg.org/multipage/text-level-semantics.html#datetime-value)',
+		{
+			col: 0,
+			line: 0,
+			raw: '200',
+		},
+	]);
+	expect(valueCheck(t, 'datetime', '2000-1-1', 'DateTime')).toStrictEqual([
+		'the month part of the "datetime" attribute expects two digits (https://html.spec.whatwg.org/multipage/text-level-semantics.html#datetime-value)',
+		{
+			col: 5,
+			line: 0,
+			raw: '1',
+		},
+	]);
+	expect(valueCheck(t, 'datetime', '00:00:00.0000', 'DateTime')).toStrictEqual([
+		'the fractional part part of the "datetime" attribute expects one to three digits (https://html.spec.whatwg.org/multipage/text-level-semantics.html#datetime-value)',
+		{
+			col: 9,
+			line: 0,
+			raw: '0000',
+		},
+	]);
+});