@markuplint/rules 2.4.2 → 3.0.0-alpha.66

package/README.md

@@ -33,21 +33,17 @@
 
 - [`class-naming`](./src/class-naming)
 
-### Maintenability
+### Maintainability
 
 - [`no-hard-code-id`](./src/no-hard-code-id)
 - [`no-use-event-handler-attr`](./src/no-use-event-handler-attr)
 
 ### Style
 
-- [`attr-equal-space-after`](./src/attr-equal-space-after)
-- [`attr-equal-space-before`](./src/attr-equal-space-before)
-- [`attr-spacing`](./src/attr-spacing)
 - [`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)
-- [`indentation`](./src/indentation)
 - [`no-boolean-attr-value`](./src/no-boolean-attr-value)
 - [`no-default-value`](./src/no-default-value)
 

package/lib/attr-duplication/index.js

@@ -6,19 +6,22 @@ exports.default = (0, ml_core_1.createRule)({
         const message = t('{0} is {1:c}', t('the {0}', 'attribute name'), 'duplicated');
         await document.walkOn('Element', node => {
             const attrNameStack = [];
-            for (const attr of node.attributes) {
+            for (const attr of node.getAttributeTokens()) {
                 if (attr.isDuplicatable) {
                     continue;
                 }
-                const attrName = attr.getName();
-                const name = node.isCustomElement ? attrName.potential : attrName.potential.toLowerCase();
+                const attrName = attr.name;
+                const name = node.isCustomElement ? attrName : attrName.toLowerCase();
                 if (attrNameStack.includes(name)) {
+                    const scope = attr.nameNode || attr;
                     report({
-                        scope: node,
+                        scope: {
+                            rule: node.rule,
+                            startLine: scope.startLine,
+                            startCol: scope.startCol,
+                            raw: scope.raw,
+                        },
                         message,
-                        line: attrName.line,
-                        col: attrName.col,
-                        raw: attrName.raw,
                     });
                 }
                 else {

package/lib/attr-equal-space-after/index.d.ts

@@ -1,3 +1,3 @@
 declare type Value = 'always' | 'never' | 'always-single-line' | 'never-single-line';
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Value, null>;
 export default _default;

package/lib/attr-equal-space-before/index.d.ts

@@ -1,3 +1,3 @@
 declare type Value = 'always' | 'never' | 'always-single-line' | 'never-single-line';
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Value, null>;
 export default _default;

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

@@ -1,6 +1,6 @@
 export interface AttrSpasingOptions {
-    lineBreak?: 'either' | 'always' | 'never';
-    width?: number | false;
+	lineBreak?: 'either' | 'always' | 'never';
+	width?: number | false;
 }
-declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, AttrSpasingOptions>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<boolean, AttrSpasingOptions>;
 export default _default;

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

@@ -8,34 +8,30 @@ const quoteList = {
 exports.default = (0, ml_core_1.createRule)({
     defaultServerity: 'warning',
     defaultValue: 'double',
-    async verify(context) {
-        await context.document.walkOn('Element', node => {
-            const message = context.translate('{0} is must {1} on {2}', 'Attribute value', 'quote', `${node.rule.value} quotation mark`);
-            for (const attr of node.attributes) {
-                if (attr.attrType === 'ps-attr' || attr.isDynamicValue || attr.isDirective || attr.equal.raw === '') {
-                    continue;
-                }
-                const quote = attr.startQuote.raw;
-                if (quote !== quoteList[node.rule.value]) {
-                    context.report({
-                        scope: node,
-                        message,
-                        line: attr.name.startLine,
-                        col: attr.name.startCol,
-                        raw: attr.raw.trim(),
-                    });
-                }
+    async verify({ document, report, t }) {
+        await document.walkOn('Attr', attr => {
+            var _a, _b;
+            const message = t('{0} is must {1} on {2}', 'Attribute value', 'quote', `${attr.rule.value} quotation mark`);
+            if (attr.isDynamicValue || attr.isDirective || !attr.equal || ((_a = attr.equal) === null || _a === void 0 ? void 0 : _a.raw) === '') {
+                return;
+            }
+            const quote = (_b = attr.startQuote) === null || _b === void 0 ? void 0 : _b.raw;
+            if (quote !== quoteList[attr.rule.value]) {
+                report({
+                    scope: attr,
+                    message,
+                });
             }
         });
     },
-    async fix(context) {
-        await context.document.walkOn('Element', node => {
-            for (const attr of node.attributes) {
-                const quote = quoteList[node.rule.value];
-                if (attr.attrType === 'html-attr' && quote && attr.startQuote && attr.startQuote.raw !== quote) {
-                    attr.startQuote.fix(quote);
-                    attr.endQuote.fix(quote);
-                }
+    async fix({ document }) {
+        await document.walkOn('Attr', attr => {
+            var _a;
+            const quote = quoteList[attr.rule.value];
+            if (quote && attr.startQuote && attr.startQuote.raw !== quote) {
+                attr.startQuote.fix(quote);
+                // TODO: attr.endQuote = new MLToken(quote);
+                (_a = attr.endQuote) === null || _a === void 0 ? void 0 : _a.fix(quote);
             }
         });
     },

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

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

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

@@ -5,102 +5,72 @@ exports.default = (0, ml_core_1.createRule)({
     defaultServerity: 'warning',
     defaultValue: 'lower',
     async verify({ document, report, t }) {
-        await document.walkOn('Element', node => {
-            if (node.isForeignElement || node.isCustomElement) {
+        await document.walkOn('Attr', attr => {
+            var _a, _b, _c, _d;
+            const el = attr.ownerElement;
+            if (el.isForeignElement || el.isCustomElement) {
                 return;
             }
-            let value;
-            // Convert deprecated value
-            switch (node.rule.value) {
-                case 'no-lower':
-                    value = 'upper';
-                    break;
-                case 'no-upper':
-                    value = 'lower';
-                    break;
-                default:
-                    value = node.rule.value;
-            }
-            const ms = node.rule.severity === 'error' ? 'must' : 'should';
+            const value = attr.rule.value;
+            const ms = attr.rule.severity === 'error' ? 'must' : 'should';
             const deny = value === 'lower' ? /[A-Z]/ : /[a-z]/;
             const cases = value === 'lower' ? 'lower' : 'upper';
             const message = t(`{0} ${ms} be {1}`, t('{0} of {1}', 'attribute names', 'HTML elements'), `${cases}case`);
-            const attrSpecs = (0, ml_core_1.getAttrSpecs)(node.nameWithNS, document.specs);
-            for (const attr of node.attributes) {
-                if (attr.attrType === 'ps-attr') {
-                    continue;
-                }
-                /**
-                 * Ignore when it has the potential name,
-                 * it Interprets `tabIndex` to `tabindex` in JSX for example.
-                 */
-                if (attr.name.raw !== attr.potentialName) {
-                    continue;
-                }
-                const name = attr.getName();
-                if (attrSpecs) {
-                    const spec = attrSpecs.find(spec => spec.name === name.raw);
-                    if (spec && spec.caseSensitive) {
-                        continue;
-                    }
-                }
-                if (deny.test(name.raw)) {
-                    report({
-                        scope: node,
-                        message,
-                        line: name.line,
-                        col: name.col,
-                        raw: name.raw,
-                    });
+            const attrSpecs = (0, ml_core_1.getAttrSpecs)(el, document.specs);
+            /**
+             * Ignore when it has the potential name,
+             * it Interprets `tabIndex` to `tabindex` in JSX for example.
+             */
+            if (((_a = attr.nameNode) === null || _a === void 0 ? void 0 : _a.raw) !== attr.name) {
+                return;
+            }
+            const name = attr.name;
+            if (attrSpecs) {
+                const spec = attrSpecs.find(spec => spec.name === name);
+                if (spec && spec.caseSensitive) {
+                    return;
                 }
             }
+            if (deny.test(name)) {
+                report({
+                    scope: attr,
+                    line: (_b = attr.nameNode) === null || _b === void 0 ? void 0 : _b.startLine,
+                    col: (_c = attr.nameNode) === null || _c === void 0 ? void 0 : _c.startCol,
+                    raw: (_d = attr.nameNode) === null || _d === void 0 ? void 0 : _d.raw,
+                    message,
+                });
+            }
         });
     },
     async fix({ document }) {
-        await document.walkOn('Element', node => {
-            if (node.isForeignElement || node.isCustomElement) {
+        await document.walkOn('Attr', attr => {
+            var _a;
+            const el = attr.ownerElement;
+            if (el.isForeignElement || el.isCustomElement) {
                 return;
             }
-            const attrSpecs = (0, ml_core_1.getAttrSpecs)(node.nameWithNS, document.specs);
-            let value;
-            // Convert deprecated value
-            switch (node.rule.value) {
-                case 'no-lower':
-                    value = 'upper';
-                    break;
-                case 'no-upper':
-                    value = 'lower';
-                    break;
-                default:
-                    value = node.rule.value;
+            const attrSpecs = (0, ml_core_1.getAttrSpecs)(el, document.specs);
+            const value = attr.rule.value;
+            /**
+             * Ignore when it has the potential name,
+             * it Interprets `tabIndex` to `tabindex` in JSX for example.
+             */
+            if (((_a = attr.nameNode) === null || _a === void 0 ? void 0 : _a.raw) !== attr.name) {
+                return;
             }
-            if (node.attributes) {
-                for (const attr of node.attributes) {
-                    if (attr.attrType === 'ps-attr') {
-                        continue;
-                    }
-                    /**
-                     * Ignore when it has the potential name,
-                     * it Interprets `tabIndex` to `tabindex` in JSX for example.
-                     */
-                    if (attr.name.raw !== attr.potentialName) {
-                        continue;
-                    }
-                    const name = attr.getName();
-                    if (attrSpecs) {
-                        const spec = attrSpecs.find(spec => spec.name === name.raw);
-                        if (spec && spec.caseSensitive) {
-                            continue;
-                        }
-                    }
-                    if (value === 'lower') {
-                        attr.name.fix(attr.name.raw.toLowerCase());
-                    }
-                    else {
-                        attr.name.fix(attr.name.raw.toUpperCase());
-                    }
+            const name = attr.name;
+            if (attrSpecs) {
+                const spec = attrSpecs.find(spec => spec.name === name);
+                if (spec && spec.caseSensitive) {
+                    return;
                 }
             }
+            if (value === 'lower') {
+                attr.nameNode.fix(name.toLowerCase());
+            }
+            else {
+                attr.nameNode.fix(name.toUpperCase());
+            }
         });
     },
 });

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

@@ -5,41 +5,49 @@ exports.default = (0, ml_core_1.createRule)({
     defaultServerity: 'warning',
     defaultValue: 'lower',
     async verify({ document, report, t }) {
-        await document.walk(node => {
-            if ('fixNodeName' in node) {
-                if (node.isForeignElement || node.isCustomElement || node.type === 'OmittedElement') {
-                    return;
-                }
-                const ms = node.rule.severity === 'error' ? 'must' : 'should';
-                const deny = node.rule.value === 'lower' ? /[A-Z]/ : /[a-z]/;
-                const message = t(`{0} ${ms} be {1}`, t('{0} of {1}', 'tag names', 'HTML elements'), `${node.rule.value}case`);
-                if (deny.test(node.nodeName)) {
-                    const loc = node.getNameLocation();
-                    report({
-                        scope: node,
-                        message,
-                        line: loc.line,
-                        col: loc.col,
-                        raw: node.nodeName,
-                    });
-                }
+        await document.walkOn('Element', el => {
+            if (el.isForeignElement || el.isCustomElement) {
+                return;
+            }
+            const ms = el.rule.severity === 'error' ? 'must' : 'should';
+            const deny = el.rule.value === 'lower' ? /[A-Z]/ : /[a-z]/;
+            const message = t(`{0} ${ms} be {1}`, t('{0} of {1}', 'tag names', 'HTML elements'), `${el.rule.value}case`);
+            if (deny.test(el.rawName)) {
+                const loc = el.getNameLocation();
+                report({
+                    scope: el,
+                    message,
+                    line: loc.line,
+                    col: loc.col,
+                    raw: el.rawName,
+                });
+            }
+            const closeTag = el.closeTag;
+            if (closeTag && deny.test(closeTag.raw)) {
+                report({
+                    scope: {
+                        rule: el.rule,
+                        startLine: closeTag.startLine,
+                        startCol: closeTag.startCol,
+                        raw: closeTag.raw,
+                    },
+                    message,
+                });
             }
         });
     },
     async fix({ document }) {
-        await document.walk(node => {
-            if ('fixNodeName' in node) {
-                if (node.isForeignElement || node.isCustomElement) {
-                    return;
+        await document.walkOn('Element', el => {
+            if (el.isForeignElement || el.isCustomElement) {
+                return;
+            }
+            const deny = el.rule.value === 'lower' ? /[A-Z]/ : /[a-z]/;
+            if (deny.test(el.nodeName)) {
+                if (el.rule.value === 'lower') {
+                    el.fixNodeName(el.nodeName.toLowerCase());
                 }
-                const deny = node.rule.value === 'lower' ? /[A-Z]/ : /[a-z]/;
-                if (deny.test(node.nodeName)) {
-                    if (node.rule.value === 'lower') {
-                        node.fixNodeName(node.nodeName.toLowerCase());
-                    }
-                    else {
-                        node.fixNodeName(node.nodeName.toUpperCase());
-                    }
+                else {
+                    el.fixNodeName(el.nodeName.toUpperCase());
                 }
             }
         });

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

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

package/lib/character-reference/index.js

@@ -26,17 +26,15 @@ exports.default = (0, ml_core_1.createRule)({
             const ms = severity === 'error' ? 'must' : 'should';
             const message = t(`{0} ${ms} {1}`, 'Illegal characters', 'escape in character reference');
             for (const attr of node.attributes) {
-                if (attr.attrType === 'ps-attr' ||
-                    (attr.attrType === 'html-attr' && attr.isDynamicValue) ||
-                    (attr.attrType === 'html-attr' && attr.isDirective)) {
+                if (attr.isDynamicValue || attr.isDirective) {
                     continue;
                 }
-                const value = attr.getValue();
+                const valueNode = attr.valueNode;
                 targetNodes.push({
                     scope: node,
-                    line: value.line,
-                    col: value.col,
-                    raw: value.raw,
+                    line: valueNode === null || valueNode === void 0 ? void 0 : valueNode.startLine,
+                    col: valueNode === null || valueNode === void 0 ? void 0 : valueNode.startCol,
+                    raw: valueNode === null || valueNode === void 0 ? void 0 : valueNode.raw,
                     message,
                 });
             }

package/lib/class-naming/index.js

@@ -6,29 +6,29 @@ exports.default = (0, ml_core_1.createRule)({
     defaultServerity: 'warning',
     defaultValue: null,
     async verify({ document, report, t }) {
-        await document.walkOn('Element', node => {
-            if (!node.rule.value) {
+        await document.walkOn('Element', el => {
+            if (!el.rule.value) {
                 return;
             }
-            const classPatterns = Array.isArray(node.rule.value) ? node.rule.value : [node.rule.value];
-            const attrs = node.getAttributeToken('class');
+            const classPatterns = Array.isArray(el.rule.value) ? el.rule.value : [el.rule.value];
+            const attrs = el.getAttributeToken('class');
             for (const attr of attrs) {
-                if (attr.attrType === 'html-attr' && attr.isDynamicValue) {
+                if (attr.isDynamicValue) {
                     continue;
                 }
-                const classAttr = attr.getValue();
-                const classList = classAttr.potential
+                const classAttr = attr.valueNode;
+                const classList = attr.value
                     .split(/\s+/g)
                     .map(c => c.trim())
                     .filter(c => c);
                 for (const className of classList) {
                     if (!classPatterns.some(pattern => (0, helpers_1.match)(className, pattern))) {
                         report({
-                            scope: node,
+                            scope: attr,
                             message: t('{0} is unmatched with the below patterns: {1}', t('the "{0*}" {1}', className, 'class name'), `"${classPatterns.join('", "')}"`),
-                            line: classAttr.line,
-                            col: classAttr.col,
-                            raw: classAttr.raw,
+                            line: classAttr === null || classAttr === void 0 ? void 0 : classAttr.startLine,
+                            col: classAttr === null || classAttr === void 0 ? void 0 : classAttr.startCol,
+                            raw: classAttr === null || classAttr === void 0 ? void 0 : classAttr.raw,
                         });
                     }
                 }

package/lib/deprecated-attr/index.js

@@ -3,27 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
     async verify({ document, report, t }) {
-        await document.walkOn('Element', element => {
-            const attrSpecs = (0, ml_core_1.getAttrSpecs)(element.nameWithNS, document.specs);
+        await document.walkOn('Attr', attr => {
+            var _a, _b, _c;
+            const attrSpecs = (0, ml_core_1.getAttrSpecs)(attr.ownerElement, document.specs);
             if (!attrSpecs) {
                 return;
             }
-            for (const attr of element.attributes) {
-                const name = attr.getName();
-                const attrSpec = attrSpecs.find(item => item.name === name.potential);
-                if (!attrSpec) {
-                    return;
-                }
-                if (attrSpec.deprecated || attrSpec.obsolete) {
-                    const message = t('{0} is {1:c}', t('the "{0*}" {1}', name.potential, 'attribute'), attrSpec.obsolete ? 'obsolete' : 'deprecated');
-                    report({
-                        scope: element,
-                        message,
-                        line: name.line,
-                        col: name.col,
-                        raw: name.raw,
-                    });
-                }
+            const name = attr.name;
+            const attrSpec = attrSpecs.find(item => item.name === name);
+            if (!attrSpec) {
+                return;
+            }
+            if (attrSpec.deprecated || attrSpec.obsolete) {
+                const message = t('{0} is {1:c}', t('the "{0*}" {1}', name, 'attribute'), attrSpec.obsolete ? 'obsolete' : 'deprecated');
+                report({
+                    scope: attr,
+                    line: (_a = attr.nameNode) === null || _a === void 0 ? void 0 : _a.startLine,
+                    col: (_b = attr.nameNode) === null || _b === void 0 ? void 0 : _b.startCol,
+                    raw: (_c = attr.nameNode) === null || _c === void 0 ? void 0 : _c.raw,
+                    message,
+                });
             }
         });
     },

package/lib/deprecated-element/index.js

@@ -1,19 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const html_spec_1 = tslib_1.__importDefault(require("@markuplint/html-spec"));
 const ml_core_1 = require("@markuplint/ml-core");
-const ml_spec_1 = require("@markuplint/ml-spec");
 exports.default = (0, ml_core_1.createRule)({
     async verify({ document, report, t }) {
         await document.walkOn('Element', el => {
-            const ns = el.ns;
-            if (!(ns === 'html' || ns === 'svg') || el.isCustomElement) {
+            if (!(el.namespaceURI === 'http://www.w3.org/1999/xhtml' ||
+                el.namespaceURI === 'http://www.w3.org/2000/svg') ||
+                el.isCustomElement) {
                 return;
             }
-            const spec = (0, ml_spec_1.getSpecByTagName)(el.nameWithNS, html_spec_1.default);
+            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.nodeName, 'element'), spec.deprecated ? 'deprecated' : spec.obsolete ? 'obsolete' : 'non-standard');
+                const message = t('{0} is {1:c}', t('the "{0*}" {1}', el.localName, 'element'), spec.deprecated ? 'deprecated' : spec.obsolete ? 'obsolete' : 'non-standard');
                 report({
                     scope: el,
                     message,

package/lib/disallowed-element/index.js

@@ -3,31 +3,30 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
 exports.default = (0, ml_core_1.createRule)({
     defaultValue: [],
-    defaultOptions: null,
-    async verify({ document, report, t, globalRule }) {
-        for (const query of globalRule.value) {
-            const elements = document.matchNodes(query);
-            for (const el of elements) {
+    async verify({ document, report, t }) {
+        for (const query of document.rule.value) {
+            const elements = document.querySelectorAll(query);
+            elements.forEach(el => {
                 const message = t('{0} is disallowed', t('the "{0*}" {1}', query, 'element'));
                 report({
                     scope: el,
                     message,
                 });
-            }
+            });
         }
         await document.walkOn('Element', el => {
-            if (el.rule.value === globalRule.value) {
+            if (el.rule.value === document.rule.value) {
                 return;
             }
             for (const query of el.rule.value) {
                 const elements = el.querySelectorAll(query);
-                for (const el of elements) {
+                elements.forEach(el => {
                     const message = t('{0} is disallowed', t('the "{0*}" {1}', query, 'element'));
                     report({
                         scope: el,
                         message,
                     });
-                }
+                });
             }
         });
     },

package/lib/doctype/index.js

@@ -6,14 +6,14 @@ exports.default = (0, ml_core_1.createRule)({
     defaultOptions: {
         denyObsolateType: true,
     },
-    verify(context) {
-        if (context.document.isFragment) {
+    verify({ document, report, t }) {
+        if (document.isFragment) {
             return;
         }
-        const doctype = context.document.doctype;
+        const doctype = document.doctype;
         if (!doctype) {
-            context.report({
-                message: context.translate('Require {0}', 'doctype'),
+            report({
+                message: t('Require {0}', 'doctype'),
                 line: 1,
                 col: 1,
                 raw: '',
@@ -21,9 +21,9 @@ exports.default = (0, ml_core_1.createRule)({
             return;
         }
         if ((doctype.name.toLowerCase() === 'html' && doctype.publicId) || doctype.systemId) {
-            context.report({
+            report({
                 scope: doctype,
-                message: context.translate('Never {0} {1}', 'declarate', 'obsolete doctype'),
+                message: t('Never {0} {1}', 'declarate', 'obsolete doctype'),
             });
         }
     },

package/lib/end-tag/index.js

@@ -25,7 +25,10 @@ exports.default = (0, ml_core_1.createRule)({
         }
         await document.walkOn('Element', el => {
             var _a;
-            if (voidElements.some(vE => vE === el.nodeName.toLowerCase())) {
+            if (el.isOmitted) {
+                return;
+            }
+            if (voidElements.some(vE => vE === el.localName)) {
                 return;
             }
             if (el.closeTag != null) {

package/lib/helper/aria/get-aria.d.ts

@@ -0,0 +1,7 @@
+import type { Element } from '@markuplint/ml-core';
+import type { ARIA, ARIAVersion, MLMLSpec } from '@markuplint/ml-spec';
+export declare function getARIA(
+	specs: Readonly<MLMLSpec>,
+	el: Element<any, any>,
+	version: ARIAVersion,
+): Omit<ARIA, ARIAVersion | 'conditions'> | null;