@markuplint/ml-core 2.0.0-rc.0 → 2.0.0-rc.6

package/lib/ml-dom/tokens/attribute.d.ts

@@ -36,4 +36,5 @@ export default class MLDOMAttribute extends MLDOMToken<MLASTHTMLAttr> {
         raw: string;
     };
     toString(withSpace?: boolean): string;
+    toNormalizeString(): string;
 }

package/lib/ml-dom/tokens/attribute.js

@@ -69,5 +69,12 @@ class MLDOMAttribute extends token_1.default {
     toString(withSpace = true) {
         return (withSpace ? this.spacesBeforeName.raw : '') + this.raw;
     }
+    toNormalizeString() {
+        return (this.name.originRaw +
+            this.equal.originRaw +
+            this.startQuote.originRaw +
+            this.value.originRaw +
+            this.endQuote.originRaw);
+    }
 }
 exports.default = MLDOMAttribute;

package/lib/ml-dom/tokens/node.d.ts

@@ -1,7 +1,7 @@
 import type { Document } from '../';
 import type { RuleInfo } from '../../';
 import type { AnonymousNode, IMLDOMNode, NodeType } from '../types';
-import type { MLDOMElement, MLDOMOmittedElement } from './';
+import type { MLDOMElement, MLDOMOmittedElement, MLDOMPreprocessorSpecificBlock } from './';
 import type { MLASTAbstructNode } from '@markuplint/ml-ast';
 import type { AnyRule, RuleConfigValue } from '@markuplint/ml-config';
 import MLDOMToken from './token';
@@ -11,13 +11,14 @@ export default abstract class MLDOMNode<T extends RuleConfigValue, O = null, A e
     readonly rules: Record<string, AnyRule>;
     protected _astToken: A;
     constructor(astNode: A, document: Document<T, O>);
-    get parentNode(): MLDOMElement<T, O> | MLDOMOmittedElement<T, O> | null;
+    get parentNode(): MLDOMElement<T, O> | MLDOMOmittedElement<T, O> | MLDOMPreprocessorSpecificBlock<T, O> | null;
     get prevNode(): AnonymousNode<T, O> | null;
     get nextNode(): AnonymousNode<T, O> | null;
-    get syntaxicalParentNode(): MLDOMElement<T, O> | null;
+    get syntaxicalParentNode(): MLDOMElement<T, O> | MLDOMPreprocessorSpecificBlock<T, O> | null;
     get prevToken(): AnonymousNode<T, O> | null;
     get nodeStore(): import("../helper").NodeStore;
-    toString(): string;
-    is(type: NodeType): boolean;
     get rule(): RuleInfo<T, O>;
+    getParentElement(): MLDOMElement<T, O> | MLDOMOmittedElement<T, O> | null;
+    is(type: NodeType): boolean;
+    toString(): string;
 }

package/lib/ml-dom/tokens/node.js

@@ -70,23 +70,34 @@ class MLDOMNode extends token_1.default {
     get nodeStore() {
         return (0, tslib_1.__classPrivateFieldGet)(this, _MLDOMNode_doc, "f").nodeStore;
     }
-    toString() {
-        return this.raw;
-    }
-    is(type) {
-        return this.type === type;
-    }
     get rule() {
         if (!(0, tslib_1.__classPrivateFieldGet)(this, _MLDOMNode_doc, "f").currentRule) {
             throw new Error('Invalid call.');
         }
         const name = (0, tslib_1.__classPrivateFieldGet)(this, _MLDOMNode_doc, "f").currentRule.name;
         const rule = this.rules[name];
-        if (rule == null) {
-            throw new Error('Invalid call "rule" property.');
-        }
         return (0, tslib_1.__classPrivateFieldGet)(this, _MLDOMNode_doc, "f").currentRule.optimizeOption(rule);
     }
+    getParentElement() {
+        let parent = this.parentNode;
+        if (!parent) {
+            return null;
+        }
+        while (parent) {
+            if (parent.type === 'PSBlock') {
+                parent = parent.parentNode;
+                continue;
+            }
+            return parent;
+        }
+        return null;
+    }
+    is(type) {
+        return this.type === type;
+    }
+    toString() {
+        return this.raw;
+    }
 }
 exports.default = MLDOMNode;
 _MLDOMNode_doc = new WeakMap(), _MLDOMNode_prevToken = new WeakMap();

package/lib/ml-dom/tokens/preprocessor-specific-attribute.d.ts

@@ -20,4 +20,5 @@ export default class MLDOMPreprocessorSpecificAttribute extends MLDOMToken<MLAST
         raw: string;
     };
     toString(): string;
+    toNormalizeString(): string;
 }

package/lib/ml-dom/tokens/preprocessor-specific-attribute.js

@@ -30,5 +30,8 @@ class MLDOMPreprocessorSpecificAttribute extends token_1.default {
     toString() {
         return this.raw;
     }
+    toNormalizeString() {
+        return this.raw;
+    }
 }
 exports.default = MLDOMPreprocessorSpecificAttribute;

package/lib/ml-rule/ml-rule.d.ts

@@ -1,7 +1,8 @@
+import type { Ruleset } from '..';
 import type Document from '../ml-dom/document';
 import type { RuleSeed } from './types';
 import type { LocaleSet } from '@markuplint/i18n';
-import type { RuleConfig, RuleConfigValue, RuleInfo, Severity, Violation } from '@markuplint/ml-config';
+import type { GlobalRuleInfo, RuleConfig, RuleConfigValue, RuleInfo, Rules, Severity, Violation } from '@markuplint/ml-config';
 export declare class MLRule<T extends RuleConfigValue, O = null> {
     #private;
     readonly name: string;
@@ -22,6 +23,8 @@ export declare class MLRule<T extends RuleConfigValue, O = null> {
         name: string;
     });
     verify(document: Document<T, O>, locale: LocaleSet, globalRule: RuleInfo<T, O>, fix: boolean): Promise<Violation[]>;
-    optimizeOption(configSettings: T | RuleConfig<T, O>): RuleInfo<T, O>;
+    getRuleInfo(ruleSet: Ruleset, ruleName: string): GlobalRuleInfo<T, O>;
+    _optimize(rules: Rules | undefined, ruleName: string): RuleInfo<T, O>;
+    optimizeOption(configSettings: T | RuleConfig<T, O> | undefined): RuleInfo<T, O>;
 }
 export declare type AnyMLRule = MLRule<RuleConfigValue, unknown>;

package/lib/ml-rule/ml-rule.js

@@ -6,12 +6,13 @@ const tslib_1 = require("tslib");
 const ml_rule_context_1 = require("./ml-rule-context");
 class MLRule {
     constructor(o) {
+        var _a, _b;
         _MLRule_v.set(this, void 0);
         _MLRule_f.set(this, void 0);
         this.name = o.name;
         this.defaultServerity = o.defaultServerity || 'error';
-        this.defaultValue = o.defaultValue;
-        this.defaultOptions = o.defaultOptions;
+        this.defaultValue = (_a = o.defaultValue) !== null && _a !== void 0 ? _a : true;
+        this.defaultOptions = (_b = o.defaultOptions) !== null && _b !== void 0 ? _b : null;
         (0, tslib_1.__classPrivateFieldSet)(this, _MLRule_v, o.verify, "f");
         (0, tslib_1.__classPrivateFieldSet)(this, _MLRule_f, o.fix, "f");
     }
@@ -79,8 +80,21 @@ class MLRule {
         document.setRule(null);
         return violation;
     }
+    getRuleInfo(ruleSet, ruleName) {
+        const info = this._optimize(ruleSet.rules, ruleName);
+        return {
+            ...info,
+            nodeRules: ruleSet.nodeRules.map(r => this._optimize(r.rules, ruleName)).filter(r => !r.disabled),
+            childNodeRules: ruleSet.childNodeRules.map(r => this._optimize(r.rules, ruleName)).filter(r => !r.disabled),
+        };
+    }
+    _optimize(rules, ruleName) {
+        const rule = (rules && rules[ruleName]) || false;
+        const info = this.optimizeOption(rule);
+        return info;
+    }
     optimizeOption(configSettings) {
-        if (typeof configSettings === 'boolean') {
+        if (configSettings === undefined || typeof configSettings === 'boolean') {
             return {
                 disabled: !configSettings,
                 severity: this.defaultServerity,

package/lib/ml-rule/types.d.ts

@@ -1,9 +1,9 @@
 import type { MLRuleContext } from './ml-rule-context';
 import type { RuleConfigValue, Severity } from '@markuplint/ml-config';
-export declare type RuleSeed<T extends RuleConfigValue, O = null> = {
+export declare type RuleSeed<T extends RuleConfigValue = boolean, O = null> = {
     defaultServerity?: Severity;
-    defaultValue: T;
-    defaultOptions: O;
+    defaultValue?: T;
+    defaultOptions?: O;
     verify(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
     fix?(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
 };

package/markuplint-recommended.json

@@ -1,54 +1,194 @@
 {
 	"rules": {
 		"attr-duplication": true,
+		"attr-equal-space-after": false,
+		"attr-equal-space-before": false,
+		"attr-spacing": false,
+		"attr-value-quotes": false,
+		"case-sensitive-attr-name": false,
+		"case-sensitive-tag-name": false,
 		"character-reference": true,
+		"class-naming": false,
 		"deprecated-attr": true,
 		"deprecated-element": true,
+		"disallowed-element": ["hgroup"],
 		"doctype": true,
+		"end-tag": false,
 		"id-duplication": true,
+		"indentation": false,
+		"ineffective-attr": true,
+		"invalid-attr": {
+			"option": {
+				"attrs": {
+					"autofocus": {
+						"disallowed": true
+					},
+					"accesskey": {
+						"disallowed": true
+					},
+					"tabindex": {
+						"enum": ["-1", "0"]
+					}
+				}
+			}
+		},
+		"landmark-roles": true,
+		"no-boolean-attr-value": true,
+		"no-default-value": false,
+		"no-hard-code-id": false,
+		"no-refer-to-non-existent-id": true,
+		"no-use-event-handler-attr": false,
 		"permitted-contents": true,
 		"required-attr": true,
-		"invalid-attr": true,
-		"landmark-roles": true,
+		"required-element": false,
 		"required-h1": true,
 		"wai-aria": true
 	},
 	"nodeRules": [
 		{
-			"selector": "html",
+			"selector": ":where(html)",
 			"rules": {
 				"required-attr": ["lang"]
 			}
 		},
 		{
-			"selector": "script[src]",
+			"selector": ":where(head)",
+			"rules": {
+				"required-element": ["meta[charset=\"UTF-8\" i]"]
+			}
+		},
+		{
+			"selector": ":where(meta[property])",
+			"rules": {
+				"invalid-attr": {
+					"option": {
+						"attrs": {
+							"property": {
+								"pattern": "/^og:[a-z_]+/"
+							},
+							"content": {
+								"type": "NoEmptyAny"
+							}
+						}
+					}
+				},
+				"required-attr": false
+			}
+		},
+		{
+			"selector": ":where(meta[itemprop])",
+			"rules": {
+				"invalid-attr": {
+					"option": {
+						"attrs": {
+							"content": {
+								"type": "NoEmptyAny"
+							}
+						}
+					}
+				}
+			}
+		},
+		{
+			"selector": ":where(script[src])",
 			"rules": {
 				"required-attr": ["defer"]
 			}
 		},
 		{
-			"selector": "img",
+			"selector": "h1, h2, h3, h4, h5, h6",
+			"rules": {
+				"disallowed-element": {
+					"value": ["small"],
+					"reason": "The small element must not be used for subheadings. https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-small-element"
+				}
+			}
+		},
+		{
+			"selector": ":where(img)",
 			"rules": {
-				"required-attr": ["decoding", "width", "height", "alt"]
+				"required-attr": [
+					"width",
+					"height",
+					"alt",
+					{
+						"name": "decoding",
+						"value": "async"
+					}
+				]
 			}
 		},
 		{
-			"selector": "iframe",
+			"selector": ":where(iframe)",
 			"rules": {
-				"required-attr": ["loading", "title"]
+				"required-attr": [
+					"title",
+					{
+						"name": "loading",
+						"value": "lazy"
+					}
+				]
 			}
 		},
 		{
-			"selector": "a[target=_blank], area[target=_blank]",
+			"selector": ":where(a[target=_blank], area[target=_blank])",
 			"rules": {
-				"required-attr": ["rel"]
+				"required-attr": {
+					"value": [
+						{
+							"name": "rel",
+							"value": "/(?<![^\\s]+)noreferrer(?![^\\s]+)/"
+						}
+					],
+					"reason": "The \"rel\" attribute should be required with \"noreferrer\" if the \"a\" element has the \"target=_black\""
+				}
 			}
 		},
 		{
-			"selector": "abbr",
+			"selector": ":where(abbr)",
 			"rules": {
 				"required-attr": ["title"]
 			}
+		},
+		{
+			"selector": ":where(video, audio)",
+			"rules": {
+				"required-element": ["track"]
+			}
+		},
+		{
+			"selector": ":where(video[autoplay])",
+			"rules": {
+				"required-attr": ["muted"]
+			}
+		},
+		{
+			"selector": ":where(th, td)",
+			"rules": {
+				"invalid-attr": {
+					"option": {
+						"attrs": {
+							"span": {
+								"disallowed": false
+							}
+						}
+					}
+				}
+			}
+		},
+		{
+			"selector": ":where(body :not(button))",
+			"rules": {
+				"invalid-attr": {
+					"option": {
+						"attrs": {
+							"onclick": {
+								"disallowed": false
+							}
+						}
+					}
+				}
+			}
 		}
 	]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "2.0.0-rc.0",
+	"version": "2.0.0-rc.6",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -17,17 +17,18 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@markuplint/i18n": "2.0.0-rc.0",
-		"@markuplint/ml-ast": "2.0.0-rc.0",
-		"@markuplint/ml-config": "2.0.0-rc.0",
-		"@markuplint/ml-spec": "2.0.0-rc.0",
+		"@markuplint/i18n": "2.0.0-rc.5",
+		"@markuplint/ml-ast": "2.0.0-rc.6",
+		"@markuplint/ml-config": "2.0.0-rc.5",
+		"@markuplint/ml-spec": "2.0.0-rc.6",
+		"@markuplint/parser-utils": "2.0.0-rc.6",
 		"debug": "^4.3.2",
 		"postcss-selector-parser": "^6.0.6",
 		"tslib": "^2.3.1"
 	},
 	"devDependencies": {
-		"@markuplint/html-parser": "2.0.0-rc.0",
+		"@markuplint/html-parser": "2.0.0-rc.6",
 		"@types/debug": "^4.1.7"
 	},
-	"gitHead": "67134f1addbdd271ad1d425de8f296d1875dbf25"
+	"gitHead": "7c93367a86f935f6b94780b1fa14f3293f900b87"
 }