@markuplint/ml-core 2.3.2 → 3.0.0-alpha.66

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

@@ -1,13 +1,12 @@
-import type Document from '../ml-dom/document';
+import type { MLDocument } from '../ml-dom/node/document';
+import type { CheckerReport } from './types';
 import type { LocaleSet, Translator } from '@markuplint/i18n';
-import type { Report, RuleConfigValue, RuleInfo } from '@markuplint/ml-config';
+import type { Report, RuleConfigValue } from '@markuplint/ml-config';
 export declare class MLRuleContext<T extends RuleConfigValue, O = null> {
     #private;
-    readonly document: Document<T, O>;
-    readonly globalRule: RuleInfo<T, O>;
-    readonly translate: Translator;
+    readonly document: MLDocument<T, O>;
     readonly locale: string;
-    constructor(document: Document<T, O>, locale: LocaleSet, rule: RuleInfo<T, O>);
+    readonly translate: Translator;
     get reports(): ({
         message: string;
         line: number;
@@ -23,12 +22,11 @@ export declare class MLRuleContext<T extends RuleConfigValue, O = null> {
         col: number;
         raw: string;
     })[];
-    report(report: Report<T, O>): void;
+    constructor(document: MLDocument<T, O>, locale: LocaleSet);
     provide(): {
-        document: Document<T, O>;
+        document: MLDocument<T, O>;
         translate: Translator;
         t: Translator;
-        globalRule: RuleInfo<T, O>;
         reports: ({
             message: string;
             line: number;
@@ -44,6 +42,11 @@ export declare class MLRuleContext<T extends RuleConfigValue, O = null> {
             col: number;
             raw: string;
         })[];
-        report: (report: Report<T, O>) => void;
+        report: {
+            (report: Report<T, O>): undefined;
+            (report: CheckerReport<T, O>): boolean;
+        };
     };
+    report(report: Report<T, O>): undefined;
+    report(report: CheckerReport<T, O>): boolean;
 }

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

@@ -5,10 +5,9 @@ exports.MLRuleContext = void 0;
 const tslib_1 = require("tslib");
 const i18n_1 = require("@markuplint/i18n");
 class MLRuleContext {
-    constructor(document, locale, rule) {
+    constructor(document, locale) {
         _MLRuleContext_reports.set(this, []);
         this.document = document;
-        this.globalRule = rule;
         this.translate = (0, i18n_1.translator)(locale);
         this.locale = locale.locale;
     }
@@ -18,19 +17,26 @@ class MLRuleContext {
             message: finish(report.message),
         }));
     }
-    report(report) {
-        tslib_1.__classPrivateFieldGet(this, _MLRuleContext_reports, "f").push(report);
-    }
     provide() {
         return {
             document: this.document,
             translate: this.translate,
             t: this.translate,
-            globalRule: this.globalRule,
             reports: this.reports,
             report: this.report.bind(this),
         };
     }
+    report(report) {
+        if (typeof report === 'function') {
+            const r = report(this.translate);
+            if (r) {
+                tslib_1.__classPrivateFieldGet(this, _MLRuleContext_reports, "f").push(r);
+                return true;
+            }
+            return false;
+        }
+        tslib_1.__classPrivateFieldGet(this, _MLRuleContext_reports, "f").push(report);
+    }
 }
 exports.MLRuleContext = MLRuleContext;
 _MLRuleContext_reports = new WeakMap();

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

@@ -1,30 +1,30 @@
 import type { Ruleset } from '..';
-import type Document from '../ml-dom/document';
+import type { MLDocument } from '../ml-dom/node/document';
 import type { RuleSeed } from './types';
 import type { LocaleSet } from '@markuplint/i18n';
-import type { GlobalRuleInfo, RuleConfig, RuleConfigValue, RuleInfo, Rules, Severity, Violation } from '@markuplint/ml-config';
+import type { GlobalRuleInfo, RuleConfig, RuleConfigValue, RuleInfo, Severity, Violation } from '@markuplint/ml-config';
 export declare class MLRule<T extends RuleConfigValue, O = null> {
     #private;
-    readonly name: string;
+    readonly defaultOptions: O;
     readonly defaultServerity: Severity;
     readonly defaultValue: T;
-    readonly defaultOptions: O;
+    readonly name: string;
     /**
      * The following getter is unused internally,
      * only for extending from 3rd party library
      */
-    protected get v(): RuleSeed<T, O>['verify'];
+    protected get f(): RuleSeed<T, O>['fix'];
     /**
      * The following getter is unused internally,
      * only for extending from 3rd party library
      */
-    protected get f(): RuleSeed<T, O>['fix'];
+    protected get v(): RuleSeed<T, O>['verify'];
     constructor(o: RuleSeed<T, O> & {
         name: string;
     });
-    verify(document: Document<T, O>, locale: LocaleSet, globalRule: RuleInfo<T, O>, fix: boolean): Promise<Violation[]>;
     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>;
+    verify(document: MLDocument<T, O>, locale: LocaleSet, fix: boolean): Promise<Violation[]>;
+    private _optimize;
 }
 export declare type AnyMLRule = MLRule<RuleConfigValue, unknown>;

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

@@ -1,5 +1,5 @@
 "use strict";
-var _MLRule_v, _MLRule_f;
+var _MLRule_f, _MLRule_v;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MLRule = void 0;
 const tslib_1 = require("tslib");
@@ -7,8 +7,8 @@ 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);
+        _MLRule_v.set(this, void 0);
         this.name = o.name;
         this.defaultServerity = o.defaultServerity || 'error';
         this.defaultValue = (_a = o.defaultValue) !== null && _a !== void 0 ? _a : true;
@@ -20,65 +20,15 @@ class MLRule {
      * The following getter is unused internally,
      * only for extending from 3rd party library
      */
-    get v() {
-        return tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f");
+    get f() {
+        return tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f");
     }
     /**
      * The following getter is unused internally,
      * only for extending from 3rd party library
      */
-    get f() {
-        return tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f");
-    }
-    async verify(document, locale, globalRule, fix) {
-        if (!tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f")) {
-            return [];
-        }
-        document.setRule(this);
-        const context = new ml_rule_context_1.MLRuleContext(document, locale, globalRule);
-        const providableContext = context.provide();
-        await tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f").call(this, providableContext);
-        if (tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f") && fix) {
-            await tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f").call(this, providableContext);
-        }
-        const violation = context.reports.map(report => {
-            if ('scope' in report) {
-                let line = report.scope.startLine;
-                let col = report.scope.startCol;
-                let raw = report.scope.raw;
-                if ('line' in report) {
-                    line = report.line;
-                    col = report.col;
-                    raw = report.raw;
-                }
-                const violation = {
-                    severity: report.scope.rule.severity,
-                    message: report.message,
-                    line,
-                    col,
-                    raw,
-                    ruleId: this.name,
-                };
-                if (report.scope.rule.reason || globalRule.reason) {
-                    violation.reason = report.scope.rule.reason || globalRule.reason;
-                }
-                return violation;
-            }
-            const violation = {
-                severity: globalRule.severity,
-                message: report.message,
-                line: report.line,
-                col: report.col,
-                raw: report.raw,
-                ruleId: this.name,
-            };
-            if (globalRule.reason) {
-                violation.reason = globalRule.reason;
-            }
-            return violation;
-        });
-        document.setRule(null);
-        return violation;
+    get v() {
+        return tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f");
     }
     getRuleInfo(ruleSet, ruleName) {
         const info = this._optimize(ruleSet.rules, ruleName);
@@ -88,11 +38,6 @@ class MLRule {
             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 (configSettings === undefined || typeof configSettings === 'boolean') {
             return {
@@ -132,6 +77,61 @@ class MLRule {
             reason: undefined,
         };
     }
+    async verify(document, locale, fix) {
+        if (!tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f")) {
+            return [];
+        }
+        document.setRule(this);
+        const context = new ml_rule_context_1.MLRuleContext(document, locale);
+        const providableContext = context.provide();
+        await tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f").call(this, providableContext);
+        if (tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f") && fix) {
+            await tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f").call(this, providableContext);
+        }
+        const violation = context.reports.map(report => {
+            if ('scope' in report) {
+                let line = report.scope.startLine;
+                let col = report.scope.startCol;
+                let raw = report.scope.raw;
+                if ('line' in report && report.line != null) {
+                    line = report.line;
+                    col = report.col;
+                    raw = report.raw;
+                }
+                const violation = {
+                    severity: report.scope.rule.severity,
+                    message: report.message,
+                    line,
+                    col,
+                    raw,
+                    ruleId: this.name,
+                };
+                if (report.scope.rule.reason || document.rule.reason) {
+                    violation.reason = report.scope.rule.reason || document.rule.reason;
+                }
+                return violation;
+            }
+            const violation = {
+                severity: document.rule.severity,
+                message: report.message,
+                line: report.line,
+                col: report.col,
+                raw: report.raw,
+                ruleId: this.name,
+            };
+            if (document.rule.reason) {
+                violation.reason = document.rule.reason;
+            }
+            return violation;
+        });
+        document.setRule(null);
+        return violation;
+    }
+    _optimize(rules, ruleName) {
+        const rule = (rules && rules[ruleName]) || false;
+        const info = this.optimizeOption(rule);
+        return info;
+    }
 }
 exports.MLRule = MLRule;
-_MLRule_v = new WeakMap(), _MLRule_f = new WeakMap();
+_MLRule_f = new WeakMap(), _MLRule_v = new WeakMap();

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

@@ -1,5 +1,7 @@
+import type { Attr, Element } from '../ml-dom';
 import type { MLRuleContext } from './ml-rule-context';
-import type { RuleConfigValue, Severity } from '@markuplint/ml-config';
+import type { Translator } from '@markuplint/i18n';
+import type { Report, RuleConfigValue, Severity } from '@markuplint/ml-config';
 export declare type RuleSeed<T extends RuleConfigValue = boolean, O = null> = {
     defaultServerity?: Severity;
     defaultValue?: T;
@@ -7,4 +9,12 @@ export declare type RuleSeed<T extends RuleConfigValue = boolean, O = null> = {
     verify(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
     fix?(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
 };
+export declare type Checker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P) => CheckerReport<T, O>;
+export declare type ElementChecker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P & {
+    el: Element<T, O>;
+}) => CheckerReport<T, O>;
+export declare type AttrChecker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P & {
+    attr: Attr<T, O>;
+}) => CheckerReport<T, O>;
+export declare type CheckerReport<T extends RuleConfigValue, O = null> = (t: Translator) => Report<T, O> | undefined | null;
 export declare type AnyRuleSeed = RuleSeed<any, any>;

package/lib/ruleset/index.d.ts

@@ -1,7 +1,7 @@
 import type { ChildNodeRule, Config, NodeRule, Rules } from '@markuplint/ml-config';
 export default class Ruleset {
-    readonly rules: Readonly<Rules>;
-    readonly nodeRules: ReadonlyArray<NodeRule>;
     readonly childNodeRules: ReadonlyArray<ChildNodeRule>;
+    readonly nodeRules: ReadonlyArray<NodeRule>;
+    readonly rules: Readonly<Rules>;
     constructor(config: Config);
 }

package/lib/selector/match-selector.d.ts

@@ -2,13 +2,13 @@ import type { Specificity } from './selector';
 import type { RegexSelector } from '@markuplint/ml-config';
 export declare type SelectorMatches = SelectorMatched | SelectorUnmatched;
 declare type SelectorMatched = {
-    matched: true;
-    selector: string;
-    specificity: Specificity;
-    data?: Record<string, string>;
+	matched: true;
+	selector: string;
+	specificity: Specificity;
+	data?: Record<string, string>;
 };
 declare type SelectorUnmatched = {
-    matched: false;
+	matched: false;
 };
 export declare function matchSelector(el: Element, selector: string | RegexSelector | undefined): SelectorMatches;
 export {};

package/lib/test/index.d.ts

@@ -7,7 +7,8 @@ export declare type CreateTestOptions = {
     parser?: MLMarkupLanguageParser;
 };
 export declare function createTestDocument<T extends RuleConfigValue = any, O = any>(sourceCode: string, options?: CreateTestOptions): Document<T, O>;
-export declare function createTestNodeList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom").AnonymousNode<any, any>[];
+export declare function createTestNodeList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/node/node").MLNode<any, any, import("@markuplint/ml-ast").MLASTAbstructNode>[];
+export declare function createTestTokenList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/token/token").MLToken<import("@markuplint/ml-ast").MLToken>[];
 export declare function createTestElement(sourceCode: string, options?: CreateTestOptions): import("../ml-dom").Element<any, any>;
 /**
  * for test suite

package/lib/test/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dummySchemas = exports.createTestElement = exports.createTestNodeList = exports.createTestDocument = void 0;
+exports.dummySchemas = exports.createTestElement = exports.createTestTokenList = exports.createTestNodeList = exports.createTestDocument = void 0;
 const html_parser_1 = require("@markuplint/html-parser");
 const convert_ruleset_1 = require("../convert-ruleset");
 const ml_dom_1 = require("../ml-dom");
@@ -16,10 +16,15 @@ function createTestNodeList(sourceCode, options) {
     return document.nodeList;
 }
 exports.createTestNodeList = createTestNodeList;
+function createTestTokenList(sourceCode, options) {
+    const document = createTestDocument(sourceCode, options);
+    return document.getTokenList();
+}
+exports.createTestTokenList = createTestTokenList;
 function createTestElement(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     const el = document.nodeList[0];
-    if (el.type === 'Element') {
+    if (el.is(el.ELEMENT_NODE)) {
         return el;
     }
     throw TypeError(`Could not parse it to be an element from: ${sourceCode}`);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "2.3.2",
+	"version": "3.0.0-alpha.66+6cde1134",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -17,13 +17,14 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
+		"@markuplint/config-presets": "3.0.0-alpha",
 		"@markuplint/i18n": "2.1.1",
 		"@markuplint/ml-ast": "2.0.1-dev.20220307.0",
-		"@markuplint/ml-config": "2.1.0",
-		"@markuplint/ml-spec": "2.1.0",
+		"@markuplint/ml-config": "3.0.0-alpha.66+6cde1134",
+		"@markuplint/ml-spec": "3.0.0-alpha.82+6cde1134",
 		"@markuplint/parser-utils": "2.2.0",
+		"@markuplint/selector": "3.0.0-alpha.2105+6cde1134",
 		"debug": "^4.3.4",
-		"dom-accessibility-api": "^0.5.13",
 		"postcss-selector-parser": "^6.0.10",
 		"tslib": "^2.3.1"
 	},
@@ -31,5 +32,5 @@
 		"@markuplint/html-parser": "2.2.1",
 		"@types/debug": "^4.1.7"
 	},
-	"gitHead": "0c774ce046ebc8a9c494e9884a4bfcd72a66250d"
+	"gitHead": "6cde113402758a8fdbd6a0fcf98e78efd2cdb778"
 }