@markuplint/rules 4.0.0-dev.28 → 4.0.0-rc.0

package/.eslintrc

@@ -0,0 +1,5 @@
+{
+	"rules": {
+		"import/no-default-export": 0
+	}
+}

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2019 Yusuke Hirao
+Copyright (c) 2017-2024 Yusuke Hirao
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/attr-duplication/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     async verify({ document, report, t }) {
         const message = t('{0} is {1:c}', t('the {0}', 'attribute name'), 'duplicated');
         await document.walkOn('Element', node => {

package/lib/attr-value-quotes/index.js

@@ -4,6 +4,9 @@ const quoteList = {
     single: "'",
 };
 export default createRule({
+    meta: {
+        category: 'style',
+    },
     defaultSeverity: 'warning',
     defaultValue: 'double',
     async verify({ document, report, t }) {
@@ -26,7 +29,6 @@ export default createRule({
             const quote = quoteList[attr.rule.value];
             if (quote && attr.startQuote && attr.startQuote.raw !== quote) {
                 attr.startQuote.fix(quote);
-                // TODO: attr.endQuote = new MLToken(quote);
                 attr.endQuote?.fix(quote);
             }
         });

package/lib/case-sensitive-attr-name/index.js

@@ -1,5 +1,8 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'style',
+    },
     defaultSeverity: 'warning',
     defaultValue: 'lower',
     async verify({ document, report, t }) {

package/lib/case-sensitive-tag-name/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'style',
+    },
     defaultSeverity: 'warning',
     defaultValue: 'lower',
     async verify({ document, report, t }) {

package/lib/character-reference/index.js

@@ -2,6 +2,9 @@ import { createRule, getLocationFromChars } from '@markuplint/ml-core';
 const defaultChars = ['"', '&', '<', '>'];
 const ignoreParentElement = new Set(['script', 'style']);
 export default createRule({
+    meta: {
+        category: 'style',
+    },
     async verify({ document, report, t }) {
         const targetNodes = [];
         await document.walkOn('Text', node => {

package/lib/class-naming/index.js

@@ -2,6 +2,9 @@ import { createRule } from '@markuplint/ml-core';
 import { toNoEmptyStringArrayFromStringOrArray } from '@markuplint/shared';
 import { match } from '../helpers.js';
 export default createRule({
+    meta: {
+        category: 'naming-convention',
+    },
     defaultSeverity: 'warning',
     defaultValue: null,
     async verify({ document, report, t }) {
@@ -14,7 +17,7 @@ export default createRule({
                 }
                 const classAttr = attr.valueNode;
                 const classList = attr.value
-                    .split(/\s+/g)
+                    .split(/\s+/)
                     .map(c => c.trim())
                     .filter(Boolean);
                 for (const className of classList) {

package/lib/deprecated-attr/index.js

@@ -1,5 +1,8 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             const attrSpecs = getAttrSpecs(attr.ownerElement, document.specs);

package/lib/deprecated-element/index.js

@@ -1,5 +1,8 @@
 import { createRule, getSpec } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
             if (!(el.namespaceURI === 'http://www.w3.org/1999/xhtml' ||

package/lib/disallowed-element/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     defaultValue: [],
     async verify({ document, report, t }) {
         for (const query of document.rule.value) {

package/lib/doctype/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     defaultValue: 'always',
     defaultOptions: {
         denyObsoleteType: true,

package/lib/end-tag/index.js

@@ -1,6 +1,9 @@
 import { createRule } from '@markuplint/ml-core';
 import { isVoidElement } from '@markuplint/ml-spec';
 export default createRule({
+    meta: {
+        category: 'style',
+    },
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         if (document.endTag === 'never') {

package/lib/id-duplication/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     async verify({ document, report, t }) {
         const message = t('{0} is {1:c}', t('{0} of {1}', t('the {0}', 'value'), t('the "{0*}" {1}', 'id', 'attribute')), 'duplicated');
         const idStack = [];

package/lib/index.d.ts

@@ -96,6 +96,10 @@ declare const rules: {
     readonly 'required-h1': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, import("./required-h1/index.js").Options>>;
     readonly 'use-list': Readonly<import("@markuplint/ml-core").RuleSeed<readonly string[], {
         spaceNeededBullets?: string[] | undefined;
+        noPrev?: boolean | undefined;
+        prevElement?: boolean | undefined;
+        prevComment?: boolean | undefined;
+        prevCodeBlock?: boolean | undefined;
     }>>;
     readonly 'wai-aria': Readonly<import("@markuplint/ml-core").RuleSeed<boolean, import("./wai-aria/types.js").Options>>;
 };

package/lib/ineffective-attr/index.js

@@ -1,6 +1,9 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 import { toNoEmptyStringArrayFromStringOrArray } from '@markuplint/shared';
 export default createRule({
+    meta: {
+        category: 'style',
+    },
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {

package/lib/invalid-attr/index.js

@@ -4,6 +4,9 @@ import { log as ruleLog } from '../debug.js';
 import { isValidAttr, match } from '../helpers.js';
 const log = ruleLog.extend('invalid-attr');
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     defaultOptions: {},
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {

package/lib/label-has-control/index.js

@@ -1,6 +1,9 @@
 import { createRule } from '@markuplint/ml-core';
 const controlSelector = ["input:not([type='hidden' i])", 'select', 'textarea'].join(',');
 export default createRule({
+    meta: {
+        category: 'a11y',
+    },
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {

package/lib/landmark-roles/index.js

@@ -10,6 +10,9 @@ const selectors = {
 };
 const topLevelRoles = ['banner', 'main', 'complementary', 'contentinfo'];
 export default createRule({
+    meta: {
+        category: 'a11y',
+    },
     defaultSeverity: 'warning',
     defaultOptions: {
         ignoreRoles: [],

package/lib/no-boolean-attr-value/index.js

@@ -1,5 +1,8 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'style',
+    },
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {

package/lib/no-default-value/index.js

@@ -1,6 +1,9 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 import { toNormalizedValue } from '../helpers.js';
 export default createRule({
+    meta: {
+        category: 'style',
+    },
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {

package/lib/no-empty-palpable-content/index.js

@@ -1,6 +1,9 @@
 import { createRule } from '@markuplint/ml-core';
 import { isNothingContentModel, isPalpableElement } from '@markuplint/ml-spec';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     defaultSeverity: 'warning',
     defaultOptions: {
         extendsExposableElements: true,

package/lib/no-hard-code-id/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'maintainability',
+    },
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         if (!document.isFragment) {

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

@@ -3,6 +3,9 @@ import { ARIA_RECOMMENDED_VERSION } from '@markuplint/ml-spec';
 import { decodeEntities, decodeHref } from '@markuplint/shared';
 const HYPERLINK_SELECTOR = 'a[href], area[href]';
 export default createRule({
+    meta: {
+        category: 'a11y',
+    },
     defaultOptions: {
         ariaVersion: ARIA_RECOMMENDED_VERSION,
         fragmentRefersNameAttr: false,

package/lib/no-use-event-handler-attr/index.js

@@ -1,6 +1,9 @@
 import { createRule } from '@markuplint/ml-core';
 import { match } from '../helpers.js';
 export default createRule({
+    meta: {
+        category: 'maintainability',
+    },
     defaultSeverity: 'warning',
     defaultOptions: {},
     async verify({ document, report, t }) {

package/lib/permitted-contents/content-model.js

@@ -3,7 +3,7 @@ import { start } from './start.js';
 export function contentModel(
 // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
 el, rules, options) {
-    const model = createModel(el, rules);
+    const { model, specs } = createModel(el, rules);
     if (model == null) {
         return [
             {
@@ -14,7 +14,7 @@ el, rules, options) {
             },
         ];
     }
-    const result = start(model, el, el.ownerMLDocument.specs, options);
+    const result = start(model, el, specs, options);
     return result;
 }
 function createModel(
@@ -22,7 +22,10 @@ function createModel(
 el, rules) {
     const specs = cachedSpecs(el.ownerMLDocument.specs, rules);
     const model = getContentModel(el, specs.specs);
-    return model;
+    return {
+        model,
+        specs,
+    };
 }
 const caches = new Map();
 function cachedSpecs(specs, rules) {

package/lib/permitted-contents/debug.browser.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="debug" />
-export declare const cmLog: import("debug").Debugger;
+import type { Log } from '../debug.js';
+export declare const cmLog: Log;
 export declare const bgGreen: {
     (): void;
     bold(): void;

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

@@ -1,6 +1,6 @@
-/// <reference types="debug" />
+import type { Log } from '../debug.js';
 import color from 'ansi-colors';
-export declare const cmLog: import("debug").Debugger;
+export declare const cmLog: Log;
 export declare const bgGreen: color.StyleFunction;
 export declare const green: color.StyleFunction;
 export declare const bgRed: color.StyleFunction;

package/lib/permitted-contents/index.js

@@ -2,6 +2,9 @@ import { createRule } from '@markuplint/ml-core';
 import { contentModel } from './content-model.js';
 import { transparentMode } from './represent-transparent-nodes.js';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     defaultValue: [],
     defaultOptions: {
         ignoreHasMutableChildren: true,

package/lib/permitted-contents/matches-selector.js

@@ -152,7 +152,7 @@ function optCondition(query, specs) {
     }
     let hasCustom = false;
     let hasText = false;
-    const selector = query.replace(/^(?::model\(([^)]+)\)|#([a-z-]+))(.*)$/, (_, $model, _model, $last) => {
+    const selector = query.replace(/^:model\(([^)]+)\)|^#([a-z-]+)/, (_, $model, _model) => {
         const _selectors = contentModelCategoryToTagNames(`#${$model ?? _model}`, specs.def);
         if (_selectors.length === 0) {
             throw new Error(`${$model ?? _model} is empty`);
@@ -169,7 +169,7 @@ function optCondition(query, specs) {
             }
             selectors.push(selector);
         }
-        return `:is(${selectors.join(',')})${$last ?? ''}`;
+        return `:is(${selectors.join(',')})`;
     });
     const result = {
         selector,

package/lib/placeholder-label-option/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     verify({ document, report, t }) {
         for (const select of document.querySelectorAll('select')) {
             if (hasPlaceholderLabelOption(select)) {

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

@@ -2,14 +2,14 @@ import { createRule, getRoleSpec, getComputedRole } from '@markuplint/ml-core';
 import { ARIA_RECOMMENDED_VERSION, isExposed } from '@markuplint/ml-spec';
 import { accnameMayBeMutable } from '../helpers.js';
 export default createRule({
+    meta: {
+        category: 'a11y',
+    },
     defaultOptions: {
         ariaVersion: ARIA_RECOMMENDED_VERSION,
     },
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
-            if (el.pretenderContext?.type === 'pretender') {
-                return;
-            }
             if (accnameMayBeMutable(el, document)) {
                 return;
             }

package/lib/require-datetime/index.js

@@ -2,6 +2,9 @@ import { createRule } from '@markuplint/ml-core';
 import { check } from '@markuplint/types';
 import { getCandidateDatetimeString } from './utils.js';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     defaultOptions: {
         langs: undefined,
     },

package/lib/required-attr/index.js

@@ -1,6 +1,9 @@
 import { createRule, getAttrSpecs } from '@markuplint/ml-core';
 import { attrMatches, match } from '../helpers.js';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     defaultValue: [],
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {

package/lib/required-element/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'validation',
+    },
     defaultValue: [],
     defaultOptions: {
         ignoreHasMutableContents: true,

package/lib/required-h1/index.js

@@ -1,5 +1,8 @@
 import { createRule } from '@markuplint/ml-core';
 export default createRule({
+    meta: {
+        category: 'a11y',
+    },
     defaultOptions: {
         'expected-once': true,
         'in-document-fragment': false,

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

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

package/lib/use-list/index.js

@@ -1,36 +1,39 @@
 import { createRule } from '@markuplint/ml-core';
 import { decodeEntities } from '@markuplint/shared';
 export default createRule({
+    meta: {
+        category: 'a11y',
+    },
     defaultValue: [
         /**
          * @see https://en.wikipedia.org/wiki/Bullet_(typography)#In_Unicode
          */
-        '\u2022',
-        '\u2023',
-        '\u2043',
-        '\u204C',
-        '\u204D',
-        '\u2219',
-        '\u25CB',
-        '\u25CF',
-        '\u25D8',
-        '\u25E6',
-        '\u2619',
-        '\u2765',
-        '\u2767',
-        '\u29BE',
-        '\u29BF',
+        '\u2022', // • BULLET (HTML • · •, •)
+        '\u2023', // ‣ TRIANGULAR BULLET (HTML ‣)
+        '\u2043', // ⁃ HYPHEN BULLET (HTML ⁃ · ⁃)
+        '\u204C', // ⁌ BLACK LEFTWARDS BULLET (HTML ⁌)
+        '\u204D', // ⁍ BLACK RIGHTWARDS BULLET (HTML ⁍)
+        '\u2219', // ∙ BULLET OPERATOR (HTML ∙) for use in mathematical notation primarily as a dot product instead of interupt.
+        '\u25CB', // ○ WHITE CIRCLE (HTML ○ · ○)
+        '\u25CF', // ● BLACK CIRCLE (HTML ●)
+        '\u25D8', // ◘ INVERSE BULLET (HTML ◘)
+        '\u25E6', // ◦ WHITE BULLET (HTML ◦)
+        '\u2619', // ☙ REVERSED ROTATED FLORAL HEART BULLET (HTML ☙); see Fleuron (typography)
+        '\u2765', // ❥ ROTATED HEAVY BLACK HEART BULLET (HTML ❥)
+        '\u2767', // ❧ ROTATED FLORAL HEART BULLET (HTML ❧); see Fleuron (typography)
+        '\u29BE', // ⦾ CIRCLED WHITE BULLET (HTML ⦾ · ⦾)
+        '\u29BF', // ⦿ CIRCLED BULLET (HTML ⦿ · ⦿)
         /**
          * In Japanese
          * @see https://ja.wikipedia.org/wiki/中黒#符号位置
          */
-        '\u00B7',
-        '\u0387',
-        '\u2022',
-        '\u2219',
-        '\u22C5',
-        '\u30FB',
-        '\uFF65',
+        '\u00B7', // MIDDLE DOT
+        '\u0387', // GREEK ANO TELIA
+        '\u2022', // BULLET
+        '\u2219', // BULLET OPERATOR
+        '\u22C5', // DOT OPERATOR
+        '\u30FB', // KATAKANA MIDDLE DOT
+        '\uFF65', // HALFWIDTH KATAKANA MIDDLE DOT
         /**
          * In Other Languages
          */
@@ -38,8 +41,8 @@ export default createRule({
         /**
          * From Markdown
          */
-        '-',
-        '*',
+        '-', // dashes
+        '*', // asterisks
         '+', // plus signs
     ],
     defaultOptions: {
@@ -47,10 +50,14 @@ export default createRule({
             /**
              * From Markdown
              */
-            '-',
-            '*',
+            '-', // dashes
+            '*', // asterisks
             '+', // plus signs
         ],
+        noPrev: true,
+        prevElement: true,
+        prevComment: true,
+        prevCodeBlock: false,
     },
     defaultSeverity: 'warning',
     async verify({ document, report, t }) {
@@ -64,6 +71,19 @@ export default createRule({
                 // character only
                 return;
             }
+            if (textNode.rule.options.noPrev === false && !textNode.prevNode) {
+                return;
+            }
+            if (textNode.rule.options.prevElement === false && textNode.prevNode?.is(textNode.ELEMENT_NODE)) {
+                return;
+            }
+            if (textNode.rule.options.prevComment === false && textNode.prevNode?.is(textNode.COMMENT_NODE)) {
+                return;
+            }
+            if (textNode.rule.options.prevCodeBlock === false &&
+                textNode.prevNode?.is(textNode.MARKUPLINT_PREPROCESSOR_BLOCK)) {
+                return;
+            }
             const bullets = textNode.rule.value;
             const spaceNeededBullets = textNode.rule.options.spaceNeededBullets ?? [];
             if (isMayListItem(text, bullets, spaceNeededBullets)) {

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

@@ -75,7 +75,7 @@ export const checkingRequiredOwnedElements = ({ el, role }) => t => {
     if (mayBeBeforeCreated(el)) {
         return {
             scope: el,
-            message: t('{0}. Or, {1}', t('require {0}', role.requiredOwnedElements.length === 1 && role.requiredOwnedElements[0]
+            message: t('{0}. Or, {1}', t('{0} requires {1}', t('the {0}', 'child element'), 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"')),
         };

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

@@ -49,7 +49,7 @@ export function checkAriaValue(type, value, tokenEnum, booleanish) {
             return tokenEnum.includes(value);
         }
         case 'token list': {
-            const list = value.split(/\s+/g).map(s => s.trim());
+            const list = value.split(/\s+/).map(s => s.trim());
             return list.every(token => tokenEnum.includes(token));
         }
         case 'string':

package/lib/wai-aria/index.js

@@ -16,6 +16,9 @@ import { checkingRequiredOwnedElements } from './checkings/required-owned-elemen
 import { checkingRequiredProp } from './checkings/required-prop.js';
 import { checkingValue } from './checkings/value.js';
 export default createRule({
+    meta: {
+        category: 'a11y',
+    },
     defaultOptions: {
         checkingValue: true,
         checkingDeprecatedProps: true,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "4.0.0-dev.28+0131de5e",
+	"version": "4.0.0-rc.0",
 	"description": "Built-in rules of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -25,18 +25,18 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "4.0.0-dev.28+0131de5e",
-		"@markuplint/ml-core": "4.0.0-dev.28+0131de5e",
-		"@markuplint/ml-spec": "4.0.0-dev.28+0131de5e",
-		"@markuplint/selector": "4.0.0-dev.28+0131de5e",
-		"@markuplint/shared": "4.0.0-dev.28+0131de5e",
-		"@markuplint/types": "4.0.0-dev.28+0131de5e",
-		"@types/debug": "^4.1.10",
+		"@markuplint/html-spec": "4.0.0-rc.0",
+		"@markuplint/ml-core": "4.0.0-rc.0",
+		"@markuplint/ml-spec": "4.0.0-rc.0",
+		"@markuplint/selector": "4.0.0-rc.0",
+		"@markuplint/shared": "4.0.0-rc.0",
+		"@markuplint/types": "4.0.0-rc.0",
+		"@types/debug": "^4.1.12",
 		"@ungap/structured-clone": "^1.2.0",
 		"ansi-colors": "^4.1.3",
-		"chrono-node": "^2.7.0",
+		"chrono-node": "^2.7.5",
 		"debug": "^4.3.4",
-		"type-fest": "^4.5.0"
+		"type-fest": "^4.10.2"
 	},
-	"gitHead": "0131de5ea9dd6d3fd5472d7b414b66644c758881"
+	"gitHead": "3fdeb45cb69ed52b3a215a7520cea1181601443f"
 }