@markuplint/ml-core 3.0.0-alpha.66 → 3.0.0-dev.176

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

@@ -1,4 +1,3 @@
-import type { MLToken } from '../token/token';
 import type { MLAttr } from './attr';
 import type { MLBlock } from './block';
 import type { MLComment } from './comment';
@@ -8,18 +7,97 @@ import type { MLDocumentType } from './document-type';
 import type { MLElement } from './element';
 import type { MLNode } from './node';
 import type { MLText } from './text';
-import type { MLASTAbstructNode, MLASTAttr, MLASTComment, MLASTDoctype, MLASTElement, MLASTParentNode, MLASTPreprocessorSpecificBlock, MLASTText, MLToken as MLASTToken } from '@markuplint/ml-ast/';
-import type { RuleConfigValue } from '@markuplint/ml-config';
-export declare type MappedNode<N, T extends RuleConfigValue, O = null> = N extends MLASTElement ? MLElement<T, O> : N extends MLASTParentNode ? MLElement<T, O> : N extends MLASTComment ? MLComment<T, O> : N extends MLASTText ? MLText<T, O> : N extends MLASTDoctype ? MLDocumentType<T, O> : N extends MLASTPreprocessorSpecificBlock ? MLBlock<T, O> : N extends MLASTAbstructNode ? MLNode<T, O, MLASTAbstructNode> : N extends MLASTAttr ? MLAttr<T, O> : N extends MLASTToken ? MLToken : never;
-export declare type NodeTypeOf<NT extends NodeType, T extends RuleConfigValue, O = null> = NT extends ElementNodeType ? MLElement<T, O> : NT extends CommentNodeType ? MLComment<T, O> : NT extends TextNodeType ? MLText<T, O> : NT extends DocumentNodeType ? MLDocument<T, O> : NT extends DocumentTypeNodeType ? MLDocumentType<T, O> : NT extends DocumentFragmentNodeType ? MLDocumentFragment<T, O> : NT extends MarkuplintPreprocessorBlockType ? MLBlock<T, O> : NT extends AttributeNodeType ? MLAttr<T, O> : never;
-export declare type ElementNodeType = 1;
-export declare type AttributeNodeType = 2;
-export declare type TextNodeType = 3;
-export declare type CDATASectionNodeType = 4;
-export declare type ProcessingInstructionNodeType = 7;
-export declare type CommentNodeType = 8;
-export declare type DocumentNodeType = 9;
-export declare type DocumentTypeNodeType = 10;
-export declare type DocumentFragmentNodeType = 11;
-export declare type MarkuplintPreprocessorBlockType = 101;
-export declare type NodeType = ElementNodeType | AttributeNodeType | TextNodeType | CDATASectionNodeType | ProcessingInstructionNodeType | CommentNodeType | DocumentNodeType | DocumentTypeNodeType | DocumentFragmentNodeType | MarkuplintPreprocessorBlockType;
+import type { MLToken } from '../token/token';
+import type {
+	MLASTAbstractNode,
+	MLASTAttr,
+	MLASTComment,
+	MLASTDoctype,
+	MLASTElement,
+	MLASTParentNode,
+	MLASTPreprocessorSpecificBlock,
+	MLASTText,
+	MLToken as MLASTToken,
+} from '@markuplint/ml-ast/';
+import type { PlainData, PretenderARIA, RuleConfigValue } from '@markuplint/ml-config';
+export type MappedNode<N, T extends RuleConfigValue, O extends PlainData = undefined> = N extends MLASTElement
+	? MLElement<T, O>
+	: N extends MLASTParentNode
+	? MLElement<T, O>
+	: N extends MLASTComment
+	? MLComment<T, O>
+	: N extends MLASTText
+	? MLText<T, O>
+	: N extends MLASTDoctype
+	? MLDocumentType<T, O>
+	: N extends MLASTPreprocessorSpecificBlock
+	? MLBlock<T, O>
+	: N extends MLASTAbstractNode
+	? MLNode<T, O, MLASTAbstractNode>
+	: N extends MLASTAttr
+	? MLAttr<T, O>
+	: N extends MLASTToken
+	? MLToken
+	: never;
+export type NodeTypeOf<
+	NT extends NodeType,
+	T extends RuleConfigValue,
+	O extends PlainData = undefined,
+> = NT extends ElementNodeType
+	? MLElement<T, O>
+	: NT extends CommentNodeType
+	? MLComment<T, O>
+	: NT extends TextNodeType
+	? MLText<T, O>
+	: NT extends DocumentNodeType
+	? MLDocument<T, O>
+	: NT extends DocumentTypeNodeType
+	? MLDocumentType<T, O>
+	: NT extends DocumentFragmentNodeType
+	? MLDocumentFragment<T, O>
+	: NT extends MarkuplintPreprocessorBlockType
+	? MLBlock<T, O>
+	: NT extends AttributeNodeType
+	? MLAttr<T, O>
+	: never;
+export type ElementNodeType = 1;
+export type AttributeNodeType = 2;
+export type TextNodeType = 3;
+export type CDATASectionNodeType = 4;
+export type ProcessingInstructionNodeType = 7;
+export type CommentNodeType = 8;
+export type DocumentNodeType = 9;
+export type DocumentTypeNodeType = 10;
+export type DocumentFragmentNodeType = 11;
+export type MarkuplintPreprocessorBlockType = 101;
+export type NodeType =
+	| ElementNodeType
+	| AttributeNodeType
+	| TextNodeType
+	| CDATASectionNodeType
+	| ProcessingInstructionNodeType
+	| CommentNodeType
+	| DocumentNodeType
+	| DocumentTypeNodeType
+	| DocumentFragmentNodeType
+	| MarkuplintPreprocessorBlockType;
+export type PretenderContext<N extends MLElement<T, O>, T extends RuleConfigValue, O extends PlainData = undefined> =
+	| PretenderContextPretender<N, T, O>
+	| PretenderContextPretended<N, T, O>;
+export type PretenderContextPretender<
+	N extends MLElement<T, O>,
+	T extends RuleConfigValue,
+	O extends PlainData = undefined,
+> = {
+	readonly type: 'pretender';
+	readonly as: N;
+	readonly aria?: PretenderARIA;
+};
+export type PretenderContextPretended<
+	N extends MLElement<T, O>,
+	T extends RuleConfigValue,
+	O extends PlainData = undefined,
+> = {
+	readonly type: 'origin';
+	readonly origin: N;
+};

package/lib/ml-dom/node/unexpected-call-error.d.ts

@@ -1,2 +1 @@
-export default class UnexpectedCallError extends Error {
-}
+export default class UnexpectedCallError extends Error {}

package/lib/ml-dom/token/token.d.ts

@@ -1,47 +1,47 @@
 import type { MLToken as MLASTToken } from '@markuplint/ml-ast';
 export declare class MLToken<A extends MLASTToken = MLASTToken> {
-    #private;
-    readonly uuid: string;
-    protected readonly _astToken: A;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get endCol(): number;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get endLine(): number;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get endOffset(): number;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get originRaw(): string;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get raw(): string;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get startCol(): number;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get startLine(): number;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    get startOffset(): number;
-    constructor(astToken: A);
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    fix(raw: string): void;
-    /**
-     * @implements `@markuplint/ml-core` API: `MLDOMToken`
-     */
-    toString(): string;
+	#private;
+	readonly uuid: string;
+	protected readonly _astToken: A;
+	constructor(astToken: A);
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	get endCol(): number;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	get endLine(): number;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	get endOffset(): number;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	get originRaw(): string;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	get raw(): string;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	get startCol(): number;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	get startLine(): number;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	get startOffset(): number;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	fix(raw: string): void;
+	/**
+	 * @implements `@markuplint/ml-core` API: `MLDOMToken`
+	 */
+	toString(): string;
 }

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

@@ -1,3 +1,5 @@
 import type { RuleSeed } from './types';
-import type { RuleConfigValue } from '@markuplint/ml-config';
-export declare function createRule<T extends RuleConfigValue, O = null>(seed: RuleSeed<T, O>): RuleSeed<T, O>;
+import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
+export declare function createRule<T extends RuleConfigValue, O extends PlainData = undefined>(
+	seed: Readonly<RuleSeed<T, O>>,
+): Readonly<RuleSeed<T, O>>;

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

@@ -1,6 +1,8 @@
 import type { RuleSeed } from './types';
-import type { RuleConfigValue } from '@markuplint/ml-config';
+import type { PlainData, RuleConfigValue } from '@markuplint/ml-config';
 import { MLRule } from './ml-rule';
-export declare function createRule<T extends RuleConfigValue, O = null>(seed: RuleSeed<T, O> & {
-    name: string;
-}): MLRule<T, O>;
+export declare function createRule<T extends RuleConfigValue, O extends PlainData = undefined>(
+	seed: Readonly<RuleSeed<T, O>> & {
+		readonly name: string;
+	},
+): MLRule<T, O>;

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

@@ -1,52 +1,61 @@
-import type { MLDocument } from '../ml-dom/node/document';
 import type { CheckerReport } from './types';
+import type { MLDocument } from '../ml-dom/node/document';
 import type { LocaleSet, Translator } from '@markuplint/i18n';
-import type { Report, RuleConfigValue } from '@markuplint/ml-config';
-export declare class MLRuleContext<T extends RuleConfigValue, O = null> {
-    #private;
-    readonly document: MLDocument<T, O>;
-    readonly locale: string;
-    readonly translate: Translator;
-    get reports(): ({
-        message: string;
-        line: number;
-        col: number;
-        raw: string;
-    } | {
-        message: string;
-        scope: import("@markuplint/ml-config").Scope<T, O>;
-    } | {
-        message: string;
-        scope: import("@markuplint/ml-config").Scope<T, O>;
-        line: number;
-        col: number;
-        raw: string;
-    })[];
-    constructor(document: MLDocument<T, O>, locale: LocaleSet);
-    provide(): {
-        document: MLDocument<T, O>;
-        translate: Translator;
-        t: Translator;
-        reports: ({
-            message: string;
-            line: number;
-            col: number;
-            raw: string;
-        } | {
-            message: string;
-            scope: import("@markuplint/ml-config").Scope<T, O>;
-        } | {
-            message: string;
-            scope: import("@markuplint/ml-config").Scope<T, O>;
-            line: number;
-            col: number;
-            raw: string;
-        })[];
-        report: {
-            (report: Report<T, O>): undefined;
-            (report: CheckerReport<T, O>): boolean;
-        };
-    };
-    report(report: Report<T, O>): undefined;
-    report(report: CheckerReport<T, O>): boolean;
+import type { PlainData, Report, RuleConfigValue } from '@markuplint/ml-config';
+export declare class MLRuleContext<T extends RuleConfigValue, O extends PlainData = undefined> {
+	#private;
+	readonly document: MLDocument<T, O>;
+	readonly locale: string;
+	readonly translate: Translator;
+	constructor(document: MLDocument<T, O>, locale: LocaleSet);
+	get reports(): (
+		| {
+				message: string;
+				line: number;
+				col: number;
+				raw: string;
+		  }
+		| {
+				message: string;
+				scope: import('@markuplint/ml-config').Scope<T, O>;
+		  }
+		| {
+				message: string;
+				scope: import('@markuplint/ml-config').Scope<T, O>;
+				line: number;
+				col: number;
+				raw: string;
+		  }
+	)[];
+	provide(): {
+		document: MLDocument<T, O>;
+		translate: Translator;
+		t: Translator;
+		reports: (
+			| {
+					message: string;
+					line: number;
+					col: number;
+					raw: string;
+			  }
+			| {
+					message: string;
+					scope: import('@markuplint/ml-config').Scope<T, O>;
+			  }
+			| {
+					message: string;
+					scope: import('@markuplint/ml-config').Scope<T, O>;
+					line: number;
+					col: number;
+					raw: string;
+			  }
+		)[];
+		report: {
+			(report: Report<T, O>): undefined;
+			(report: CheckerReport<T, O>): boolean;
+		};
+	};
+	report(report: Report<T, O>): undefined;
+	report(report: CheckerReport<T, O>): boolean;
+	private _push;
 }

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

@@ -5,7 +5,9 @@ exports.MLRuleContext = void 0;
 const tslib_1 = require("tslib");
 const i18n_1 = require("@markuplint/i18n");
 class MLRuleContext {
-    constructor(document, locale) {
+    constructor(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    document, locale) {
         _MLRuleContext_reports.set(this, []);
         this.document = document;
         this.translate = (0, i18n_1.translator)(locale);
@@ -14,7 +16,7 @@ class MLRuleContext {
     get reports() {
         return tslib_1.__classPrivateFieldGet(this, _MLRuleContext_reports, "f").map(report => ({
             ...report,
-            message: finish(report.message),
+            message: finish(report.message, this.locale),
         }));
     }
     provide() {
@@ -30,12 +32,17 @@ class MLRuleContext {
         if (typeof report === 'function') {
             const r = report(this.translate);
             if (r) {
-                tslib_1.__classPrivateFieldGet(this, _MLRuleContext_reports, "f").push(r);
+                this._push(r);
                 return true;
             }
             return false;
         }
-        tslib_1.__classPrivateFieldGet(this, _MLRuleContext_reports, "f").push(report);
+        this._push(report);
+    }
+    _push(report) {
+        if (!tslib_1.__classPrivateFieldGet(this, _MLRuleContext_reports, "f").find(r => is(r, report))) {
+            tslib_1.__classPrivateFieldGet(this, _MLRuleContext_reports, "f").push(report);
+        }
     }
 }
 exports.MLRuleContext = MLRuleContext;
@@ -48,3 +55,15 @@ function finish(message, locale = 'en') {
     }
     return message;
 }
+function is(r1, r2) {
+    if ('col' in r1 && 'col' in r2) {
+        return r1.col === r2.col && r1.line === r2.line && r1.message === r2.message && r1.raw === r2.raw;
+    }
+    if ('scope' in r1) {
+        if (!('scope' in r2)) {
+            return false;
+        }
+        return r1.scope === r2.scope && r1.message === r2.message;
+    }
+    return false;
+}

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

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

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

@@ -3,16 +3,19 @@ var _MLRule_f, _MLRule_v;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MLRule = void 0;
 const tslib_1 = require("tslib");
+const ml_config_1 = require("@markuplint/ml-config");
+const is_plain_object_1 = require("is-plain-object");
 const ml_rule_context_1 = require("./ml-rule-context");
 class MLRule {
     constructor(o) {
-        var _a, _b;
+        var _a;
         _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;
-        this.defaultOptions = (_b = o.defaultOptions) !== null && _b !== void 0 ? _b : null;
+        this.defaultSeverity = (_a = o.defaultSeverity) !== null && _a !== void 0 ? _a : 'error';
+        // TODO: https://github.com/markuplint/markuplint/issues/808
+        this.defaultValue = (o.defaultValue !== undefined ? o.defaultValue : true);
+        this.defaultOptions = o.defaultOptions;
         tslib_1.__classPrivateFieldSet(this, _MLRule_v, o.verify, "f");
         tslib_1.__classPrivateFieldSet(this, _MLRule_f, o.fix, "f");
     }
@@ -39,48 +42,36 @@ class MLRule {
         };
     }
     optimizeOption(configSettings) {
+        var _a;
         if (configSettings === undefined || typeof configSettings === 'boolean') {
             return {
                 disabled: !configSettings,
-                severity: this.defaultServerity,
+                severity: this.defaultSeverity,
                 value: this.defaultValue,
-                option: this.defaultOptions,
+                options: this.defaultOptions,
                 reason: undefined,
             };
         }
-        if (!Array.isArray(configSettings) && typeof configSettings === 'object' && configSettings !== null) {
+        if (isRuleConfig(configSettings)) {
             return {
                 disabled: false,
-                severity: configSettings.severity || this.defaultServerity,
+                severity: (_a = configSettings.severity) !== null && _a !== void 0 ? _a : this.defaultSeverity,
                 value: configSettings.value !== undefined ? configSettings.value : this.defaultValue,
-                option: Array.isArray(this.defaultOptions)
-                    ? configSettings.option
-                        ? // prettier-ignore
-                            // @ts-ignore for "as" casting
-                            this.defaultOptions.concat(configSettings.option)
-                        : this.defaultOptions
-                    : this.defaultOptions !== null &&
-                        typeof this.defaultOptions === 'object' &&
-                        // for example `configSettings.option === true`
-                        (configSettings.option == null || typeof configSettings.option === 'object')
-                        ? { ...this.defaultOptions, ...(configSettings.option || {}) }
-                        : configSettings.option || this.defaultOptions,
+                options: mergeOptions(this.defaultOptions, configSettings.options),
                 reason: configSettings.reason,
             };
         }
         return {
             disabled: false,
-            severity: this.defaultServerity,
-            // @ts-ignore TODO: Wait for fix to bug of type guards in TypeScript
+            severity: this.defaultSeverity,
             value: configSettings == null ? this.defaultValue : configSettings,
-            option: this.defaultOptions,
+            options: this.defaultOptions,
             reason: undefined,
         };
     }
-    async verify(document, locale, fix) {
-        if (!tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f")) {
-            return [];
-        }
+    async verify(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    document, locale, fix) {
         document.setRule(this);
         const context = new ml_rule_context_1.MLRuleContext(document, locale);
         const providableContext = context.provide();
@@ -89,6 +80,7 @@ class MLRule {
             await tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f").call(this, providableContext);
         }
         const violation = context.reports.map(report => {
+            var _a;
             if ('scope' in report) {
                 let line = report.scope.startLine;
                 let col = report.scope.startCol;
@@ -105,10 +97,9 @@ class MLRule {
                     col,
                     raw,
                     ruleId: this.name,
+                    reason: (_a = report.scope.rule.reason) !== null && _a !== void 0 ? _a : document.rule.reason,
                 };
-                if (report.scope.rule.reason || document.rule.reason) {
-                    violation.reason = report.scope.rule.reason || document.rule.reason;
-                }
+                (0, ml_config_1.deleteUndefProp)(violation);
                 return violation;
             }
             const violation = {
@@ -118,20 +109,34 @@ class MLRule {
                 col: report.col,
                 raw: report.raw,
                 ruleId: this.name,
+                reason: document.rule.reason,
             };
-            if (document.rule.reason) {
-                violation.reason = document.rule.reason;
-            }
+            (0, ml_config_1.deleteUndefProp)(violation);
             return violation;
         });
         document.setRule(null);
         return violation;
     }
     _optimize(rules, ruleName) {
-        const rule = (rules && rules[ruleName]) || false;
+        var _a;
+        const rule = ((_a = rules === null || rules === void 0 ? void 0 : rules[ruleName]) !== null && _a !== void 0 ? _a : false);
         const info = this.optimizeOption(rule);
         return info;
     }
 }
 exports.MLRule = MLRule;
 _MLRule_f = new WeakMap(), _MLRule_v = new WeakMap();
+function isRuleConfig(data) {
+    return (0, is_plain_object_1.isPlainObject)(data);
+}
+function mergeOptions(a, b) {
+    if (Array.isArray(a) && Array.isArray(b)) {
+        // @ts-ignore
+        return [...a, ...b];
+    }
+    if ((0, is_plain_object_1.isPlainObject)(a) && (0, is_plain_object_1.isPlainObject)(b)) {
+        // @ts-ignore
+        return { ...a, ...b };
+    }
+    return b !== null && b !== void 0 ? b : a;
+}