markuplint 3.3.1 → 3.5.0

package/README.md

@@ -7,7 +7,7 @@
 [![GitHub Stars](https://img.shields.io/github/stars/markuplint.svg)](https://github.com/markuplint/markuplint)
 [![Follow us on Twitter](https://img.shields.io/twitter/follow/markuplint?label=Follow)](https://twitter.com/intent/user?screen_name=markuplint)
 
-**Peace of mind in your markup** - A linter for all markup developers.
+**Peace of mind in your markup** - An HTML linter for all markup developers.
 
 ## Features
 

package/lib/api/lint.d.ts

@@ -1,4 +1,4 @@
-import type { MLResultInfo } from '../types';
 import type { APIOptions } from './types';
+import type { MLResultInfo } from '../types';
 import type { Target } from '@markuplint/file-resolver';
-export declare function lint(targetList: Target[], options?: APIOptions): Promise<MLResultInfo[]>;
+export declare function lint(targetList: readonly Readonly<Target>[], options?: APIOptions): Promise<MLResultInfo[]>;

package/lib/api/ml-engine.d.ts

@@ -1,30 +1,31 @@
-import type { MLResultInfo } from '../types';
 import type { APIOptions, MLEngineEventMap } from './types';
+import type { MLResultInfo } from '../types';
 import type { MLFile, Target } from '@markuplint/file-resolver';
+import type { PlainData } from '@markuplint/ml-config';
 import type { Document, RuleConfigValue } from '@markuplint/ml-core';
 import { StrictEventEmitter } from 'strict-event-emitter';
 type MLEngineOptions = {
-	debug?: boolean;
-	watch?: boolean;
+    readonly debug?: boolean;
+    readonly watch?: boolean;
 };
 export default class MLEngine extends StrictEventEmitter<MLEngineEventMap> {
-	#private;
-	static toMLFile(target: Target): Promise<MLFile>;
-	constructor(file: MLFile, options?: APIOptions & MLEngineOptions);
-	get document(): Document<RuleConfigValue, unknown> | null;
-	close(): Promise<void>;
-	exec(): Promise<MLResultInfo | null>;
-	setCode(code: string): Promise<void>;
-	watchMode(enable: boolean): void;
-	private createCore;
-	private i18n;
-	private onChange;
-	private provide;
-	private resolveConfig;
-	private resolveParser;
-	private resolveRules;
-	private resolveRuleset;
-	private resolveSchemas;
-	private setup;
+    #private;
+    static toMLFile(target: Target): Promise<MLFile | undefined>;
+    constructor(file: Readonly<MLFile>, options?: APIOptions & MLEngineOptions);
+    get document(): Document<RuleConfigValue, PlainData> | null;
+    close(): Promise<void>;
+    exec(): Promise<MLResultInfo | null>;
+    setCode(code: string): Promise<void>;
+    watchMode(enable: boolean): void;
+    private createCore;
+    private i18n;
+    private onChange;
+    private provide;
+    private resolveConfig;
+    private resolveParser;
+    private resolveRules;
+    private resolveRuleset;
+    private resolveSchemas;
+    private setup;
 }
 export {};

package/lib/api/ml-engine.js

@@ -238,7 +238,9 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
         }
         return configSet;
     }
-    async resolveParser(configSet) {
+    async resolveParser(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    configSet) {
         const parser = await (0, file_resolver_1.resolveParser)(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f"), configSet.config.parser, configSet.config.parserOptions);
         this.emit('parser', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, parser.parserModName);
         fileLog('Fetched Parser module: %s', parser.parserModName);
@@ -253,12 +255,16 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
         this.emit('rules', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, rules);
         return rules;
     }
-    resolveRuleset(configSet) {
+    resolveRuleset(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    configSet) {
         const ruleset = (0, ml_core_1.convertRuleset)(configSet.config);
         this.emit('ruleset', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, ruleset);
         return ruleset;
     }
-    async resolveSchemas(configSet) {
+    async resolveSchemas(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    configSet) {
         const { schemas } = await (0, file_resolver_1.resolveSpecs)(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, configSet.config.specs);
         this.emit('schemas', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, schemas);
         return schemas;

package/lib/api/types.d.ts

@@ -1,51 +1,33 @@
 import type { ConfigSet } from '@markuplint/file-resolver';
 import type { LocaleSet } from '@markuplint/i18n';
-import type { MLMarkupLanguageParser, ParserOptions } from '@markuplint/ml-ast';
-import type { Config, Pretender, Violation } from '@markuplint/ml-config';
+import type { Config, Violation } from '@markuplint/ml-config';
 import type { AnyMLRule, MLSchema, Ruleset } from '@markuplint/ml-core';
 export type APIOptions = {
-	configFile?: string;
-	config?: Config;
-	defaultConfig?: Config;
-	noSearchConfig?: boolean;
-	locale?: string;
-	fix?: boolean;
-	ignoreExt?: boolean;
-	rules?: AnyMLRule[];
-	importPresetRules?: boolean;
-	/**
-	 * @deprecated
-	 */
-	autoLoad?: boolean;
-};
-export type MLFabric = {
-	ruleset: Ruleset;
-	rules: AnyMLRule[];
-	schemas: MLSchema;
-	parser: MLMarkupLanguageParser;
-	parserOptions: ParserOptions;
-	pretenders: Pretender[];
-	locale: LocaleSet;
-	configErrors?: Error[];
+    readonly configFile?: string;
+    readonly config?: Config;
+    readonly defaultConfig?: Config;
+    readonly noSearchConfig?: boolean;
+    readonly locale?: string;
+    readonly fix?: boolean;
+    readonly ignoreExt?: boolean;
+    readonly rules?: readonly Readonly<AnyMLRule>[];
+    readonly importPresetRules?: boolean;
+    /**
+     * @deprecated
+     */
+    readonly autoLoad?: boolean;
 };
 export type MLEngineEventMap = {
-	log: (phase: string, message: string) => void;
-	config: (filePath: string, config: ConfigSet, message?: string) => void;
-	exclude: (filePath: string, setting: string, message?: string) => void;
-	parser: (filePath: string, parser: string, message?: string) => void;
-	ruleset: (filePath: string, ruleset: Ruleset, message?: string) => void;
-	schemas: (filePath: string, schemas: MLSchema, message?: string) => void;
-	rules: (filePath: string, rules: AnyMLRule[], message?: string) => void;
-	i18n: (filePath: string, locale: LocaleSet, message?: string) => void;
-	code: (filePath: string, sourceCode: string, message?: string) => void;
-	lint: (
-		filePath: string,
-		sourceCode: string,
-		violations: Violation[],
-		fixedCode: string,
-		debug: string[] | null,
-		message?: string,
-	) => void;
-	'lint-error': (filePath: string, sourceCode: string, error: Error) => void;
-	'config-errors': (filePath: string, errors: Error[]) => void;
+    log: (phase: string, message: string) => void;
+    config: (filePath: string, config: ConfigSet, message?: string) => void;
+    exclude: (filePath: string, setting: string, message?: string) => void;
+    parser: (filePath: string, parser: string, message?: string) => void;
+    ruleset: (filePath: string, ruleset: Ruleset, message?: string) => void;
+    schemas: (filePath: string, schemas: MLSchema, message?: string) => void;
+    rules: (filePath: string, rules: readonly Readonly<AnyMLRule>[], message?: string) => void;
+    i18n: (filePath: string, locale: LocaleSet, message?: string) => void;
+    code: (filePath: string, sourceCode: string, message?: string) => void;
+    lint: (filePath: string, sourceCode: string, violations: readonly Violation[], fixedCode: string, debug: readonly string[] | null, message?: string) => void;
+    'lint-error': (filePath: string, sourceCode: string, error: Readonly<Error>) => void;
+    'config-errors': (filePath: string, errors: readonly Readonly<Error>[]) => void;
 };

package/lib/api/v1.d.ts

@@ -1,4 +1,4 @@
-import type { Config, RuleConfigValue } from '@markuplint/ml-config';
+import type { Config, PlainData, RuleConfigValue } from '@markuplint/ml-config';
 import type { MLRule } from '@markuplint/ml-core';
 /**
  * @deprecated
@@ -6,46 +6,46 @@ import type { MLRule } from '@markuplint/ml-core';
  * @returns
  */
 export declare function lint_v1(options: {
-	/**
-	 * Glob pattern
-	 */
-	files?: string | string[];
-	/**
-	 * Target source code of evaluation
-	 */
-	sourceCodes?: string | string[];
-	/**
-	 * File names when `sourceCodes`
-	 */
-	names?: string | string[];
-	/**
-	 * Workspace path when `sourceCodes`
-	 */
-	workspace?: string;
-	/**
-	 * Configure file or object
-	 */
-	config?: string | Config;
-	/**
-	 * The config applied when not resolved from files or set it explicitly.
-	 */
-	defaultConfig?: Config;
-	/**
-	 * Rules (default: `@markuplint/rules`)
-	 */
-	rules?: MLRule<RuleConfigValue, unknown>[];
-	/**
-	 * Auto resolve rules
-	 *
-	 * Auto importing form *node_modules* when set `@markuplint/rule-{RULE_NAME}` or `markuplint-rule-{RULE_NAME}` in config rules
-	 */
-	rulesAutoResolve?: boolean;
-	/**
-	 * Auto fix
-	 */
-	fix?: boolean;
-	/**
-	 * Locale
-	 */
-	locale?: string;
-}): Promise<import('..').MLResultInfo[]>;
+    /**
+     * Glob pattern
+     */
+    readonly files?: string | readonly string[];
+    /**
+     * Target source code of evaluation
+     */
+    readonly sourceCodes?: string | readonly string[];
+    /**
+     * File names when `sourceCodes`
+     */
+    readonly names?: string | readonly string[];
+    /**
+     * Workspace path when `sourceCodes`
+     */
+    readonly workspace?: string;
+    /**
+     * Configure file or object
+     */
+    readonly config?: string | Config;
+    /**
+     * The config applied when not resolved from files or set it explicitly.
+     */
+    readonly defaultConfig?: Config;
+    /**
+     * Rules (default: `@markuplint/rules`)
+     */
+    readonly rules?: readonly Readonly<MLRule<RuleConfigValue, PlainData>>[];
+    /**
+     * Auto resolve rules
+     *
+     * Auto importing form *node_modules* when set `@markuplint/rule-{RULE_NAME}` or `markuplint-rule-{RULE_NAME}` in config rules
+     */
+    readonly rulesAutoResolve?: boolean;
+    /**
+     * Auto fix
+     */
+    readonly fix?: boolean;
+    /**
+     * Locale
+     */
+    readonly locale?: string;
+}): Promise<import("..").MLResultInfo[]>;

package/lib/cli/bootstrap.d.ts

@@ -1,57 +1,57 @@
+import type { ReadonlyDeep } from 'type-fest';
 import meow from 'meow';
-export declare const help =
-	'\nUsage\n\t$ markuplint <HTML file paths (glob format)>\n\t$ <stdout> | markuplint\n\nOptions\n\t--config,                -c FILE_PATH  A configuration file path.\n\t--fix,                                 Fix HTML.\n\t--format,                -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".\n\t--no-search-config                     No search a configure file automatically.\n\t--ignore-ext                           Evaluate files that are received even though the type of extension.\n\t--no-import-preset-rules               No import preset rules.\n\t--locale                               Locale of the message of violation. Default is an OS setting.\n\t--no-color,                            Output no color.\n\t--problem-only,          -p            Output only problems, without passeds.\n\t--verbose                              Output with detailed information.\n\n\t--init                                 Initialize settings interactively.\n\t--create-rule                          Add the scaffold of a custom rule.\n\t--search                               Search lines of codes that include the target element by selectors.\n\n\t--help,                  -h            Show help.\n\t--version,               -v            Show version.\n\nExamples\n\t$ markuplint verifyee.html --config path/to/.markuplintrc\n\t$ cat verifyee.html | markuplint\n';
+export declare const help = "\nUsage\n\t$ markuplint <HTML file paths (glob format)>\n\t$ <stdout> | markuplint\n\nOptions\n\t--config,                -c FILE_PATH  A configuration file path.\n\t--fix,                                 Fix HTML.\n\t--format,                -f FORMAT     Output format. Support \"JSON\", \"Simple\" and \"Standard\". Default: \"Standard\".\n\t--no-search-config                     No search a configure file automatically.\n\t--ignore-ext                           Evaluate files that are received even though the type of extension.\n\t--no-import-preset-rules               No import preset rules.\n\t--locale                               Locale of the message of violation. Default is an OS setting.\n\t--no-color,                            Output no color.\n\t--problem-only,          -p            Output only problems, without passeds.\n\t--verbose                              Output with detailed information.\n\n\t--init                                 Initialize settings interactively.\n\t--create-rule                          Add the scaffold of a custom rule.\n\t--search                               Search lines of codes that include the target element by selectors.\n\n\t--help,                  -h            Show help.\n\t--version,               -v            Show version.\n\nExamples\n\t$ markuplint verifyee.html --config path/to/.markuplintrc\n\t$ cat verifyee.html | markuplint\n";
 export declare const cli: meow.Result<{
-	config: {
-		type: 'string';
-		alias: string;
-	};
-	fix: {
-		type: 'boolean';
-		default: false;
-	};
-	format: {
-		type: 'string';
-		alias: string;
-	};
-	searchConfig: {
-		type: 'boolean';
-		default: true;
-	};
-	ignoreExt: {
-		type: 'boolean';
-		default: false;
-	};
-	importPresetRules: {
-		type: 'boolean';
-		default: true;
-	};
-	locale: {
-		type: 'string';
-	};
-	color: {
-		type: 'boolean';
-		default: true;
-	};
-	problemOnly: {
-		type: 'boolean';
-		alias: string;
-		default: false;
-	};
-	verbose: {
-		type: 'boolean';
-		default: false;
-	};
-	init: {
-		type: 'boolean';
-		default: false;
-	};
-	createRule: {
-		type: 'boolean';
-		default: false;
-	};
-	search: {
-		type: 'string';
-	};
+    config: {
+        type: "string";
+        alias: string;
+    };
+    fix: {
+        type: "boolean";
+        default: false;
+    };
+    format: {
+        type: "string";
+        alias: string;
+    };
+    searchConfig: {
+        type: "boolean";
+        default: true;
+    };
+    ignoreExt: {
+        type: "boolean";
+        default: false;
+    };
+    importPresetRules: {
+        type: "boolean";
+        default: true;
+    };
+    locale: {
+        type: "string";
+    };
+    color: {
+        type: "boolean";
+        default: true;
+    };
+    problemOnly: {
+        type: "boolean";
+        alias: string;
+        default: false;
+    };
+    verbose: {
+        type: "boolean";
+        default: false;
+    };
+    init: {
+        type: "boolean";
+        default: false;
+    };
+    createRule: {
+        type: "boolean";
+        default: false;
+    };
+    search: {
+        type: "string";
+    };
 }>;
-export type CLIOptions = typeof cli.flags;
+export type CLIOptions = ReadonlyDeep<typeof cli.flags>;

package/lib/cli/command.d.ts

@@ -1,4 +1,4 @@
-import type { APIOptions } from '../api/types';
 import type { CLIOptions } from './bootstrap';
+import type { APIOptions } from '../api/types';
 import type { Target } from '@markuplint/file-resolver';
-export declare function command(files: Target[], options: CLIOptions, apiOptions?: APIOptions): Promise<boolean>;
+export declare function command(files: readonly Readonly<Target>[], options: CLIOptions, apiOptions?: APIOptions): Promise<boolean>;

package/lib/cli/init/create-config.d.ts

@@ -1,4 +1,4 @@
 import type { DefaultRules, Langs, RuleSettingMode } from './types';
 import type { Config } from '@markuplint/ml-config';
 export declare const langs: Record<Langs, string>;
-export declare function createConfig(langs: Langs[], mode: RuleSettingMode, defaultRules: DefaultRules): Config;
+export declare function createConfig(langs: readonly Langs[], mode: RuleSettingMode, defaultRules: DefaultRules): Config;

package/lib/cli/init/create-config.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createConfig = exports.langs = void 0;
-const ml_config_1 = require("@markuplint/ml-config");
 const extRExp = {
     jsx: '\\.[jt]sx?$',
     vue: '\\.vue$',
@@ -32,28 +31,36 @@ exports.langs = {
 };
 function createConfig(langs, mode, defaultRules) {
     let config = {};
+    const parser = { ...config.parser };
     for (const lang of langs) {
-        config.parser = config.parser || {};
         const ext = extRExp[lang];
         if (!ext) {
             continue;
         }
-        config.parser[ext] = `@markuplint/${lang}-parser`;
+        parser[ext] = `@markuplint/${lang}-parser`;
         if (lang === 'vue') {
-            config = (0, ml_config_1.mergeConfig)(config, {
+            config = {
+                ...config,
                 specs: {
+                    ...config.specs,
                     '\\.vue$': '@markuplint/vue-spec',
                 },
-            });
+            };
         }
         if (lang === 'jsx') {
-            config = (0, ml_config_1.mergeConfig)(config, {
+            config = {
+                ...config,
                 specs: {
+                    ...config.specs,
                     '\\.[jt]sx?$': '@markuplint/react-spec',
                 },
-            });
+            };
         }
     }
+    if (Object.keys(parser).length) {
+        config.parser = parser;
+    }
+    const rules = { ...config.rules };
     if (Array.isArray(mode)) {
         const ruleNames = Object.keys(defaultRules);
         for (const ruleName of ruleNames) {
@@ -62,10 +69,7 @@ function createConfig(langs, mode, defaultRules) {
                 continue;
             }
             if (mode.includes(rule.category)) {
-                if (!config.rules) {
-                    config.rules = {};
-                }
-                config.rules[ruleName] = rule.defaultValue;
+                rules[ruleName] = rule.defaultValue;
             }
         }
     }
@@ -73,13 +77,18 @@ function createConfig(langs, mode, defaultRules) {
         config.extends = [...(config.extends || []), 'markuplint:recommended'];
     }
     else {
-        config.rules = {};
         const ruleNames = Object.keys(defaultRules);
         for (const ruleName of ruleNames) {
             const rule = defaultRules[ruleName];
-            config.rules[ruleName] = rule.defaultValue;
+            if (!rule) {
+                continue;
+            }
+            rules[ruleName] = rule.defaultValue;
         }
     }
+    if (Object.keys(rules).length) {
+        config.rules = rules;
+    }
     return config;
 }
 exports.createConfig = createConfig;

package/lib/cli/init/get-default-rules.d.ts

@@ -1,2 +1,3 @@
-import type { DefaultRules } from './types';
-export declare function getDefaultRules(version: string): Promise<DefaultRules>;
+export declare function getDefaultRules(version: string): Promise<{
+    [x: string]: import("./types").Rule;
+}>;

package/lib/cli/init/install-module.d.ts

@@ -1,7 +1,7 @@
 import type { Langs } from './types';
 export type InstallModuleResult = {
-	success: boolean;
-	alreadyExists: boolean;
+    success: boolean;
+    alreadyExists: boolean;
 };
-export declare function selectModules(selectedLangs: Langs[]): string[];
-export declare function installModule(module: string[], dev?: boolean): Promise<InstallModuleResult>;
+export declare function selectModules(selectedLangs: readonly Langs[]): string[];
+export declare function installModule(module: readonly string[], dev?: boolean): Promise<InstallModuleResult>;

package/lib/cli/init/types.d.ts

@@ -1,20 +1,8 @@
-export type Langs =
-	| 'jsx'
-	| 'vue'
-	| 'svelte'
-	| 'astro'
-	| 'pug'
-	| 'php'
-	| 'smarty'
-	| 'erb'
-	| 'ejs'
-	| 'mustache'
-	| 'nunjucks'
-	| 'liquid';
+export type Langs = 'jsx' | 'vue' | 'svelte' | 'astro' | 'pug' | 'php' | 'smarty' | 'erb' | 'ejs' | 'mustache' | 'nunjucks' | 'liquid';
 export type Category = 'validation' | 'a11y' | 'naming-convention' | 'style' | 'maintainability';
-export type RuleSettingMode = Category[] | 'recommended' | 'none';
-export type DefaultRules = Record<string, Rule>;
+export type RuleSettingMode = readonly Category[] | 'recommended' | 'none';
+export type DefaultRules = Readonly<Record<string, Rule>>;
 export type Rule = {
-	category: Category;
-	defaultValue: boolean | string | number;
+    readonly category: Category;
+    readonly defaultValue: boolean | string | number;
 };

package/lib/cli/output.d.ts

@@ -1,3 +1,3 @@
-import type { MLResultInfo } from '../types';
 import type { CLIOptions } from './bootstrap';
+import type { MLResultInfo } from '../types';
 export declare function output(results: MLResultInfo, options: CLIOptions): void;

package/lib/cli/prompt.d.ts

@@ -1,23 +1,18 @@
 type SelectQuestion<T> = {
-	message: string;
-	choices: {
-		name: string;
-		value: T;
-	}[];
+    readonly message: string;
+    readonly choices: readonly {
+        readonly name: string;
+        readonly value: T;
+    }[];
 };
 export declare function select<T>(question: SelectQuestion<T>): Promise<T>;
 export declare function multiSelect<T>(question: SelectQuestion<T>): Promise<T[]>;
-export declare function input<T extends string = string>(question: string, validation?: RegExp): Promise<T>;
-export declare function confirm(
-	question: string,
-	options?: {
-		initial?: boolean;
-	},
-): Promise<boolean>;
-export declare function confirmSequence<T extends string = string>(
-	questions: {
-		message: string;
-		name: T;
-	}[],
-): Promise<Record<T, boolean>>;
+export declare function input<T extends string = string>(question: string, validation?: Readonly<RegExp>): Promise<T>;
+export declare function confirm(question: string, options?: {
+    readonly initial?: boolean;
+}): Promise<boolean>;
+export declare function confirmSequence<T extends string = string>(questions: readonly {
+    readonly message: string;
+    readonly name: T;
+}[]): Promise<Record<T, boolean>>;
 export {};

package/lib/cli/search/index.d.ts

@@ -1,2 +1,2 @@
 import type { CLIOptions } from '../bootstrap';
-export default function (files: string[], options: CLIOptions, selectors: string): Promise<void>;
+export default function (files: readonly string[], options: CLIOptions, selectors: string): Promise<void>;

package/lib/global-settings.d.ts

@@ -1,5 +1,5 @@
 export type GlobalSettings = {
-	locale: string;
+    readonly locale: string;
 };
 export declare function setGlobal(settings: Partial<GlobalSettings>): void;
 export declare function getGlobal(): Readonly<Partial<GlobalSettings>>;

package/lib/i18n.js

@@ -1,5 +1,4 @@
 "use strict";
-var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.i18n = void 0;
 const tslib_1 = require("tslib");
@@ -12,9 +11,10 @@ async function getLocale() {
     return cachedLocale;
 }
 async function i18n(locale) {
+    var _a;
     locale = locale || (await getLocale()) || 'en';
-    const langCode = locale.split('-')[0];
-    const loadLocaleSet = await (_a = `@markuplint/i18n/locales/${langCode}`, Promise.resolve().then(() => tslib_1.__importStar(require(_a)))).catch(() => null);
+    const langCode = (_a = locale.split('-')[0]) !== null && _a !== void 0 ? _a : locale;
+    const loadLocaleSet = await Promise.resolve(`${`@markuplint/i18n/locales/${langCode}`}`).then(s => tslib_1.__importStar(require(s))).catch(() => null);
     const localeSet = loadLocaleSet ||
         // @ts-ignore
         (await Promise.resolve().then(() => tslib_1.__importStar(require('@markuplint/i18n/locales/en'))));

package/lib/testing-tool/index.d.ts

@@ -1,51 +1,33 @@
 import type { Target } from '@markuplint/file-resolver';
-import type { Config, RuleConfigValue, Rule, RegexSelector } from '@markuplint/ml-config';
+import type { Config, RuleConfigValue, Rule, RegexSelector, PlainData } from '@markuplint/ml-config';
 import type { AnyMLRule, RuleSeed } from '@markuplint/ml-core';
-export declare function mlTest(
-	sourceCode: string,
-	config: Config,
-	rules?: AnyMLRule[],
-	locale?: string,
-	fix?: boolean,
-): Promise<{
-	violations: import('@markuplint/ml-config').Violation[];
-	fixedCode: string;
+export declare function mlTest(sourceCode: string, config: Config, rules?: readonly Readonly<AnyMLRule>[], locale?: string, fix?: boolean): Promise<{
+    violations: readonly import("@markuplint/ml-config").Violation[];
+    fixedCode: string;
 }>;
-export declare function mlRuleTest<T extends RuleConfigValue, O = null>(
-	rule: RuleSeed<T, O>,
-	sourceCode: string,
-	config?: Omit<Config, 'rules' | 'nodeRules' | 'childNodeRules'> & {
-		rule?: Rule<T, Partial<O>>;
-		nodeRule?: NodeRule<T, Partial<O>>[];
-		childNodeRule?: ChildNodeRule<T, Partial<O>>[];
-	},
-	fix?: boolean,
-	locale?: string,
-): Promise<{
-	violations: import('@markuplint/ml-config').Violation[];
-	fixedCode: string;
+export declare function mlRuleTest<T extends RuleConfigValue, O extends PlainData>(rule: Readonly<RuleSeed<T, O>>, sourceCode: string, config?: Omit<Config, 'rules' | 'nodeRules' | 'childNodeRules'> & {
+    rule?: Rule<T, Partial<O>>;
+    nodeRule?: NodeRule<T, Partial<O>>[];
+    childNodeRule?: ChildNodeRule<T, Partial<O>>[];
+}, fix?: boolean, locale?: string): Promise<{
+    violations: readonly import("@markuplint/ml-config").Violation[];
+    fixedCode: string;
 }>;
-export declare function mlTestFile(
-	target: Target,
-	config?: Config,
-	rules?: AnyMLRule[],
-	locale?: string,
-	fix?: boolean,
-): Promise<{
-	violations: import('@markuplint/ml-config').Violation[];
-	fixedCode: string;
+export declare function mlTestFile(target: Target, config?: Config, rules?: readonly Readonly<AnyMLRule>[], locale?: string, fix?: boolean): Promise<{
+    violations: readonly import("@markuplint/ml-config").Violation[];
+    fixedCode: string | undefined;
 }>;
-export interface NodeRule<T extends RuleConfigValue, O = void> {
-	selector?: string;
-	regexSelector?: RegexSelector;
-	categories?: string[];
-	roles?: string[];
-	obsolete?: boolean;
-	rule?: Rule<T, O>;
+export interface NodeRule<T extends RuleConfigValue, O extends PlainData = undefined> {
+    selector?: string;
+    regexSelector?: RegexSelector;
+    categories?: string[];
+    roles?: string[];
+    obsolete?: boolean;
+    rule?: Rule<T, O>;
 }
-export interface ChildNodeRule<T extends RuleConfigValue, O = void> {
-	selector?: string;
-	regexSelector?: RegexSelector;
-	inheritance?: boolean;
-	rule?: Rule<T, O>;
+export interface ChildNodeRule<T extends RuleConfigValue, O extends PlainData = undefined> {
+    selector?: string;
+    regexSelector?: RegexSelector;
+    inheritance?: boolean;
+    rule?: Rule<T, O>;
 }

package/lib/types.d.ts

@@ -1,27 +1,27 @@
-import type { Config, Violation } from '@markuplint/ml-config';
+import type { Config, PlainData, RuleConfigValue, Violation } from '@markuplint/ml-config';
 import type { Document, Ruleset } from '@markuplint/ml-core';
 export interface MLResultInfo {
-	violations: Violation[];
-	filePath: string;
-	sourceCode: string;
-	fixedCode: string;
+    readonly violations: readonly Violation[];
+    readonly filePath: string;
+    readonly sourceCode: string;
+    readonly fixedCode: string;
 }
 /**
  * @deprecated
  */
 export interface MLResultInfo_v1 {
-	results: Violation[];
-	filePath: string;
-	sourceCode: string;
-	fixedCode: string;
-	document: Document<any, unknown> | null;
-	parser: string;
-	locale?: string;
-	ruleset: Ruleset;
-	configSet: {
-		config: Config;
-		files: string[];
-		error: string[];
-	};
+    results: Violation[];
+    filePath: string;
+    sourceCode: string;
+    fixedCode: string;
+    document: Document<RuleConfigValue, PlainData> | null;
+    parser: string;
+    locale?: string;
+    ruleset: Ruleset;
+    configSet: {
+        config: Config;
+        files: string[];
+        error: string[];
+    };
 }
 export type Nullable<T> = T | null | undefined;

package/lib/util.d.ts

@@ -4,12 +4,12 @@ export declare function uuid(): string;
 export declare const markuplint: string;
 export declare function write(message: string): void;
 export declare namespace write {
-	var _a: () => boolean;
-	export { _a as break };
+    var _a: () => boolean;
+    export { _a as break };
 }
 export declare function error(message: string): void;
 export declare namespace error {
-	var exit: () => never;
+    var exit: () => never;
 }
 export declare const head: (method: string, noColor?: boolean) => string;
 export declare function p(s: number | string, pad: number, start?: boolean): string;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "markuplint",
-	"version": "3.3.1",
-	"description": "A linter for all markup developers",
+	"version": "3.5.0",
+	"description": "An HTML linter for all markup developers",
 	"author": "Yusuke Hirao",
 	"license": "MIT",
 	"private": false,
@@ -28,16 +28,16 @@
 		"execa": "5"
 	},
 	"dependencies": {
-		"@markuplint/create-rule-helper": "3.3.1",
-		"@markuplint/file-resolver": "3.3.1",
-		"@markuplint/html-parser": "3.3.1",
-		"@markuplint/html-spec": "3.3.1",
-		"@markuplint/i18n": "3.3.0",
-		"@markuplint/ml-ast": "3.0.0",
-		"@markuplint/ml-config": "3.3.0",
-		"@markuplint/ml-core": "3.3.1",
-		"@markuplint/ml-spec": "3.3.0",
-		"@markuplint/rules": "3.3.1",
+		"@markuplint/create-rule-helper": "3.5.0",
+		"@markuplint/file-resolver": "3.5.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-core": "3.5.0",
+		"@markuplint/ml-spec": "3.5.0",
+		"@markuplint/rules": "3.5.0",
 		"chokidar": "^3.5.3",
 		"cli-color": "^2.0.3",
 		"debug": "^4.3.4",
@@ -53,7 +53,8 @@
 		"strict-event-emitter": "^0.2.8",
 		"strip-ansi": "6",
 		"tslib": "^2.4.1",
+		"type-fest": "^3.6.1",
 		"uuid": "^9.0.0"
 	},
-	"gitHead": "f19e7de726cf01d53342bc5513c30da75d28da63"
+	"gitHead": "0c47b2c2722f6823a17f36edbab98486275f8ab4"
 }