@markuplint/rules 3.0.0-canary.3 → 3.0.0-dev.176

package/README.md

@@ -15,7 +15,7 @@
 <details>
 <summary>If you are installing purposely, how below:</summary>
 
-```sh
+```shell
 $ npm install -D @markuplint/rules
 
 $ yarn add -D @markuplint/rules

package/lib/attr-check.d.ts

@@ -1,14 +1,15 @@
 import type { Translator } from '@markuplint/i18n';
 import type { Attribute as AttrSpec, AttributeType } from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
 type Invalid = {
-    invalidType: 'non-existent' | 'invalid-value';
-    message: string;
-    loc?: Loc;
+	invalidType: 'non-existent' | 'invalid-value' | 'disallowed-attr';
+	message: string;
+	loc?: Loc;
 };
 type Loc = {
-    raw: string;
-    line: number;
-    col: number;
+	raw: string;
+	line: number;
+	col: number;
 };
 /**
  * Use in rules `invalid-attr` and `wai-aria`
@@ -18,6 +19,17 @@ type Loc = {
  * @param isCustomRule
  * @param spec
  */
-export declare function attrCheck(t: Translator, name: string, value: string, isCustomRule: boolean, spec?: AttrSpec): Invalid | false;
-export declare function valueCheck(t: Translator, name: string, value: string, type: AttributeType): string | [string, Loc] | false;
+export declare function attrCheck(
+	t: Translator,
+	name: string,
+	value: string,
+	isCustomRule: boolean,
+	spec?: AttrSpec,
+): Invalid | false;
+export declare function valueCheck(
+	t: Translator,
+	name: string,
+	value: string,
+	type: ReadonlyDeep<AttributeType>,
+): [string, Loc] | false;
 export {};

package/lib/attr-check.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.valueCheck = exports.attrCheck = void 0;
+const shared_1 = require("@markuplint/shared");
 const types_1 = require("@markuplint/types");
 const create_message_1 = require("./create-message");
 const debug_1 = require("./debug");
@@ -22,6 +23,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,35 +48,37 @@ function attrCheck(t, name, value, isCustomRule, spec) {
                 t('Did you mean "{0*}"?', spec.name),
         };
     }
-    const types = Array.isArray(spec.type) ? spec.type : [spec.type];
+    if (spec.noUse) {
+        return {
+            invalidType: 'disallowed-attr',
+            message: t('{0} is {1:c}', t('the "{0*}" {1}', name, 'attribute'), 'disallowed'),
+        };
+    }
+    const types = (0, shared_1.toNonNullableArrayFromItemOrArray)(spec.type);
     const invalidList = types.map(type => {
-        if (!type) {
-            (0, debug_1.log)('attrCheck: %o', arguments);
-            throw new Error('type is empty in spec');
-        }
         const invalid = valueCheck(t, name, value, type);
-        if (invalid) {
-            if (typeof invalid === 'string') {
-                return {
-                    invalidType: 'invalid-value',
-                    message: invalid,
-                };
-            }
-            else {
-                return {
-                    invalidType: 'invalid-value',
-                    message: invalid[0],
-                    loc: invalid[1],
-                };
-            }
+        if (invalid === false) {
+            return false;
+        }
+        if (typeof invalid === 'string') {
+            return {
+                invalidType: 'invalid-value',
+                message: invalid,
+            };
+        }
+        else {
+            return {
+                invalidType: 'invalid-value',
+                message: invalid[0],
+                loc: invalid[1],
+            };
         }
-        return false;
     });
-    if (invalidList.some(i => !i)) {
+    if (invalidList.some(i => i === false)) {
         return false;
     }
     const invalid = invalidList.find(i => i);
-    return invalid || false;
+    return invalid !== null && invalid !== void 0 ? invalid : false;
 }
 exports.attrCheck = attrCheck;
 function valueCheck(t, name, value, type) {

package/lib/attr-duplication/index.d.ts

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

package/lib/attr-duplication/index.js

@@ -5,6 +5,7 @@ exports.default = (0, ml_core_1.createRule)({
     async verify({ document, report, t }) {
         const message = t('{0} is {1:c}', t('the {0}', 'attribute name'), 'duplicated');
         await document.walkOn('Element', node => {
+            var _a;
             const attrNameStack = [];
             for (const attr of node.getAttributeTokens()) {
                 if (attr.isDuplicatable) {
@@ -13,7 +14,7 @@ exports.default = (0, ml_core_1.createRule)({
                 const attrName = attr.name;
                 const name = node.elementType === 'html' ? attrName.toLowerCase() : attrName;
                 if (attrNameStack.includes(name)) {
-                    const scope = attr.nameNode || attr;
+                    const scope = (_a = attr.nameNode) !== null && _a !== void 0 ? _a : attr;
                     report({
                         scope: {
                             rule: node.rule,

package/lib/attr-value-quotes/index.d.ts

@@ -1,7 +1,7 @@
 export type Type = 'double' | 'single';
 export type Quote = '"' | "'";
 export type QuoteMap = {
-    [P in Type]: Quote;
+	[P in Type]: Quote;
 };
-declare const _default: import("@markuplint/ml-core").RuleSeed<Type, null>;
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<Type, undefined>>;
 export default _default;

package/lib/case-sensitive-attr-name/index.d.ts

@@ -1,3 +1,3 @@
 export type Value = 'lower' | 'upper';
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<Value, undefined>>;
 export default _default;

package/lib/case-sensitive-tag-name/index.d.ts

@@ -1,3 +1,3 @@
 export type Value = 'lower' | 'upper';
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<Value, undefined>>;
 export default _default;

package/lib/character-reference/index.d.ts

@@ -1,3 +1,3 @@
 import type { RuleConfigValue } from '@markuplint/ml-config';
-declare const _default: import("@markuplint/ml-core").RuleSeed<RuleConfigValue, null>;
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<RuleConfigValue, undefined>>;
 export default _default;

package/lib/class-naming/index.d.ts

@@ -1,3 +1,3 @@
 export type Value = string | string[] | null;
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: Readonly<import('@markuplint/ml-core').RuleSeed<Value, undefined>>;
 export default _default;

package/lib/class-naming/index.js

@@ -1,16 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
+const shared_1 = require("@markuplint/shared");
 const helpers_1 = require("../helpers");
 exports.default = (0, ml_core_1.createRule)({
     defaultSeverity: 'warning',
     defaultValue: null,
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
-            if (!el.rule.value) {
-                return;
-            }
-            const classPatterns = Array.isArray(el.rule.value) ? el.rule.value : [el.rule.value];
+            const classPatterns = (0, shared_1.toNoEmptyStringArrayFromStringOrArray)(el.rule.value).filter(className => className && typeof className === 'string');
             const attrs = el.getAttributeToken('class');
             for (const attr of attrs) {
                 if (attr.isDynamicValue) {

package/lib/create-message.d.ts

@@ -1,5 +1,16 @@
 import type { Translator } from '@markuplint/i18n';
 import type { AttributeType } from '@markuplint/ml-spec';
 import type { UnmatchedResult } from '@markuplint/types';
-export declare function createMessageValueExpected(t: Translator, baseTarget: string, type: AttributeType, matches: UnmatchedResult): string;
-export declare function __createMessageValueExpected(t: Translator, baseTarget: string, expected: string | null, matches: Pick<UnmatchedResult, 'partName' | 'reason' | 'raw' | 'candidate' | 'ref' | 'extra'>): string;
+import type { ReadonlyDeep } from 'type-fest';
+export declare function createMessageValueExpected(
+	t: Translator,
+	baseTarget: string,
+	type: ReadonlyDeep<AttributeType>,
+	matches: UnmatchedResult,
+): string;
+export declare function __createMessageValueExpected(
+	t: Translator,
+	baseTarget: string,
+	expected: string | null,
+	matches: Pick<UnmatchedResult, 'partName' | 'reason' | 'raw' | 'candidate' | 'ref' | 'extra'>,
+): string;

package/lib/create-message.js

@@ -22,6 +22,7 @@ function createMessageValueExpected(t, baseTarget, type, matches) {
 }
 exports.createMessageValueExpected = createMessageValueExpected;
 function __createMessageValueExpected(t, baseTarget, expected, matches) {
+    var _a;
     let target = baseTarget;
     let reasonPart;
     let expectPart;
@@ -51,7 +52,7 @@ function __createMessageValueExpected(t, baseTarget, expected, matches) {
             break;
         }
         case 'extra-token': {
-            const token = matches.partName || 'token';
+            const token = (_a = matches.partName) !== null && _a !== void 0 ? _a : 'token';
             reasonPart = t('Found {0}', t('extra {0}', token)) + ' ' + t([matches.raw]);
             if (matches.extra) {
                 const extra = expectValueToWord(t, matches.extra, 'Any');
@@ -201,7 +202,7 @@ exports.__createMessageValueExpected = __createMessageValueExpected;
 function createExpectedObject(type, matches, t) {
     var _a;
     const expectedObject = [];
-    if ((_a = matches.expects) === null || _a === void 0 ? void 0 : _a.length) {
+    if (matches.expects && matches.expects.length > 0) {
         expectedObject.push(...matches.expects.map(expect => {
             return expectValueToWord(t, expect, type);
         }));
@@ -221,7 +222,7 @@ function createExpectedObject(type, matches, t) {
         ? null
         : 1 < expectedObject.length
             ? t('either {0}', t(expectedObject))
-            : expectedObject[0];
+            : (_a = expectedObject[0]) !== null && _a !== void 0 ? _a : null;
     return expects;
 }
 function expectValueToWord(t, expect, type) {

package/lib/debug.js

@@ -3,4 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.log = void 0;
 const tslib_1 = require("tslib");
 const debug_1 = tslib_1.__importDefault(require("debug"));
-exports.log = (0, debug_1.default)('markuplint-rules');
+exports.log = (0, debug_1.default)('ml-rules');

package/lib/deprecated-attr/index.d.ts

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

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

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

package/lib/deprecated-element/index.js

@@ -10,8 +10,8 @@ exports.default = (0, ml_core_1.createRule)({
                 return;
             }
             const spec = (0, ml_core_1.getSpec)(el, document.specs.specs);
-            if (spec && (spec.obsolete || spec.deprecated || spec.nonStandard)) {
-                const message = t('{0} is {1:c}', t('the "{0*}" {1}', el.localName, 'element'), spec.deprecated ? 'deprecated' : spec.obsolete ? 'obsolete' : 'non-standard');
+            if (spec && (spec.obsolete != null || spec.deprecated || spec.nonStandard)) {
+                const message = t('{0} is {1:c}', t('the "{0*}" {1}', el.localName, 'element'), spec.deprecated ? 'deprecated' : spec.obsolete != null ? 'obsolete' : 'non-standard');
                 report({
                     scope: el,
                     message,

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

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

package/lib/doctype/index.d.ts

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

package/lib/end-tag/index.d.ts

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

package/lib/helpers.d.ts

@@ -1,8 +1,13 @@
 import type { Log } from './debug';
 import type { Translator } from '@markuplint/i18n';
+import type { PlainData } from '@markuplint/ml-config';
 import type { Element, RuleConfigValue, Document } from '@markuplint/ml-core';
 import type { Attribute } from '@markuplint/ml-spec';
-export declare function attrMatches<T extends RuleConfigValue, R>(node: Element<T, R>, condition: Attribute['condition']): boolean;
+import type { WritableDeep } from 'type-fest';
+export declare function attrMatches<T extends RuleConfigValue, O extends PlainData>(
+	node: Element<T, O>,
+	condition: Attribute['condition'],
+): boolean;
 export declare function match(needle: string, pattern: string): boolean;
 /**
  * PotentialCustomElementName
@@ -20,28 +25,38 @@ export declare function match(needle: string, pattern: string): boolean;
  * Originally, it is not possible to define a name including ASCII upper alphas in the custom element, but it is not treated as illegal by the HTML parser.
  */
 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";
-    message: string;
-    loc?: {
-        raw: string;
-        line: number;
-        col: number;
-    } | undefined;
-};
+export declare function isValidAttr(
+	t: Translator,
+	name: string,
+	value: string,
+	isDynamicValue: boolean,
+	node: Element<any, any>,
+	attrSpecs: readonly Attribute[],
+	log?: Log,
+):
+	| false
+	| {
+			invalidType: 'non-existent' | 'invalid-value' | 'disallowed-attr';
+			message: string;
+			loc?:
+				| {
+						raw: string;
+						line: number;
+						col: number;
+				  }
+				| undefined;
+	  };
 export declare function toNormalizedValue(value: string, spec: Attribute): string;
 export declare function accnameMayBeMutable(el: Element<any, any>, document: Document<any, any>): boolean;
-export declare function getOwnedLabel<V extends RuleConfigValue, O>(el: Element<V, O>, document: Document<V, O>): Element<V, O> | null;
-export declare function decodeCharRef(characterReference: string): string;
+export declare function getOwnedLabel<V extends RuleConfigValue, O extends PlainData>(
+	el: Element<V, O>,
+	document: Document<V, O>,
+): Element<V, O> | null;
 export declare class Collection<T> {
-    #private;
-    constructor(...items: (T | null | undefined)[]);
-    [Symbol.iterator](): Iterator<T>;
-    add(...items: (T | null | undefined)[]): void;
-    toArray(): readonly T[];
+	#private;
+	constructor(...items: readonly (T | null | undefined)[]);
+	[Symbol.iterator](): Iterator<T>;
+	add(...items: readonly (T | null | undefined)[]): void;
+	toArray(): readonly T[];
 }
-type Writeable<T> = {
-    -readonly [P in keyof T]: T[P];
-};
-export declare function deepCopy<T>(value: T): Writeable<T>;
-export {};
+export declare function deepCopy<T>(value: T): WritableDeep<T>;

package/lib/helpers.js

@@ -1,17 +1,18 @@
 "use strict";
 var _Collection_items;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deepCopy = exports.Collection = exports.decodeCharRef = exports.getOwnedLabel = exports.accnameMayBeMutable = exports.toNormalizedValue = exports.isValidAttr = exports.rePCENChar = exports.match = exports.attrMatches = void 0;
+exports.deepCopy = exports.Collection = exports.getOwnedLabel = exports.accnameMayBeMutable = exports.toNormalizedValue = exports.isValidAttr = exports.rePCENChar = exports.match = exports.attrMatches = void 0;
 const tslib_1 = require("tslib");
 // @ts-ignore
 const structured_clone_1 = tslib_1.__importDefault(require("@ungap/structured-clone"));
-const html_entities_1 = require("html-entities");
 const attr_check_1 = require("./attr-check");
-function attrMatches(node, condition) {
-    if (!condition) {
+function attrMatches(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+node, condition) {
+    if (condition == null) {
         return true;
     }
-    const condSelector = Array.isArray(condition) ? condition.join(',') : condition;
+    const condSelector = typeof condition === 'string' ? condition : condition.join(',');
     return node.matches(condSelector);
 }
 exports.attrMatches = attrMatches;
@@ -60,18 +61,26 @@ exports.rePCENChar = [
     '[\uFDF0-\uFFFD]',
     '[\uD800-\uDBFF][\uDC00-\uDFFF]',
 ].join('|');
-function isValidAttr(t, name, value, isDynamicValue, node, attrSpecs, log) {
+function isValidAttr(t, name, value, isDynamicValue, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+node, attrSpecs, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+log) {
     let invalid = false;
     const spec = attrSpecs.find(s => s.name.toLowerCase() === name.toLowerCase());
     log && log('Spec of the %s attr: %o', name, spec);
     invalid = (0, attr_check_1.attrCheck)(t, name, value, false, spec);
-    if (!invalid && spec && spec.condition && !node.hasSpreadAttr && !attrMatches(node, spec.condition)) {
+    if (invalid === false &&
+        spec &&
+        spec.condition != null &&
+        !node.hasSpreadAttr &&
+        !attrMatches(node, spec.condition)) {
         invalid = {
             invalidType: 'non-existent',
             message: t('{0} is {1}', t('the "{0*}" {1}', name, 'attribute'), 'disallowed'),
         };
     }
-    if (invalid && invalid.invalidType === 'invalid-value' && isDynamicValue) {
+    if (invalid !== false && invalid.invalidType === 'invalid-value' && isDynamicValue) {
         invalid = false;
     }
     return invalid;
@@ -106,7 +115,11 @@ function toNormalizedValue(value, spec) {
     return normalized;
 }
 exports.toNormalizedValue = toNormalizedValue;
-function accnameMayBeMutable(el, document) {
+function accnameMayBeMutable(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+el, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+document) {
     if (el.hasMutableAttributes() || el.hasMutableChildren(true)) {
         return true;
     }
@@ -118,7 +131,11 @@ function accnameMayBeMutable(el, document) {
 }
 exports.accnameMayBeMutable = accnameMayBeMutable;
 const labelable = ['button', 'input:not([type=hidden])', 'meter', 'output', 'progress', 'select', 'textarea'];
-function getOwnedLabel(el, document) {
+function getOwnedLabel(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+el, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+document) {
     if (!labelable.some(cond => el.matches(cond))) {
         return null;
     }
@@ -132,10 +149,6 @@ function getOwnedLabel(el, document) {
     return ownedLabel;
 }
 exports.getOwnedLabel = getOwnedLabel;
-function decodeCharRef(characterReference) {
-    return (0, html_entities_1.decode)(characterReference);
-}
-exports.decodeCharRef = decodeCharRef;
 class Collection {
     constructor(...items) {
         _Collection_items.set(this, new Set());

package/lib/id-duplication/index.d.ts

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