@markuplint/rules 3.11.0 → 4.0.0-alpha.1

package/lib/wai-aria/index.js

@@ -1,23 +1,21 @@
-"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");
-const deprecated_props_1 = require("./checkings/deprecated-props");
-const disallowed_prop_1 = require("./checkings/disallowed-prop");
-const implicit_props_1 = require("./checkings/implicit-props");
-const implicit_role_1 = require("./checkings/implicit-role");
-const interaction_in_hidden_1 = require("./checkings/interaction-in-hidden");
-const no_global_prop_1 = require("./checkings/no-global-prop");
-const non_existent_role_1 = require("./checkings/non-existent-role");
-const permitted_roles_1 = require("./checkings/permitted-roles");
-const presentational_children_1 = require("./checkings/presentational-children");
-const required_owned_elements_1 = require("./checkings/required-owned-elements");
-const required_prop_1 = require("./checkings/required-prop");
-const value_1 = require("./checkings/value");
-exports.default = (0, ml_core_1.createRule)({
+import { createRule, getAttrSpecs, getComputedRole, ariaSpecs, getSpec } from '@markuplint/ml-core';
+import { ARIA_RECOMMENDED_VERSION } from '@markuplint/ml-spec';
+import { Collection } from '../helpers.js';
+import { checkingAbstractRole } from './checkings/abstract-role.js';
+import { checkingDefaultValue } from './checkings/default-value.js';
+import { checkingDeprecatedProps } from './checkings/deprecated-props.js';
+import { checkingDisallowedProp } from './checkings/disallowed-prop.js';
+import { checkingImplicitProps } from './checkings/implicit-props.js';
+import { checkingImplicitRole } from './checkings/implicit-role.js';
+import { checkingInteractionInHidden } from './checkings/interaction-in-hidden.js';
+import { checkingNoGlobalProp } from './checkings/no-global-prop.js';
+import { checkingNonExistentRole } from './checkings/non-existent-role.js';
+import { checkingPermittedRoles } from './checkings/permitted-roles.js';
+import { checkingPresentationalChildren } from './checkings/presentational-children.js';
+import { checkingRequiredOwnedElements } from './checkings/required-owned-elements.js';
+import { checkingRequiredProp } from './checkings/required-prop.js';
+import { checkingValue } from './checkings/value.js';
+export default createRule({
     defaultOptions: {
         checkingValue: true,
         checkingDeprecatedProps: true,
@@ -28,14 +26,14 @@ exports.default = (0, ml_core_1.createRule)({
         disallowSetImplicitRole: true,
         disallowSetImplicitProps: true,
         disallowDefaultValue: false,
-        version: ml_spec_1.ARIA_RECOMMENDED_VERSION,
+        version: ARIA_RECOMMENDED_VERSION,
     },
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
             const roleAttr = el.getAttributeNode('role');
             const propAttrs = el.attributes.filter(attr => /^aria-/i.test(attr.name));
-            const ariaAttrs = new helpers_1.Collection(roleAttr, ...propAttrs);
-            const elSpec = (0, ml_core_1.getSpec)(el, document.specs.specs);
+            const ariaAttrs = new Collection(roleAttr, ...propAttrs);
+            const elSpec = getSpec(el, document.specs.specs);
             if (!elSpec) {
                 return;
             }
@@ -48,50 +46,50 @@ exports.default = (0, ml_core_1.createRule)({
                 }
                 return;
             }
-            const computed = (0, ml_core_1.getComputedRole)(document.specs, el, el.rule.options.version);
-            const { props: propSpecs } = (0, ml_core_1.ariaSpecs)(document.specs, el.rule.options.version);
+            const computed = getComputedRole(document.specs, el, el.rule.options.version);
+            const { props: propSpecs } = ariaSpecs(document.specs, el.rule.options.version);
             if (roleAttr) {
-                if (report((0, non_existent_role_1.checkingNonExistentRole)({ attr: roleAttr }))) {
+                if (report(checkingNonExistentRole({ attr: roleAttr }))) {
                     return;
                 }
-                if (report((0, abstract_role_1.checkingAbstractRole)({ attr: roleAttr }))) {
+                if (report(checkingAbstractRole({ attr: roleAttr }))) {
                     return;
                 }
-                report((0, required_prop_1.checkingRequiredProp)({ el, role: computed.role, propSpecs }));
+                report(checkingRequiredProp({ el, role: computed.role, propSpecs }));
                 if (el.rule.options.disallowSetImplicitRole) {
-                    report((0, implicit_role_1.checkingImplicitRole)({ attr: roleAttr }));
+                    report(checkingImplicitRole({ attr: roleAttr }));
                 }
                 if (el.rule.options.permittedAriaRoles) {
-                    report((0, permitted_roles_1.checkingPermittedRoles)({ attr: roleAttr }));
+                    report(checkingPermittedRoles({ attr: roleAttr }));
                 }
             }
             for (const attr of propAttrs) {
-                report((0, disallowed_prop_1.checkingDisallowedProp)({ attr, role: computed.role, propSpecs }));
+                report(checkingDisallowedProp({ attr, role: computed.role, propSpecs }));
                 if (el.rule.options.checkingDeprecatedProps) {
-                    report((0, deprecated_props_1.checkingDeprecatedProps)({ attr, role: computed.role, propSpecs }));
+                    report(checkingDeprecatedProps({ attr, role: computed.role, propSpecs }));
                 }
                 if (el.rule.options.disallowSetImplicitProps) {
-                    const attrSpecs = (0, ml_core_1.getAttrSpecs)(el, document.specs);
-                    report((0, implicit_props_1.checkingImplicitProps)({ attr, propSpecs, attrSpecs }));
+                    const attrSpecs = getAttrSpecs(el, document.specs);
+                    report(checkingImplicitProps({ attr, propSpecs, attrSpecs }));
                 }
                 if (el.rule.options.checkingValue) {
-                    report((0, value_1.checkingValue)({ attr, role: computed.role, propSpecs, booleanish: document.booleanish }));
+                    report(checkingValue({ attr, role: computed.role, propSpecs, booleanish: document.booleanish }));
                 }
                 if (el.rule.options.disallowDefaultValue) {
-                    report((0, default_value_1.checkingDefaultValue)({ attr, propSpecs }));
+                    report(checkingDefaultValue({ attr, propSpecs }));
                 }
                 if (!computed.role) {
-                    report((0, no_global_prop_1.checkingNoGlobalProp)({ attr, propSpecs }));
+                    report(checkingNoGlobalProp({ attr, propSpecs }));
                 }
             }
             if (el.rule.options.checkingRequiredOwnedElements) {
-                report((0, required_owned_elements_1.checkingRequiredOwnedElements)({ el, role: computed.role }));
+                report(checkingRequiredOwnedElements({ el, role: computed.role }));
             }
             if (el.rule.options.checkingPresentationalChildren) {
-                report((0, presentational_children_1.checkingPresentationalChildren)({ el }));
+                report(checkingPresentationalChildren({ el }));
             }
             if (el.rule.options.checkingInteractionInHidden) {
-                report((0, interaction_in_hidden_1.checkingInteractionInHidden)({ el }));
+                report(checkingInteractionInHidden({ el }));
             }
         });
     },

package/lib/wai-aria/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/package.json

@@ -1,13 +1,18 @@
 {
 	"name": "@markuplint/rules",
-	"version": "3.11.0",
+	"version": "4.0.0-alpha.1",
 	"description": "Built-in rules of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
 	"license": "MIT",
 	"private": false,
-	"main": "lib/index.js",
-	"types": "lib/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./lib/index.js"
+		}
+	},
+	"types": "./lib/index.d.ts",
 	"publishConfig": {
 		"access": "public"
 	},
@@ -20,19 +25,19 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "3.10.0",
-		"@markuplint/ml-core": "3.11.0",
-		"@markuplint/ml-spec": "3.10.0",
-		"@markuplint/selector": "3.10.0",
-		"@markuplint/shared": "3.7.0",
-		"@markuplint/types": "3.8.0",
+		"@markuplint/html-spec": "4.0.0-alpha.1",
+		"@markuplint/ml-core": "4.0.0-alpha.1",
+		"@markuplint/ml-spec": "4.0.0-alpha.1",
+		"@markuplint/selector": "4.0.0-alpha.1",
+		"@markuplint/shared": "4.0.0-alpha.1",
+		"@markuplint/types": "4.0.0-alpha.1",
 		"@types/debug": "^4.1.8",
 		"@ungap/structured-clone": "^1.2.0",
 		"ansi-colors": "^4.1.3",
 		"chrono-node": "^2.6.3",
 		"debug": "^4.3.4",
-		"tslib": "^2.5.3",
-		"type-fest": "^3.11.1"
+		"tslib": "^2.6.1",
+		"type-fest": "^4.1.0"
 	},
-	"gitHead": "9547b8dca20736a93e4d01af2d61bee314ba5718"
+	"gitHead": "22502ee22a378ae766033d687dbc0443e5ed35dc"
 }

package/test/attr-check.spec.js

@@ -1,77 +0,0 @@
-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',
-		},
-	]);
-});

package/test/attr-duplication/index.spec.js

@@ -1,159 +0,0 @@
-const { mlRuleTest } = require('markuplint');
-
-const rule = require('../../lib/attr-duplication').default;
-
-test('is test 1', async () => {
-	const { violations } = await mlRuleTest(
-		rule,
-		`
-		<div data-attr="value" data-Attr='db' data-attR=tr>
-			lorem
-			<p>ipsam</p>
-		</div>
-		`,
-	);
-
-	expect(violations).toStrictEqual([
-		{
-			severity: 'error',
-			message: 'The attribute name is duplicated',
-			line: 2,
-			col: 26,
-			raw: 'data-Attr',
-		},
-		{
-			severity: 'error',
-			message: 'The attribute name is duplicated',
-			line: 2,
-			col: 41,
-			raw: 'data-attR',
-		},
-	]);
-});
-
-test('is test 2', async () => {
-	const { violations } = await mlRuleTest(
-		rule,
-		`
-		<div
-			data-attr="value"
-			data-Attr='db'
-			data-attR=tr>
-			lorem
-			<p>ipsam</p>
-		</div>
-		`,
-	);
-
-	expect(violations).toStrictEqual([
-		{
-			severity: 'error',
-			message: 'The attribute name is duplicated',
-			line: 4,
-			col: 4,
-			raw: 'data-Attr',
-		},
-		{
-			severity: 'error',
-			message: 'The attribute name is duplicated',
-			line: 5,
-			col: 4,
-			raw: 'data-attR',
-		},
-	]);
-});
-
-test('is test 3', async () => {
-	const { violations } = await mlRuleTest(rule, '<img src="/" SRC="/" >', undefined, false, 'ja');
-
-	expect(violations.map(_ => _.message)).toStrictEqual(['属性名が重複しています']);
-});
-
-test('nodeRules disable', async () => {
-	const { violations } = await mlRuleTest(rule, '<div><span attr attr></span></div>', {
-		nodeRule: [
-			{
-				selector: 'span',
-				rule: false,
-			},
-		],
-	});
-
-	expect(violations.length).toStrictEqual(0);
-});
-
-test('Vue', async () => {
-	const { violations } = await mlRuleTest(rule, '<template><div attr v-bind:attr /></template>', {
-		parser: {
-			'.*': '@markuplint/vue-parser',
-		},
-	});
-
-	expect(violations).toStrictEqual([
-		{
-			severity: 'error',
-			line: 1,
-			col: 21,
-			message: 'The attribute name is duplicated',
-			raw: 'v-bind:attr',
-		},
-	]);
-});
-
-test('Vue (exception)', async () => {
-	const { violations } = await mlRuleTest(
-		rule,
-		'<template><div class="foo" v-bind:class="bar" style="a: b;" :style="{c: d}" /></template>',
-		{
-			parser: {
-				'.*': '@markuplint/vue-parser',
-			},
-		},
-	);
-
-	expect(violations.length).toBe(0);
-});
-
-test('React', async () => {
-	const { violations } = await mlRuleTest(rule, '<div tabindex tabIndex />', {
-		parser: {
-			'.*': '@markuplint/vue-parser',
-		},
-	});
-
-	expect(violations).toStrictEqual([]);
-});
-
-test('Pug', async () => {
-	const { violations } = await mlRuleTest(rule, '.hoge(class="hoge2")&attributes({class: "hoge3"})', {
-		parser: {
-			'.*': '@markuplint/pug-parser',
-		},
-	});
-
-	expect(violations.length).toBe(0);
-});
-
-test('Svelte', async () => {
-	const { violations } = await mlRuleTest(
-		rule,
-		'<div class:selected="{isSelected}" class:focused="{isFocused}"></div>',
-		{
-			parser: {
-				'.*': '@markuplint/svelte-parser',
-			},
-		},
-	);
-
-	expect(violations.length).toBe(0);
-});
-
-test('Astro', async () => {
-	const { violations } = await mlRuleTest(rule, '<div class:list="a" class="b"></div>', {
-		parser: {
-			'.*': '@markuplint/astro-parser',
-		},
-	});
-
-	expect(violations.length).toBe(1);
-});

package/test/attr-value-quotes/index.spec.js

@@ -1,133 +0,0 @@
-const { mlRuleTest } = require('markuplint');
-
-const rule = require('../../lib/attr-value-quotes').default;
-
-describe('verify', () => {
-	test('default', async () => {
-		const { violations } = await mlRuleTest(
-			rule,
-			`
-		<div data-attr="value" data-Attr='db' data-attR=tr>
-			lorem
-			<p>ipsam</p>
-		</div>
-		`,
-		);
-		expect(violations).toStrictEqual([
-			{
-				severity: 'warning',
-				message: 'Attribute value is must quote on double quotation mark',
-				line: 2,
-				col: 26,
-				raw: "data-Attr='db'",
-			},
-			{
-				severity: 'warning',
-				message: 'Attribute value is must quote on double quotation mark',
-				line: 2,
-				col: 41,
-				raw: 'data-attR=tr',
-			},
-		]);
-	});
-
-	test('double', async () => {
-		const { violations } = await mlRuleTest(
-			rule,
-			`
-		<div data-attr="value" data-Attr='db' data-attR=tr>
-			lorem
-			<p>ipsam</p>
-		</div>
-		`,
-			{
-				rule: {
-					severity: 'error',
-					value: 'double',
-					options: null,
-				},
-			},
-		);
-		expect(violations).toStrictEqual([
-			{
-				severity: 'error',
-				message: 'Attribute value is must quote on double quotation mark',
-				line: 2,
-				col: 26,
-				raw: "data-Attr='db'",
-			},
-			{
-				severity: 'error',
-				message: 'Attribute value is must quote on double quotation mark',
-				line: 2,
-				col: 41,
-				raw: 'data-attR=tr',
-			},
-		]);
-	});
-
-	test('single', async () => {
-		const { violations } = await mlRuleTest(
-			rule,
-			`
-		<div data-attr="value" data-Attr='db' data-attR=tr>
-			lorem
-			<p>ipsam</p>
-		</div>
-		`,
-			{
-				rule: {
-					severity: 'error',
-					value: 'single',
-					options: null,
-				},
-			},
-		);
-		expect(violations).toStrictEqual([
-			{
-				severity: 'error',
-				message: 'Attribute value is must quote on single quotation mark',
-				line: 2,
-				col: 8,
-				raw: 'data-attr="value"',
-			},
-			{
-				severity: 'error',
-				message: 'Attribute value is must quote on single quotation mark',
-				line: 2,
-				col: 41,
-				raw: 'data-attR=tr',
-			},
-		]);
-	});
-
-	test('empty', async () => {
-		const { violations } = await mlRuleTest(
-			rule,
-			`
-		<div data-attr>
-			lorem
-			<p>ipsam</p>
-		</div>
-		`,
-		);
-		expect(violations.length).toBe(0);
-	});
-});
-
-// describe('fix', () => {
-// 	test('empty', async () => {
-// 		const { fixedCode } = await mlRuleTest(rule, '<div attr noop=noop foo="bar" hoge=\'fuga\'>', undefined, true);
-// 		expect(fixedCode).toEqual('<div attr noop="noop" foo="bar" hoge="fuga">');
-// 	});
-
-// 	test('empty', async () => {
-// 		const { fixedCode } = await mlRuleTest(
-// 			rule,
-// 			'<div attr noop=noop foo="bar" hoge=\'fuga\'>',
-// 			{ rule: 'single' },
-// 			true,
-// 		);
-// 		expect(fixedCode).toEqual("<div attr noop='noop' foo='bar' hoge='fuga'>");
-// 	});
-// });

package/test/case-sensitive-attr-name/index.spec.js

@@ -1,65 +0,0 @@
-const { mlRuleTest } = require('markuplint');
-
-const rule = require('../../lib/case-sensitive-attr-name').default;
-
-describe('verify', () => {
-	test('lower case', async () => {
-		const { violations } = await mlRuleTest(rule, '<div data-lowercase></div>');
-		expect(violations).toStrictEqual([]);
-	});
-
-	test('upper case', async () => {
-		const { violations } = await mlRuleTest(rule, '<div data-UPPERCASE="value"></div>');
-		expect(violations[0].severity).toBe('warning');
-		expect(violations[0].message).toBe('Attribute names of HTML elements should be lowercase');
-		expect(violations[0].raw).toBe('data-UPPERCASE');
-	});
-
-	test('upper case', async () => {
-		const { violations } = await mlRuleTest(rule, '<div data-UPPERCASE="value"></div>', {
-			rule: {
-				severity: 'error',
-				value: 'upper',
-				options: null,
-			},
-		});
-		expect(violations[0].severity).toBe('error');
-		expect(violations[0].message).toBe('Attribute names of HTML elements must be uppercase');
-	});
-
-	test('upper case', async () => {
-		const { violations } = await mlRuleTest(rule, '<div data-uppercase="value"></div>', {
-			rule: {
-				severity: 'error',
-				value: 'upper',
-				options: null,
-			},
-		});
-		expect(violations[0].severity).toBe('error');
-		expect(violations[0].message).toBe('Attribute names of HTML elements must be uppercase');
-	});
-
-	test('upper case', async () => {
-		const { violations } = await mlRuleTest(rule, '<div DATA-UPPERCASE="value"></div>', {
-			rule: { severity: 'error', value: 'upper' },
-		});
-		expect(violations.length).toBe(0);
-	});
-
-	test('svg', async () => {
-		const { violations } = await mlRuleTest(rule, '<svg viewBox="0 0 100 100"></svg>');
-		expect(violations.length).toBe(0);
-	});
-});
-
-// describe('fix', () => {
-// 	test('upper case', async () => {
-// 		const { fixedCode } = await mlRuleTest(rule, '<DIV DATA-LOWERCASE></DIV>', undefined, true);
-// 		expect(fixedCode).toBe('<DIV data-lowercase></DIV>');
-// 	});
-
-// 	test('upper case', async () => {
-// 		const { fixedCode } = await mlRuleTest(rule, '<DIV data-lowercase></DIV>', { rule: 'upper' }, true);
-// 		expect(fixedCode).toBe('<DIV DATA-LOWERCASE></DIV>');
-// 	});
-// });