@markuplint/rules 3.0.0-dev.54 → 3.0.0-dev.95

package/lib/attr-check.d.ts

@@ -1,7 +1,7 @@
 import type { Translator } from '@markuplint/i18n';
 import type { Attribute as AttrSpec, AttributeType } from '@markuplint/ml-spec';
 type Invalid = {
-    invalidType: 'non-existent' | 'invalid-value';
+    invalidType: 'non-existent' | 'invalid-value' | 'disallowed-attr';
     message: string;
     loc?: Loc;
 };

package/lib/attr-check.js

@@ -22,6 +22,12 @@ function attrCheck(t, name, value, isCustomRule, spec) {
             // Ignore checking because ARIA attributes are check on another rule
             return false;
         }
+        // @see https://www.w3.org/TR/adapt/
+        // It is an experimental
+        if (/^adapt-.+$/.test(name)) {
+            // Ignore checking because "adapt-*" attribute is any type
+            return false;
+        }
     }
     // Existence
     if (!spec) {
@@ -41,6 +47,12 @@ function attrCheck(t, name, value, isCustomRule, spec) {
                 t('Did you mean "{0*}"?', spec.name),
         };
     }
+    if (spec.noUse) {
+        return {
+            invalidType: 'disallowed-attr',
+            message: t('{0} is {1:c}', t('the "{0*}" {1}', name, 'attribute'), 'disallowed'),
+        };
+    }
     const types = Array.isArray(spec.type) ? spec.type : [spec.type];
     const invalidList = types.map(type => {
         if (!type) {

package/lib/helpers.d.ts

@@ -21,7 +21,7 @@ export declare function match(needle: string, pattern: string): boolean;
  */
 export declare const rePCENChar: string;
 export declare function isValidAttr(t: Translator, name: string, value: string, isDynamicValue: boolean, node: Element<any, any>, attrSpecs: Attribute[], log?: Log): false | {
-    invalidType: "non-existent" | "invalid-value";
+    invalidType: "non-existent" | "invalid-value" | "disallowed-attr";
     message: string;
     loc?: {
         raw: string;

package/lib/index.js

@@ -24,7 +24,9 @@ const no_hard_code_id_1 = tslib_1.__importDefault(require("./no-hard-code-id"));
 const no_refer_to_non_existent_id_1 = tslib_1.__importDefault(require("./no-refer-to-non-existent-id"));
 const no_use_event_handler_attr_1 = tslib_1.__importDefault(require("./no-use-event-handler-attr"));
 const permitted_contents_1 = tslib_1.__importDefault(require("./permitted-contents"));
+const placeholder_label_option_1 = tslib_1.__importDefault(require("./placeholder-label-option"));
 const require_accessible_name_1 = tslib_1.__importDefault(require("./require-accessible-name"));
+const require_datetime_1 = tslib_1.__importDefault(require("./require-datetime"));
 const required_attr_1 = tslib_1.__importDefault(require("./required-attr"));
 const required_element_1 = tslib_1.__importDefault(require("./required-element"));
 const required_h1_1 = tslib_1.__importDefault(require("./required-h1"));
@@ -54,7 +56,9 @@ exports.default = {
     'no-refer-to-non-existent-id': no_refer_to_non_existent_id_1.default,
     'no-use-event-handler-attr': no_use_event_handler_attr_1.default,
     'permitted-contents': permitted_contents_1.default,
+    'placeholder-label-option': placeholder_label_option_1.default,
     'require-accessible-name': require_accessible_name_1.default,
+    'require-datetime': require_datetime_1.default,
     'required-attr': required_attr_1.default,
     'required-element': required_element_1.default,
     'required-h1': required_h1_1.default,

package/lib/invalid-attr/index.js

@@ -77,6 +77,13 @@ exports.default = (0, ml_core_1.createRule)({
             }
             if (invalid) {
                 switch (invalid.invalidType) {
+                    case 'disallowed-attr': {
+                        report({
+                            scope: attr,
+                            message: invalid.message,
+                        });
+                        break;
+                    }
                     case 'invalid-value': {
                         if (attr.isDynamicValue) {
                             break;

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

@@ -10,6 +10,14 @@ exports.default = (0, ml_core_1.createRule)({
     },
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
+            /**
+             * Exception
+             *
+             * - The `textarea` element is possibly empty because a user inputs it.
+             */
+            if (el.localName === 'textarea') {
+                return;
+            }
             if (!(0, ml_spec_1.isPalpableElement)(el, el.ownerMLDocument.specs, {
                 extendsSvg: false,
                 extendsExposableElements: el.rule.options.extendsExposableElements,

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

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

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

@@ -1,15 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
+const HYPERLINK_SELECTOR = 'a[href], area[href]';
 exports.default = (0, ml_core_1.createRule)({
     defaultOptions: {
         ariaVersion: '1.2',
+        fragmentRefersNameAttr: false,
     },
     async verify({ document, report, t }) {
         const idList = new Set();
+        const nameList = new Set();
         let hasDynamicId = false;
-        await document.walkOn('Attr', attr => {
-            if (attr.name.toLowerCase() !== 'id') {
+        let hasDynamicName = false;
+        document.querySelectorAll('[id]').forEach(el => {
+            const attr = el.getAttributeNode('id');
+            if (!attr) {
                 return;
             }
             if (attr.isDynamicValue) {
@@ -22,6 +27,18 @@ exports.default = (0, ml_core_1.createRule)({
         if (hasDynamicId) {
             return;
         }
+        document.querySelectorAll('[name]').forEach(el => {
+            const attr = el.getAttributeNode('name');
+            if (!attr) {
+                return;
+            }
+            if (attr.isDynamicValue) {
+                hasDynamicName = true;
+            }
+            if (attr.valueType !== 'code') {
+                nameList.add(attr.value);
+            }
+        });
         await document.walkOn('Attr', attr => {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
             const attrSpec = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
@@ -100,5 +117,53 @@ exports.default = (0, ml_core_1.createRule)({
                 }
             }
         });
+        /**
+         * @see https://html.spec.whatwg.org/multipage/browsing-the-web.html#scrolling-to-a-fragment
+         */
+        await document.walkOn('Element', el => {
+            var _a, _b, _c, _d;
+            if (el.rule.options.fragmentRefersNameAttr && hasDynamicName) {
+                return;
+            }
+            if (!el.matches(HYPERLINK_SELECTOR)) {
+                return;
+            }
+            const href = el.getAttributeNode('href');
+            if (!href) {
+                return;
+            }
+            const rawFragment = (_a = href.value.match(/^#(.+)/)) === null || _a === void 0 ? void 0 : _a[1];
+            if (rawFragment == null) {
+                return;
+            }
+            const decodedFragment = decode(rawFragment);
+            // > 2. If fragment is the empty string, then return the special value top of the document.
+            // >
+            // > 9. If decodedFragment is an ASCII case-insensitive match for the string top, then return the top of the document.
+            if (decodedFragment === '' || /^top$/i.test(decodedFragment)) {
+                return;
+            }
+            if (!idList.has(decodedFragment) &&
+                (el.rule.options.fragmentRefersNameAttr ? !nameList.has(decodedFragment) : true)) {
+                report({
+                    scope: href,
+                    line: (_b = href.valueNode) === null || _b === void 0 ? void 0 : _b.startLine,
+                    col: (_c = href.valueNode) === null || _c === void 0 ? void 0 : _c.startCol,
+                    raw: (_d = href.valueNode) === null || _d === void 0 ? void 0 : _d.raw,
+                    message: t('Missing {0}', t('"{0*}" ID', decodedFragment)),
+                });
+            }
+        });
     },
 });
+function decode(fragment) {
+    try {
+        return decodeURI(fragment);
+    }
+    catch (e) {
+        if (e instanceof URIError) {
+            return fragment;
+        }
+        throw e;
+    }
+}

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

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

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

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ml_core_1 = require("@markuplint/ml-core");
+exports.default = (0, ml_core_1.createRule)({
+    verify({ document, report, t }) {
+        document.querySelectorAll('select').forEach(select => {
+            if (hasPlaceholderLabelOption(select)) {
+                return;
+            }
+            if (!needPlaceholderLabelOption(select)) {
+                return;
+            }
+            report({
+                scope: select,
+                message: t('need {0}', t('the {0}', 'placeholder label option')),
+            });
+        });
+    },
+});
+/**
+ * > If a select element has a required attribute specified,
+ * > does not have a multiple attribute specified,
+ * > and has a display size of 1,
+ * > then the select element must have a placeholder label option.
+ *
+ * @param select
+ * @returns
+ */
+function needPlaceholderLabelOption(select) {
+    const hasRequired = select.hasAttribute('required');
+    if (!hasRequired) {
+        return false;
+    }
+    const hasMultiple = select.hasAttribute('multiple');
+    if (hasMultiple) {
+        return false;
+    }
+    const size = select.getAttribute('size') || '1';
+    if (size !== '1') {
+        return false;
+    }
+    return true;
+}
+/**
+ * > If a select element has a required attribute specified,
+ * > does not have a multiple attribute specified,
+ * > and has a display size of 1;
+ * > and if the value of the first option element
+ * > in the select element's list of options (if any) is the empty string,
+ * > and that option element's parent node is the select element (and not an optgroup element),
+ * > then that option is the select element's **placeholder label option**.
+ *
+ * @param select
+ * @returns
+ */
+function hasPlaceholderLabelOption(select) {
+    var _a;
+    // > has a required attribute specified
+    if (!select.hasAttribute('required')) {
+        return false;
+    }
+    // > does not have a multiple attribute specified
+    if (select.hasAttribute('multiple')) {
+        return false;
+    }
+    // > has a display size of 1
+    const size = select.getAttribute('size') || '1';
+    if (size !== '1') {
+        return false;
+    }
+    // > in the select element's list of options (if any) is the empty string
+    const firstOption = select.querySelector('option');
+    if (!firstOption) {
+        // if any
+        return true;
+    }
+    // > that option element's parent node is the select element (and not an optgroup element)
+    if (((_a = firstOption.parentElement) === null || _a === void 0 ? void 0 : _a.localName) === 'optgroup') {
+        return false;
+    }
+    const value = firstOption.getAttribute('value');
+    return value === '' || value === null;
+}

package/lib/require-datetime/index.d.ts

@@ -0,0 +1,6 @@
+import type { Lang } from './types';
+type Options = {
+    langs?: Lang[];
+};
+declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, Options>;
+export default _default;

package/lib/require-datetime/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ml_core_1 = require("@markuplint/ml-core");
+const types_1 = require("@markuplint/types");
+const utils_1 = require("./utils");
+exports.default = (0, ml_core_1.createRule)({
+    defaultOptions: {
+        langs: undefined,
+    },
+    verify({ document, report, t }) {
+        document.querySelectorAll('time:not([datetime])').forEach(time => {
+            if (time.hasMutableChildren()) {
+                return;
+            }
+            const content = time.textContent.trim();
+            const result = (0, types_1.check)(content, 'DateTime');
+            if (result.matched) {
+                return;
+            }
+            const candidate = (0, utils_1.getCandidateDatetimeString)(content, time.rule.options.langs);
+            if (candidate) {
+                report({
+                    scope: time,
+                    message: t('need {0*}', `datetime="${candidate}"`),
+                });
+                return;
+            }
+            report({
+                scope: time,
+                message: t('need {0}', t('the "{0*}" {1}', 'datetime', 'attribute')),
+            });
+        });
+    },
+});

package/lib/require-datetime/types.d.ts

@@ -0,0 +1,10 @@
+export type DateTimeKey = 'year' | 'month' | 'day' | 'hour' | 'minute' | 'second' | 'ms';
+export type DateTimeData = Partial<Record<DateTimeKey, number>>;
+export type DateTime = {
+    datetime: DateTimeData;
+    zone?: number;
+};
+/**
+ * @see https://github.com/wanasit/chrono#locales
+ */
+export type Lang = 'en' | 'ja' | 'fr' | 'nl' | 'ru' | 'de' | 'pt' | 'zh';

package/lib/require-datetime/types.js

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

package/lib/require-datetime/utils.d.ts

@@ -0,0 +1,11 @@
+import type { DateTime, Lang } from './types';
+/**
+ * Datetime-ish text to a datetime data
+ *
+ * @param content
+ * @param langs
+ * @param base Reference date for a test
+ * @returns
+ */
+export declare function parseADatetime(content: string, langs: Lang[], base?: Date): DateTime | null;
+export declare function getCandidateDatetimeString(content: string, langs?: Lang[]): string | null;

package/lib/require-datetime/utils.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCandidateDatetimeString = exports.parseADatetime = void 0;
+const tslib_1 = require("tslib");
+const chrono = tslib_1.__importStar(require("chrono-node"));
+const defaultLangs = ['en', 'ja', 'fr', 'nl', 'ru', 'de', 'pt', 'zh'];
+/**
+ * Datetime-ish text to a datetime data
+ *
+ * @param content
+ * @param langs
+ * @param base Reference date for a test
+ * @returns
+ */
+function parseADatetime(content, langs, base) {
+    const date = parseTryMultipleLangs(content, langs, base);
+    if (!date) {
+        return null;
+    }
+    const data = {};
+    if (date.isCertain('year')) {
+        data.year = date.get('year');
+    }
+    if (date.isCertain('month')) {
+        data.month = date.get('month');
+    }
+    if (date.isCertain('day')) {
+        data.day = date.get('day');
+    }
+    if (date.isCertain('hour')) {
+        data.hour = date.get('hour');
+    }
+    if (date.isCertain('hour')) {
+        data.minute = date.get('minute') || 0;
+    }
+    if (date.isCertain('second')) {
+        data.second = date.get('second');
+    }
+    if (date.isCertain('millisecond')) {
+        data.ms = date.get('millisecond');
+    }
+    const datetime = {
+        datetime: data,
+    };
+    if (date.isCertain('timezoneOffset')) {
+        datetime.zone = date.get('timezoneOffset');
+    }
+    return datetime;
+}
+exports.parseADatetime = parseADatetime;
+function getCandidateDatetimeString(content, langs = defaultLangs) {
+    const date = parseADatetime(content, langs);
+    if (!date) {
+        return null;
+    }
+    let datetimeStr = toDatetimeString(date.datetime);
+    if (!datetimeStr) {
+        return null;
+    }
+    if (date.zone) {
+        const plusMinus = date.zone < 0 ? '-' : '+';
+        const hour = Math.floor(Math.abs(date.zone) / 60);
+        const minute = Math.abs(date.zone) % 60;
+        datetimeStr += `${plusMinus}${f(hour, 2)}${f(minute, 2)}`;
+    }
+    return datetimeStr;
+}
+exports.getCandidateDatetimeString = getCandidateDatetimeString;
+function toDatetimeString(date) {
+    if (only(date, ['year', 'month'])) {
+        return `${f(date.year, 4)}-${f(date.month, 2)}`;
+    }
+    if (only(date, ['year', 'month', 'day'])) {
+        return `${f(date.year, 4)}-${f(date.month, 2)}-${f(date.day, 2)}`;
+    }
+    if (only(date, ['month', 'day'])) {
+        return `${f(date.month, 2)}-${f(date.day, 2)}`;
+    }
+    if (only(date, ['hour', 'minute'])) {
+        return `${f(date.hour, 2)}:${f(date.minute, 2)}`;
+    }
+    if (only(date, ['hour', 'minute', 'second'])) {
+        return `${f(date.hour, 2)}:${f(date.minute, 2)}:${f(date.second, 2)}`;
+    }
+    if (only(date, ['hour', 'minute', 'second', 'ms'])) {
+        return `${f(date.hour, 2)}:${f(date.minute, 2)}:${f(date.second, 2)}.${date.ms}`;
+    }
+    if (only(date, ['year', 'month', 'day', 'hour', 'minute'])) {
+        return `${f(date.year, 4)}-${f(date.month, 2)}-${f(date.day, 2)}T${f(date.hour, 2)}:${f(date.minute, 2)}`;
+    }
+    if (only(date, ['year', 'month', 'day', 'hour', 'minute', 'second'])) {
+        return `${f(date.year, 4)}-${f(date.month, 2)}-${f(date.day, 2)}T${f(date.hour, 2)}:${f(date.minute, 2)}:${f(date.second, 2)}`;
+    }
+    if (only(date, ['year', 'month', 'day', 'hour', 'minute', 'second', 'ms'])) {
+        return `${f(date.year, 4)}-${f(date.month, 2)}-${f(date.day, 2)}T${f(date.hour, 2)}:${f(date.minute, 2)}:${f(date.second, 2)}.${date.ms}`;
+    }
+    return null;
+}
+function parseTryMultipleLangs(content, langs, base) {
+    for (const lang of langs) {
+        // eslint-disable-next-line import/namespace
+        const results = chrono[lang].casual.parse(content, base);
+        // Is not multiple datetime contents
+        if (results.length < 1) {
+            continue;
+        }
+        const result = results[0];
+        // Is not a range or period
+        if (result.end) {
+            continue;
+        }
+        return result.start;
+    }
+    return null;
+}
+function only(date, keys) {
+    const list = Object.keys(date);
+    for (const exists of list) {
+        if (!keys.includes(exists)) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Formatter
+ *
+ * @param n
+ * @param pad zero padding
+ * @returns
+ */
+function f(n, pad) {
+    return n.toString(10).padStart(pad, '0');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/rules",
-	"version": "3.0.0-dev.54+329808d5",
+	"version": "3.0.0-dev.95+599674b1",
 	"description": "Built-in rules of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -20,11 +20,12 @@
 		"./lib/permitted-contents/debug.js": "./lib/permitted-contents/debug.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/html-spec": "3.0.0-dev.54+329808d5",
-		"@markuplint/ml-core": "3.0.0-dev.54+329808d5",
-		"@markuplint/ml-spec": "3.0.0-dev.54+329808d5",
-		"@markuplint/types": "3.0.0-dev.54+329808d5",
+		"@markuplint/html-spec": "3.0.0-dev.95+599674b1",
+		"@markuplint/ml-core": "3.0.0-dev.95+599674b1",
+		"@markuplint/ml-spec": "3.0.0-dev.95+599674b1",
+		"@markuplint/types": "3.0.0-dev.95+599674b1",
 		"@ungap/structured-clone": "^1.0.1",
+		"chrono-node": "^2.5.0",
 		"debug": "^4.3.4",
 		"html-entities": "^2.3.3",
 		"tslib": "^2.4.1"
@@ -32,5 +33,5 @@
 	"devDependencies": {
 		"@types/debug": "^4.1.7"
 	},
-	"gitHead": "329808d50ff8875e24031f692a0504d00b72c4f8"
+	"gitHead": "599674b17e532b5700e63c741217aba826e30feb"
 }

package/schema.json

@@ -75,9 +75,15 @@
 				"permitted-contents": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/permitted-contents/schema.json"
 				},
+				"placeholder-label-option": {
+					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/placeholder-label-option/schema.json"
+				},
 				"require-accessible-name": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/require-accessible-name/schema.json"
 				},
+				"require-datetime": {
+					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/require-datetime/schema.json"
+				},
 				"required-attr": {
 					"$ref": "https://raw.githubusercontent.com/markuplint/markuplint/main/packages/%40markuplint/rules/src/required-attr/schema.json"
 				},