@markuplint/rules 3.0.0-alpha.66 → 3.0.0-dev.176

package/README.md

@@ -1,58 +1,24 @@
 # @markuplint/rules
 
 [![npm version](https://badge.fury.io/js/%40markuplint%2Frules.svg)](https://www.npmjs.com/package/@markuplint/rules)
-[![Build Status](https://travis-ci.org/markuplint/markuplint.svg?branch=main)](https://travis-ci.org/markuplint/markuplint)
-[![Coverage Status](https://coveralls.io/repos/github/markuplint/markuplint/badge.svg?branch=main)](https://coveralls.io/github/markuplint/markuplint?branch=main)
 
-## Rules
+**Built-in rules**
 
-### Conformance checking
+## Documentation
 
-- [`attr-duplication`](./src/attr-duplication)
-- [`character-reference`](./src/character-reference)
-- [`deprecated-attr`](./src/deprecated-attr)
-- [`deprecated-element`](./src/deprecated-element)
-- [`disallowed-element`](./src/disallowed-element)
-- [`doctype`](./src/doctype)
-- [`id-duplication`](./src/id-duplication)
-- [`ineffective-attr`](./src/ineffective-attr)
-- [`invalid-attr`](./src/invalid-attr)
-- [`permitted-contents`](./src/permitted-contents)
-- [`required-attr`](./src/required-attr)
-- [`required-element`](./src/required-element)
-
-### Accessibility
-
-- [`landmark-roles`](./src/landmark-roles)
-- [`no-refer-to-non-existent-id`](./src/no-refer-to-non-existent-id)
-- [`required-h1`](./src/required-h1)
-- [`use-list`](./src/use-list)
-- [`wai-aria`](./src/wai-aria)
-
-### Naming Convention
-
-- [`class-naming`](./src/class-naming)
-
-### Maintainability
-
-- [`no-hard-code-id`](./src/no-hard-code-id)
-- [`no-use-event-handler-attr`](./src/no-use-event-handler-attr)
-
-### Style
-
-- [`attr-value-quotes`](./src/attr-value-quotes)
-- [`case-sensitive-attr-name`](./src/case-sensitive-attr-name)
-- [`case-sensitive-tag-name`](./src/case-sensitive-tag-name)
-- [`end-tag`](./src/end-tag)
-- [`no-boolean-attr-value`](./src/no-boolean-attr-value)
-- [`no-default-value`](./src/no-default-value)
+- [Rules](https://markuplint.dev/rules/)
 
 ## Install
 
-Generally, you **don't have to install** this package because markuplint dependents it defaultly.
+[`markuplint`](https://www.npmjs.com/package/markuplint) package includes this package.
 
-```sh
+<details>
+<summary>If you are installing purposely, how below:</summary>
+
+```shell
 $ npm install -D @markuplint/rules
 
 $ yarn add -D @markuplint/rules
 ```
+
+</details>

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';
-declare type Invalid = {
-    invalidType: 'non-existent' | 'invalid-value';
-    message: string;
-    loc?: Loc;
+import type { ReadonlyDeep } from 'type-fest';
+type Invalid = {
+	invalidType: 'non-existent' | 'invalid-value' | 'disallowed-attr';
+	message: string;
+	loc?: Loc;
 };
-declare type Loc = {
-    raw: string;
-    line: number;
-    col: number;
+type Loc = {
+	raw: string;
+	line: number;
+	col: number;
 };
 /**
  * Use in rules `invalid-attr` and `wai-aria`
@@ -18,6 +19,17 @@ declare 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,8 +23,14 @@ 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;
+        }
     }
-    // Existance
+    // Existence
     if (!spec) {
         (0, debug_1.log)('The "%s" attribute DOES\'NT EXIST in the spec', name);
         return {
@@ -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,15 +5,16 @@ 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) {
                     continue;
                 }
                 const attrName = attr.name;
-                const name = node.isCustomElement ? attrName : attrName.toLowerCase();
+                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 declare type Type = 'double' | 'single';
-export declare type Quote = '"' | "'";
-export declare type QuoteMap = {
-    [P in Type]: Quote;
+export type Type = 'double' | 'single';
+export type Quote = '"' | "'";
+export type QuoteMap = {
+	[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/attr-value-quotes/index.js

@@ -6,7 +6,7 @@ const quoteList = {
     single: "'",
 };
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     defaultValue: 'double',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {

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

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

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

@@ -2,13 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     defaultValue: 'lower',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             var _a, _b, _c, _d;
             const el = attr.ownerElement;
-            if (el.isForeignElement || el.isCustomElement) {
+            if (el.isForeignElement || el.elementType !== 'html') {
                 return;
             }
             const value = attr.rule.value;
@@ -46,7 +46,7 @@ exports.default = (0, ml_core_1.createRule)({
         await document.walkOn('Attr', attr => {
             var _a;
             const el = attr.ownerElement;
-            if (el.isForeignElement || el.isCustomElement) {
+            if (el.isForeignElement || el.elementType !== 'html') {
                 return;
             }
             const attrSpecs = (0, ml_core_1.getAttrSpecs)(el, document.specs);

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

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

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

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     defaultValue: 'lower',
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
-            if (el.isForeignElement || el.isCustomElement) {
+            if (el.isForeignElement || el.elementType !== 'html') {
                 return;
             }
             const ms = el.rule.severity === 'error' ? 'must' : 'should';
@@ -38,7 +38,7 @@ exports.default = (0, ml_core_1.createRule)({
     },
     async fix({ document }) {
         await document.walkOn('Element', el => {
-            if (el.isForeignElement || el.isCustomElement) {
+            if (el.isForeignElement || el.elementType !== 'html') {
                 return;
             }
             const deny = el.rule.value === 'lower' ? /[A-Z]/ : /[a-z]/;

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/character-reference/index.js

@@ -40,7 +40,7 @@ exports.default = (0, ml_core_1.createRule)({
             }
         });
         for (const targetNode of targetNodes) {
-            if (!('scope' in targetNode && 'line' in targetNode)) {
+            if (!('scope' in targetNode && 'line' in targetNode && targetNode.line != null)) {
                 continue;
             }
             const escapedText = targetNode.raw.replace(/&(?:[a-z]+|#[0-9]+|x[0-9]);/gi, $0 => '*'.repeat($0.length));

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

@@ -1,3 +1,3 @@
-export declare type Value = string | string[] | null;
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+export type Value = string | string[] | 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)({
-    defaultServerity: 'warning',
+    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' | 'candicate' | '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,11 +22,12 @@ function createMessageValueExpected(t, baseTarget, type, matches) {
 }
 exports.createMessageValueExpected = createMessageValueExpected;
 function __createMessageValueExpected(t, baseTarget, expected, matches) {
+    var _a;
     let target = baseTarget;
     let reasonPart;
     let expectPart;
     let unnecessaryPart;
-    let candicatePart;
+    let candidatePart;
     let expectOrNeed = 'expects';
     if (matches.partName) {
         if (matches.partName === 'the content of the list') {
@@ -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');
@@ -188,10 +189,10 @@ function __createMessageValueExpected(t, baseTarget, expected, matches) {
             }
         }
     }
-    if (matches.candicate) {
-        candicatePart = t('Did you mean "{0*}"?', matches.candicate);
+    if (matches.candidate) {
+        candidatePart = t('Did you mean "{0*}"?', matches.candidate);
     }
-    let message = [reasonPart, unnecessaryPart, expectPart, candicatePart].filter(s => s).join(t('. '));
+    let message = [reasonPart, unnecessaryPart, expectPart, candidatePart].filter(s => s).join(t('. '));
     if (matches.ref) {
         message += ` (${matches.ref})`;
     }
@@ -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) {
@@ -232,7 +233,7 @@ function expectValueToWord(t, expect, type) {
             return expect.value ? `%${expect.value}%` : '';
         case 'format':
             return t('the {0} format', expect.value);
-        case 'regxp':
+        case 'regexp':
             return t('{0} ({1})', 'regular expression', expect.value);
         case 'syntax':
             if ((0, types_1.isKeyword)(type) && type[0] === '<') {

package/lib/debug.d.ts

@@ -1,3 +1,3 @@
 import debug from 'debug';
-export declare type Log = debug.Debugger;
+export type Log = debug.Debugger;
 export declare const log: debug.Debugger;

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

@@ -6,12 +6,12 @@ exports.default = (0, ml_core_1.createRule)({
         await document.walkOn('Element', el => {
             if (!(el.namespaceURI === 'http://www.w3.org/1999/xhtml' ||
                 el.namespaceURI === 'http://www.w3.org/2000/svg') ||
-                el.isCustomElement) {
+                el.elementType !== 'html') {
                 return;
             }
-            const spec = (0, ml_core_1.getSpec)(el, document.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');
+            const spec = (0, ml_core_1.getSpec)(el, document.specs.specs);
+            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 @@
-declare type Option = {
-    denyObsolateType: boolean;
+type Option = {
+	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/doctype/index.js

@@ -4,7 +4,7 @@ const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
     defaultValue: 'always',
     defaultOptions: {
-        denyObsolateType: true,
+        denyObsoleteType: true,
     },
     verify({ document, report, t }) {
         if (document.isFragment) {
@@ -23,7 +23,7 @@ exports.default = (0, ml_core_1.createRule)({
         if ((doctype.name.toLowerCase() === 'html' && doctype.publicId) || doctype.systemId) {
             report({
                 scope: doctype,
-                message: t('Never {0} {1}', 'declarate', 'obsolete doctype'),
+                message: t('Never {0} {1}', 'declare', 'obsolete doctype'),
             });
         }
     },

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/end-tag/index.js

@@ -1,24 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
-const voidElements = [
-    'area',
-    'base',
-    'br',
-    'col',
-    'embed',
-    'hr',
-    'img',
-    'input',
-    'link',
-    'meta',
-    'param',
-    'source',
-    'track',
-    'wbr',
-];
+const ml_spec_1 = require("@markuplint/ml-spec");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         if (document.endTag === 'never') {
             return;
@@ -28,7 +13,7 @@ exports.default = (0, ml_core_1.createRule)({
             if (el.isOmitted) {
                 return;
             }
-            if (voidElements.some(vE => vE === el.localName)) {
+            if ((0, ml_spec_1.isVoidElement)(el)) {
                 return;
             }
             if (el.closeTag != null) {