@markuplint/ml-core 3.4.0 → 3.5.0

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

@@ -1,3 +1,3 @@
 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,8 +1,6 @@
 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,61 +1,53 @@
 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;
-	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;
+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);

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

@@ -2,31 +2,29 @@ import type { RuleSeed } from './types';
 import type { Ruleset } from '..';
 import type { MLDocument } from '../ml-dom/node/document';
 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 defaultSeverity: Severity;
-	readonly defaultValue: T;
-	readonly name: string;
-	constructor(
-		o: RuleSeed<T, O> & {
-			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: 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 type AnyMLRule = MLRule<RuleConfigValue, unknown>;
+export type AnyMLRule = MLRule<RuleConfigValue, PlainData>;

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

@@ -3,6 +3,8 @@ 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) {
@@ -10,9 +12,9 @@ class MLRule {
         _MLRule_f.set(this, void 0);
         _MLRule_v.set(this, void 0);
         this.name = o.name;
-        this.defaultSeverity = o.defaultSeverity || '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';
+        this.defaultValue = ((_b = o.defaultValue) !== null && _b !== void 0 ? _b : true);
+        this.defaultOptions = o.defaultOptions;
         tslib_1.__classPrivateFieldSet(this, _MLRule_v, o.verify, "f");
         tslib_1.__classPrivateFieldSet(this, _MLRule_f, o.fix, "f");
     }
@@ -48,23 +50,12 @@ class MLRule {
                 reason: undefined,
             };
         }
-        if (!Array.isArray(configSettings) && typeof configSettings === 'object' && configSettings !== null) {
+        if (isRuleConfig(configSettings)) {
             return {
                 disabled: false,
                 severity: configSettings.severity || this.defaultSeverity,
                 value: configSettings.value !== undefined ? configSettings.value : this.defaultValue,
-                options: Array.isArray(this.defaultOptions)
-                    ? configSettings.options
-                        ? // 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.options == null || typeof configSettings.options === 'object')
-                        ? { ...this.defaultOptions, ...(configSettings.options || {}) }
-                        : configSettings.options || this.defaultOptions,
+                options: mergeOptions(this.defaultOptions, configSettings.options),
                 reason: configSettings.reason,
             };
         }
@@ -76,7 +67,9 @@ class MLRule {
             reason: undefined,
         };
     }
-    async verify(document, locale, fix) {
+    async verify(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    document, locale, fix) {
         if (!tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f")) {
             return [];
         }
@@ -104,10 +97,9 @@ class MLRule {
                     col,
                     raw,
                     ruleId: this.name,
+                    reason: report.scope.rule.reason || 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 = {
@@ -117,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;
+}

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

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

package/lib/plugin/plugin.d.ts

@@ -1,2 +1,2 @@
 import type { PluginCreator, CreatePluginSettings } from './types';
-export declare function createPlugin<S extends CreatePluginSettings>(fn: PluginCreator<S>): PluginCreator<S>;
+export declare function createPlugin<S extends CreatePluginSettings>(fn: Readonly<PluginCreator<S>>): Readonly<PluginCreator<S>>;

package/lib/plugin/types.d.ts

@@ -1,12 +1,12 @@
-import type { AnyRuleSeed } from '../ml-rule';
+import type { RuleSeed } from '../ml-rule';
 import type { Config } from '@markuplint/ml-config';
 export type Plugin = {
-	name: string;
-	rules?: Record<string, AnyRuleSeed>;
-	configs?: Record<string, Config>;
+    readonly name: string;
+    readonly rules?: Readonly<Record<string, Readonly<RuleSeed<any, any>>>>;
+    readonly configs?: Readonly<Record<string, Config>>;
 };
 export type PluginCreator<S extends CreatePluginSettings> = {
-	name: string;
-	create(setting: S): Omit<Plugin, 'name'>;
+    readonly name: string;
+    create(setting: S): Omit<Plugin, 'name'>;
 };
-export type CreatePluginSettings = Record<string, unknown>;
+export type CreatePluginSettings = Readonly<Record<string, unknown>>;

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 childNodeRules: ReadonlyArray<ChildNodeRule>;
-	readonly nodeRules: ReadonlyArray<NodeRule>;
-	readonly rules: Readonly<Rules>;
-	constructor(config: Config);
+    readonly childNodeRules: readonly ChildNodeRule[];
+    readonly nodeRules: readonly NodeRule[];
+    readonly rules: Rules;
+    constructor(config: Config);
 }

package/lib/ruleset/index.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 class Ruleset {
     constructor(config) {
-        // TODO: deep freeze
-        this.rules = Object.freeze(config.rules || {});
-        this.nodeRules = Object.freeze(config.nodeRules || []);
-        this.childNodeRules = Object.freeze(config.childNodeRules || []);
+        var _a, _b, _c;
+        this.rules = (_a = config.rules) !== null && _a !== void 0 ? _a : {};
+        this.nodeRules = (_b = config.nodeRules) !== null && _b !== void 0 ? _b : [];
+        this.childNodeRules = (_c = config.childNodeRules) !== null && _c !== void 0 ? _c : [];
     }
 }
 exports.default = Ruleset;

package/lib/test/index.d.ts

@@ -1,28 +1,16 @@
 import type { MLMarkupLanguageParser } from '@markuplint/ml-ast';
-import type { Config, RuleConfigValue } from '@markuplint/ml-config';
+import type { Config, PlainData, RuleConfigValue } from '@markuplint/ml-config';
 import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
 import { Document } from '../ml-dom';
 export type CreateTestOptions = {
-	config?: Config;
-	parser?: MLMarkupLanguageParser;
-	specs?: MLMLSpec;
+    readonly config?: Config;
+    readonly parser?: Readonly<MLMarkupLanguageParser>;
+    readonly specs?: MLMLSpec;
 };
-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/node/node').MLNode<any, any, import('@markuplint/ml-ast').MLASTAbstractNode>[];
-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>;
+export declare function createTestDocument<T extends RuleConfigValue = any, O extends PlainData = any>(sourceCode: string, options?: CreateTestOptions): Document<T, O>;
+export declare function createTestNodeList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/node/node").MLNode<any, any, import("@markuplint/ml-ast").MLASTAbstractNode>[];
+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/types.d.ts

@@ -4,13 +4,14 @@ import type { LocaleSet } from '@markuplint/i18n';
 import type { MLMarkupLanguageParser, ParserOptions } from '@markuplint/ml-ast';
 import type { Pretender } from '@markuplint/ml-config';
 import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
-export type MLSchema = Readonly<[MLMLSpec, ...ExtendedSpec[]]>;
+export type MLSchema = readonly [MLMLSpec, ...ExtendedSpec[]];
 export type MLFabric = {
-	parser: MLMarkupLanguageParser;
-	ruleset: Partial<Ruleset>;
-	rules: AnyMLRule[];
-	locale: LocaleSet;
-	schemas: MLSchema;
-	parserOptions: ParserOptions;
-	pretenders: Pretender[];
+    readonly parser: Readonly<MLMarkupLanguageParser>;
+    readonly ruleset: Partial<Readonly<Ruleset>>;
+    readonly rules: readonly Readonly<AnyMLRule>[];
+    readonly locale: LocaleSet;
+    readonly schemas: MLSchema;
+    readonly parserOptions: ParserOptions;
+    readonly pretenders: readonly Pretender[];
+    readonly configErrors?: readonly Readonly<Error>[];
 };

package/lib/utils/get-location-from-chars.d.ts

@@ -1,12 +1,7 @@
 interface Location {
-	line: number;
-	col: number;
-	raw: string;
+    line: number;
+    col: number;
+    raw: string;
 }
-export declare function getLocationFromChars(
-	searches: string[],
-	text: string,
-	currentLine: number,
-	currentCol: number,
-): Location[];
+export declare function getLocationFromChars(searches: readonly string[], text: string, currentLine: number, currentCol: number): Location[];
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "3.4.0",
+	"version": "3.5.0",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -23,21 +23,23 @@
 		"./lib/configs.js": "./lib/configs.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/config-presets": "3.3.0",
-		"@markuplint/html-parser": "3.4.0",
-		"@markuplint/html-spec": "3.4.0",
-		"@markuplint/i18n": "3.4.0",
-		"@markuplint/ml-ast": "3.0.0",
-		"@markuplint/ml-config": "3.4.0",
-		"@markuplint/ml-spec": "3.4.0",
-		"@markuplint/parser-utils": "3.4.0",
-		"@markuplint/selector": "3.4.0",
+		"@markuplint/config-presets": "3.4.0",
+		"@markuplint/html-parser": "3.5.0",
+		"@markuplint/html-spec": "3.5.0",
+		"@markuplint/i18n": "3.5.0",
+		"@markuplint/ml-ast": "3.1.0",
+		"@markuplint/ml-config": "3.5.0",
+		"@markuplint/ml-spec": "3.5.0",
+		"@markuplint/parser-utils": "3.5.0",
+		"@markuplint/selector": "3.5.0",
 		"debug": "^4.3.4",
+		"is-plain-object": "^5.0.0",
 		"tslib": "^2.4.1"
 	},
 	"devDependencies": {
 		"@markuplint/html-parser": "3.3.0",
-		"@types/debug": "^4.1.7"
+		"@types/debug": "^4.1.7",
+		"type-fest": "^3.6.1"
 	},
-	"gitHead": "a83e0f5f214a9bbcc0286b9e269074ddca6189e7"
+	"gitHead": "0c47b2c2722f6823a17f36edbab98486275f8ab4"
 }