@markuplint/rules 4.0.3 → 4.1.0

package/lib/heading-levels/index.d.ts

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

package/lib/heading-levels/index.js

@@ -0,0 +1,22 @@
+import { createRule } from '@markuplint/ml-core';
+export default createRule({
+    meta: {
+        category: 'validation',
+    },
+    defaultValue: true,
+    defaultOptions: null,
+    verify({ document, report, t }) {
+        const headings = document.querySelectorAll('h1, h2, h3, h4, h5, h6');
+        let prevLevel = 1;
+        for (const heading of headings) {
+            const level = Number.parseInt(heading.nodeName.slice(1));
+            if (prevLevel + 1 < level) {
+                report({
+                    scope: heading,
+                    message: t('Heading levels should not be skipped'),
+                });
+            }
+            prevLevel = level;
+        }
+    },
+});

package/lib/index.d.ts

@@ -12,6 +12,7 @@ declare const rules: {
         denyObsoleteType: boolean;
     }>>;
     readonly 'end-tag': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, undefined>>;
+    readonly 'heading-levels': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, null>>;
     readonly 'id-duplication': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'ineffective-attr': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'invalid-attr': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
@@ -64,8 +65,11 @@ declare const rules: {
         ignoreRoles: (("banner" | "main" | "complementary" | "contentinfo") | "form" | "navigation" | "region")[];
         labelEachArea: boolean;
     }>>;
+    readonly 'neighbor-popovers': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'no-boolean-attr-value': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
+    readonly 'no-consecutive-br': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'no-default-value': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
+    readonly 'no-duplicate-dt': Readonly<import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, undefined>>;
     readonly 'no-empty-palpable-content': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, {
         extendsExposableElements?: boolean | undefined;
         ignoreIfAriaBusy?: boolean | undefined;

package/lib/index.js

@@ -9,13 +9,17 @@ import DeprecatedElement from './deprecated-element/index.js';
 import DisallowedElement from './disallowed-element/index.js';
 import Doctype from './doctype/index.js';
 import EndTag from './end-tag/index.js';
+import HeadingLevels from './heading-levels/index.js';
 import IdDuplication from './id-duplication/index.js';
 import IneffectiveAttr from './ineffective-attr/index.js';
 import InvalidAttr from './invalid-attr/index.js';
 import LabelHasControl from './label-has-control/index.js';
 import LandmarkRoles from './landmark-roles/index.js';
+import NeighborPopovers from './neighbor-popovers/index.js';
 import NoBooleanAttrValue from './no-boolean-attr-value/index.js';
+import NoConsecutiveBr from './no-consecutive-br/index.js';
 import NoDefaultValue from './no-default-value/index.js';
+import NoDuplicateDt from './no-duplicate-dt/index.js';
 import NoEmptyPalpableContent from './no-empty-palpable-content/index.js';
 import NoHardCodeId from './no-hard-code-id/index.js';
 import NoReferToNonExistentId from './no-refer-to-non-existent-id/index.js';
@@ -41,13 +45,17 @@ const rules = {
     'disallowed-element': DisallowedElement,
     doctype: Doctype,
     'end-tag': EndTag,
+    'heading-levels': HeadingLevels,
     'id-duplication': IdDuplication,
     'ineffective-attr': IneffectiveAttr,
     'invalid-attr': InvalidAttr,
     'label-has-control': LabelHasControl,
     'landmark-roles': LandmarkRoles,
+    'neighbor-popovers': NeighborPopovers,
     'no-boolean-attr-value': NoBooleanAttrValue,
+    'no-consecutive-br': NoConsecutiveBr,
     'no-default-value': NoDefaultValue,
+    'no-duplicate-dt': NoDuplicateDt,
     'no-empty-palpable-content': NoEmptyPalpableContent,
     'no-hard-code-id': NoHardCodeId,
     'no-refer-to-non-existent-id': NoReferToNonExistentId,

package/lib/neighbor-popovers/index.d.ts

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

package/lib/neighbor-popovers/index.js

@@ -0,0 +1,45 @@
+import { createRule } from '@markuplint/ml-core';
+import { mayBeFocusable } from '@markuplint/ml-spec';
+// TODO: It will be received from config
+const ARIA_VERSION = '1.2';
+export default createRule({
+    meta: {
+        category: 'a11y',
+    },
+    verify({ document, report, t }) {
+        const triggers = document.querySelectorAll('[popovertarget]');
+        Triggers: for (const trigger of triggers) {
+            const targetId = trigger.getAttribute('popovertarget');
+            if (!targetId) {
+                continue;
+            }
+            const target = document.getElementById(targetId);
+            if (!target) {
+                continue;
+            }
+            if (!target.hasAttribute('popover')) {
+                continue;
+            }
+            const subsequentNodes = trigger.findSubsequentNodes();
+            for (const node of subsequentNodes) {
+                if (node === target) {
+                    continue Triggers;
+                }
+                if ((node.is(node.ELEMENT_NODE) &&
+                    // Element has accessible name
+                    (node.getAccessibleName(ARIA_VERSION) ||
+                        // Element is focusable
+                        mayBeFocusable(node, node.ownerMLDocument.specs))) ||
+                    (node.is(node.TEXT_NODE) &&
+                        // Text node has non-whitespace characters
+                        node.nodeValue?.trim())) {
+                    report({
+                        scope: node,
+                        message: t('Detected {0} between {1} and {2}', t('perceptible nodes'), t('the {0}', 'trigger'), t('corresponding {0}', 'target')),
+                    });
+                    continue Triggers;
+                }
+            }
+        }
+    },
+});

package/lib/no-consecutive-br/index.d.ts

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

package/lib/no-consecutive-br/index.js

@@ -0,0 +1,22 @@
+import { createRule } from '@markuplint/ml-core';
+export default createRule({
+    meta: {
+        category: 'a11y',
+    },
+    defaultSeverity: 'warning',
+    verify({ document, report, t }) {
+        const brList = [...document.querySelectorAll('br')];
+        for (const br of brList) {
+            let next = br.nextSibling;
+            while (next && next.is(next.TEXT_NODE) && !next.nodeValue?.trim()) {
+                next = next.nextSibling;
+            }
+            if (next && next.nodeName === 'BR') {
+                report({
+                    scope: next,
+                    message: t('{0} detected', t('Consecutive {0}', t('"{0*}" {1}', 'br', 'elements'))),
+                });
+            }
+        }
+    },
+});

package/lib/no-duplicate-dt/index.d.ts

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

package/lib/no-duplicate-dt/index.js

@@ -0,0 +1,30 @@
+import { createRule } from '@markuplint/ml-core';
+export default createRule({
+    meta: {
+        category: 'validation',
+    },
+    verify({ document, report, t }) {
+        const dlList = [...document.querySelectorAll('dl')];
+        for (const dl of dlList) {
+            const dtList = [...dl.querySelectorAll(':scope > dt, :scope > div > dt')];
+            const names = new Set();
+            for (const dt of dtList) {
+                // TODO: Supoort for alternative text for images and accessible names for contained elements.
+                const name = dt.textContent?.trim();
+                if (!name) {
+                    continue;
+                }
+                if (name) {
+                    if (names.has(name)) {
+                        report({
+                            scope: dt,
+                            message: t('{0} {1:c}', t('The {0}', 'name'), 'duplicated'),
+                        });
+                        continue;
+                    }
+                    names.add(name);
+                }
+            }
+        }
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "4.0.3",
+	"version": "4.1.0",
 	"description": "Built-in rules of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -25,10 +25,10 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "4.0.2",
-		"@markuplint/ml-core": "4.0.3",
+		"@markuplint/html-spec": "4.1.0",
+		"@markuplint/ml-core": "4.1.0",
 		"@markuplint/ml-spec": "4.0.1",
-		"@markuplint/selector": "4.0.1",
+		"@markuplint/selector": "4.1.0",
 		"@markuplint/shared": "4.0.1",
 		"@markuplint/types": "4.0.1",
 		"@types/debug": "^4.1.12",
@@ -38,5 +38,5 @@
 		"debug": "^4.3.4",
 		"type-fest": "^4.10.2"
 	},
-	"gitHead": "bf84b391b580a8586fa7acaf56eb2e8114c8e33e"
+	"gitHead": "b9817c30c2df71faa866e3b3fe286afa499deede"
 }

package/schema.json

@@ -36,12 +36,15 @@
 				"doctype": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/doctype/schema.json"
 				},
-				"id-duplication": {
-					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/id-duplication/schema.json"
-				},
 				"end-tag": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/end-tag/schema.json"
 				},
+				"heading-levels": {
+					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/heading-levels/schema.json"
+				},
+				"id-duplication": {
+					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/id-duplication/schema.json"
+				},
 				"ineffective-attr": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/ineffective-attr/schema.json"
 				},
@@ -54,12 +57,21 @@
 				"landmark-roles": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/landmark-roles/schema.json"
 				},
+				"neighbor-popovers": {
+					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/neighbor-popovers/schema.json"
+				},
 				"no-boolean-attr-value": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/no-boolean-attr-value/schema.json"
 				},
+				"no-consecutive-br": {
+					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/no-consecutive-br/schema.json"
+				},
 				"no-default-value": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/no-default-value/schema.json"
 				},
+				"no-duplicate-dt": {
+					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/no-duplicate-dt/schema.json"
+				},
 				"no-empty-palpable-content": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/no-empty-palpable-content/schema.json"
 				},