@markuplint/rules 3.0.0-alpha.0 → 3.0.0-alpha.2

package/README.md

@@ -49,7 +49,7 @@
 
 ## Install
 
-Generally, you **don't have to install** this package because markuplint dependents it defaultly.
+Generally, you **don't have to install** this package because markuplint dependents it by default.
 
 ```sh
 $ npm install -D @markuplint/rules

package/lib/attr-check.js

@@ -23,7 +23,7 @@ function attrCheck(t, name, value, isCustomRule, spec) {
             return false;
         }
     }
-    // Existance
+    // Existence
     if (!spec) {
         (0, debug_1.log)('The "%s" attribute DOES\'NT EXIST in the spec', name);
         return {

package/lib/attr-duplication/index.js

@@ -11,7 +11,7 @@ exports.default = (0, ml_core_1.createRule)({
                     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;
                     report({

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.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.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/class-naming/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 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 => {

package/lib/create-message.d.ts

@@ -2,4 +2,4 @@ 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;
+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

@@ -26,7 +26,7 @@ function __createMessageValueExpected(t, baseTarget, expected, matches) {
     let reasonPart;
     let expectPart;
     let unnecessaryPart;
-    let candicatePart;
+    let candidatePart;
     let expectOrNeed = 'expects';
     if (matches.partName) {
         if (matches.partName === 'the content of the list') {
@@ -188,10 +188,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})`;
     }
@@ -232,7 +232,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/deprecated-element/index.js

@@ -6,10 +6,10 @@ 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);
+            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');
                 report({

package/lib/doctype/index.d.ts

@@ -1,5 +1,5 @@
 declare type Option = {
-    denyObsolateType: boolean;
+    denyObsoleteType: boolean;
 };
 declare const _default: 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) {

package/lib/end-tag/index.js

@@ -18,7 +18,7 @@ const voidElements = [
     'wbr',
 ];
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         if (document.endTag === 'never') {
             return;

package/lib/helpers.d.ts

@@ -60,12 +60,17 @@ export declare function checkAria(specs: Readonly<MLMLSpec>, attrName: string, c
     valueDescriptions?: Record<string, string> | undefined;
 };
 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>, docuemnt: Document<V, O>): Element<V, O> | null;
+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 class Collection<T> {
     #private;
     constructor(...items: (T | null | undefined)[]);
+    [Symbol.iterator](): Iterator<T>;
     add(...items: (T | null | undefined)[]): void;
     toArray(): readonly T[];
-    [Symbol.iterator](): Iterator<T>;
 }
+declare type Writeable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+export declare function deepCopy<T>(value: T): Writeable<T>;
+export {};

package/lib/helpers.js

@@ -1,9 +1,11 @@
 "use strict";
 var _Collection_items;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Collection = exports.decodeCharRef = exports.getOwnedLabel = exports.accnameMayBeMutable = exports.checkAria = exports.checkAriaValue = exports.toNormalizedValue = exports.isValidAttr = exports.rePCENChar = exports.match = exports.attrMatches = void 0;
+exports.deepCopy = exports.Collection = exports.decodeCharRef = exports.getOwnedLabel = exports.accnameMayBeMutable = exports.checkAria = exports.checkAriaValue = exports.toNormalizedValue = exports.isValidAttr = exports.rePCENChar = exports.match = exports.attrMatches = void 0;
 const tslib_1 = require("tslib");
 const ml_core_1 = require("@markuplint/ml-core");
+// @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) {
@@ -178,26 +180,26 @@ function accnameMayBeMutable(el, document) {
     if (el.hasMutableAttributes() || el.hasMutableChildren(true)) {
         return true;
     }
-    const ownedLable = getOwnedLabel(el, document);
-    if (ownedLable && (ownedLable.hasMutableAttributes() || ownedLable.hasMutableChildren(true))) {
+    const ownedLabel = getOwnedLabel(el, document);
+    if (ownedLabel && (ownedLabel.hasMutableAttributes() || ownedLabel.hasMutableChildren(true))) {
         return true;
     }
     return false;
 }
 exports.accnameMayBeMutable = accnameMayBeMutable;
 const labelable = ['button', 'input:not([type=hidden])', 'meter', 'output', 'progress', 'select', 'textarea'];
-function getOwnedLabel(el, docuemnt) {
+function getOwnedLabel(el, document) {
     if (!labelable.some(cond => el.matches(cond))) {
         return null;
     }
-    let ownedLable = el.closest('label');
-    if (!ownedLable) {
+    let ownedLabel = el.closest('label');
+    if (!ownedLabel) {
         const id = el.getAttribute('id');
         if (id) {
-            ownedLable = docuemnt.querySelector(`label[for="${id}"]`);
+            ownedLabel = document.querySelector(`label[for="${id}"]`);
         }
     }
-    return ownedLable;
+    return ownedLabel;
 }
 exports.getOwnedLabel = getOwnedLabel;
 function decodeCharRef(characterReference) {
@@ -209,6 +211,9 @@ class Collection {
         _Collection_items.set(this, new Set());
         this.add(...items);
     }
+    [(_Collection_items = new WeakMap(), Symbol.iterator)]() {
+        return tslib_1.__classPrivateFieldGet(this, _Collection_items, "f").values();
+    }
     add(...items) {
         for (const item of items) {
             if (item == null) {
@@ -220,8 +225,9 @@ class Collection {
     toArray() {
         return Object.freeze(Array.from(tslib_1.__classPrivateFieldGet(this, _Collection_items, "f")));
     }
-    [(_Collection_items = new WeakMap(), Symbol.iterator)]() {
-        return tslib_1.__classPrivateFieldGet(this, _Collection_items, "f").values();
-    }
 }
 exports.Collection = Collection;
+function deepCopy(value) {
+    return (0, structured_clone_1.default)(value);
+}
+exports.deepCopy = deepCopy;

package/lib/index.d.ts

@@ -9,7 +9,7 @@ declare const _default: {
     'deprecated-element': import("packages/@markuplint/ml-core/lib").RuleSeed<import("packages/@markuplint/ml-config/src").RuleConfigValue, null>;
     'disallowed-element': import("packages/@markuplint/ml-core/lib").RuleSeed<string[], null>;
     doctype: import("packages/@markuplint/ml-core/lib").RuleSeed<"always", {
-        denyObsolateType: boolean;
+        denyObsoleteType: boolean;
     }>;
     'end-tag': import("packages/@markuplint/ml-core/lib").RuleSeed<boolean, null>;
     'id-duplication': import("packages/@markuplint/ml-core/lib").RuleSeed<import("packages/@markuplint/ml-config/src").RuleConfigValue, null>;
@@ -39,11 +39,7 @@ declare const _default: {
     'no-use-event-handler-attr': import("packages/@markuplint/ml-core/lib").RuleSeed<boolean, {
         ignore?: string | string[] | undefined;
     }>;
-    'permitted-contents': import("packages/@markuplint/ml-core/lib").RuleSeed<(import("packages/@markuplint/ml-spec/lib").ContentModel & {
-        tag: string;
-    })[], {
-        ignoreHasMutableChildren: boolean;
-    }>;
+    'permitted-contents': import("packages/@markuplint/ml-core/lib").RuleSeed<import("./permitted-contents/types").TagRule[], import("./permitted-contents/types").Options>;
     'require-accessible-name': import("packages/@markuplint/ml-core/lib").RuleSeed<boolean, {
         ariaVersion: import("packages/@markuplint/ml-spec/lib").ARIAVersion;
     }>;

package/lib/ineffective-attr/index.js

@@ -2,7 +2,7 @@
 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',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             const attrSpec = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);

package/lib/invalid-attr/index.js

@@ -16,7 +16,7 @@ exports.default = (0, ml_core_1.createRule)({
             const attrSpecs = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
             const attrName = attr.nameNode;
             const name = attr.name;
-            if (!attr.ownerElement.isCustomElement && attr.candidate) {
+            if (attr.ownerElement.elementType === 'html' && attr.candidate) {
                 const message = t('{0} is {1:c}', t('the "{0*}" {1}', name, 'attribute'), 'disallowed') +
                     t('. ') +
                     t('Did you mean "{0}"?', attr.candidate);
@@ -69,7 +69,7 @@ exports.default = (0, ml_core_1.createRule)({
                     };
                 }
             }
-            else if (!attr.ownerElement.isCustomElement && attrSpecs) {
+            else if (attr.ownerElement.elementType === 'html' && attrSpecs) {
                 log('Checking %s[%s="%s"]', attr.nodeName, name, value);
                 invalid = (0, helpers_1.isValidAttr)(t, name, value, attr.isDynamicValue || false, attr.ownerElement, attrSpecs, log);
             }
@@ -91,7 +91,7 @@ exports.default = (0, ml_core_1.createRule)({
                         break;
                     }
                     case 'non-existent': {
-                        const spec = (0, ml_core_1.getSpec)(attr.ownerElement, document.specs);
+                        const spec = (0, ml_core_1.getSpec)(attr.ownerElement, document.specs.specs);
                         if (spec === null || spec === void 0 ? void 0 : spec.possibleToAddProperties) {
                             return;
                         }

package/lib/landmark-roles/index.js

@@ -12,7 +12,7 @@ const selectors = {
 };
 const topLevelRoles = ['banner', 'main', 'complementary', 'contentinfo'];
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     defaultOptions: {
         ignoreRoles: [],
         labelEachArea: true,

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

@@ -2,7 +2,7 @@
 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',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             var _a, _b;

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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 const helpers_1 = require("../helpers");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
             var _a, _b, _c;

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

@@ -2,7 +2,7 @@
 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',
     async verify({ document, report, t }) {
         if (!document.isFragment) {
             return;

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

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 const helpers_1 = require("../helpers");
 exports.default = (0, ml_core_1.createRule)({
-    defaultServerity: 'warning',
+    defaultSeverity: 'warning',
     defaultOptions: {},
     async verify({ document, report, t }) {
         await document.walkOn('Attr', attr => {
-            if (attr.ownerElement.isCustomElement) {
+            if (attr.ownerElement.elementType !== 'html') {
                 return;
             }
             const ignoreList = Array.isArray(attr.rule.option.ignore)

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

@@ -0,0 +1,3 @@
+import type { ChildNode, Options, Result, Specs } from './types';
+import type { PermittedContentChoice } from '@markuplint/ml-spec';
+export declare function choice(pattern: PermittedContentChoice, elements: ChildNode[], specs: Specs, options: Options, depth: number): Result;

package/lib/permitted-contents/choice.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.choice = void 0;
+const order_1 = require("./order");
+const utils_1 = require("./utils");
+function choice(pattern, elements, specs, options, depth) {
+    const collection = new utils_1.Collection(elements);
+    const unmatchedResults = [];
+    for (const some of pattern.choice) {
+        const result = (0, order_1.order)(some, collection.unmatched, specs, options, depth + 1);
+        if (result.type === 'UNEXPECTED_EXTRA_NODE' || result.type === 'MATCHED' || result.type === 'MATCHED_ZERO') {
+            collection.addMatched(result.matched);
+            return {
+                type: result.type,
+                matched: collection.matched,
+                unmatched: collection.unmatched,
+                zeroMatch: result.zeroMatch,
+                query: result.query,
+                hint: result.hint,
+            };
+        }
+        unmatchedResults.push(result);
+    }
+    const barelyMatchedResult = unmatchedResults.sort((a, b) => b.matched.length - a.matched.length)[0];
+    if (!barelyMatchedResult) {
+        throw new Error('Unreachable code');
+    }
+    return {
+        type: barelyMatchedResult.type,
+        matched: collection.matched,
+        unmatched: collection.unmatched,
+        zeroMatch: barelyMatchedResult.zeroMatch,
+        query: barelyMatchedResult.query,
+        hint: barelyMatchedResult.hint,
+    };
+}
+exports.choice = choice;

package/lib/permitted-contents/complex-branch.d.ts

@@ -0,0 +1,13 @@
+import type { ChildNode, Options, Result, Specs } from './types';
+import type { PermittedContentPattern } from '@markuplint/ml-spec';
+/**
+ * Check content condition
+ *
+ * @param pattern
+ * @param elements
+ * @param specs
+ * @param options
+ * @param depth
+ * @returns
+ */
+export declare function complexBranch(pattern: PermittedContentPattern, elements: ChildNode[], specs: Specs, options: Options, depth: number): Result;

package/lib/permitted-contents/complex-branch.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.complexBranch = void 0;
+const choice_1 = require("./choice");
+const count_pattern_1 = require("./count-pattern");
+const transparent_1 = require("./transparent");
+const utils_1 = require("./utils");
+/**
+ * Check content condition
+ *
+ * @param pattern
+ * @param elements
+ * @param specs
+ * @param options
+ * @param depth
+ * @returns
+ */
+function complexBranch(pattern, elements, specs, options, depth) {
+    if ((0, utils_1.isChoice)(pattern)) {
+        return (0, choice_1.choice)(pattern, elements, specs, options, depth);
+    }
+    if ((0, utils_1.isTransparent)(pattern)) {
+        return (0, transparent_1.transparent)(elements, specs, options, depth);
+    }
+    return (0, count_pattern_1.countPattern)(pattern, elements, specs, options, depth);
+}
+exports.complexBranch = complexBranch;

package/lib/permitted-contents/content-model.d.ts

@@ -0,0 +1,2 @@
+import type { ContentModelResult, Element, Options, TagRule } from './types';
+export declare function contentModel(el: Element, rules: TagRule[], options: Options): ContentModelResult[];

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

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.contentModel = void 0;
+const ml_spec_1 = require("@markuplint/ml-spec");
+const start_1 = require("./start");
+function contentModel(el, rules, options) {
+    const model = createModel(el, rules);
+    if (model == null) {
+        return [
+            {
+                type: 'MATCHED',
+                scope: el,
+                query: '*',
+                hint: {},
+            },
+        ];
+    }
+    const result = (0, start_1.start)(model, el, el.ownerMLDocument.specs, options);
+    return result;
+}
+exports.contentModel = contentModel;
+function createModel(el, rules) {
+    const specs = cachedSpecs(el.ownerMLDocument.specs, rules);
+    const model = (0, ml_spec_1.getContentModel)(el, specs.specs);
+    return model;
+}
+const caches = new Map();
+function cachedSpecs(specs, rules) {
+    if (!rules.length) {
+        return specs;
+    }
+    const key = JSON.stringify(rules);
+    const cached = caches.get(key);
+    if (cached) {
+        return cached;
+    }
+    const merged = {
+        ...specs,
+        specs: [
+            ...specs.specs,
+            ...rules.map(tag => ({
+                name: tag.tag,
+                contentModel: tag,
+            })),
+        ],
+    };
+    caches.set(key, merged);
+    return merged;
+}

package/lib/permitted-contents/count-pattern.d.ts

@@ -0,0 +1,13 @@
+import type { ChildNode, Options, Result, Specs } from './types';
+import type { PermittedContentOneOrMore, PermittedContentOptional, PermittedContentRequire, PermittedContentZeroOrMore } from '@markuplint/ml-spec';
+/**
+ * Check count
+ *
+ * @param pattern
+ * @param elements
+ * @param specs
+ * @param options
+ * @param depth
+ * @returns
+ */
+export declare function countPattern(pattern: PermittedContentOneOrMore | PermittedContentOptional | PermittedContentRequire | PermittedContentZeroOrMore, elements: readonly ChildNode[], specs: Specs, options: Options, depth: number): Result;