markuplint 3.9.1 → 3.10.0

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

@@ -5,27 +5,27 @@ import type { PlainData } from '@markuplint/ml-config';
 import type { Document, RuleConfigValue } from '@markuplint/ml-core';
 import { Emitter } from 'strict-event-emitter';
 type MLEngineOptions = {
-	readonly debug?: boolean;
-	readonly watch?: boolean;
+    readonly debug?: boolean;
+    readonly watch?: boolean;
 };
 export default class MLEngine extends Emitter<MLEngineEventMap> {
-	#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;
+    #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/types.d.ts

@@ -3,38 +3,38 @@ import type { LocaleSet } from '@markuplint/i18n';
 import type { Config, Violation } from '@markuplint/ml-config';
 import type { AnyMLRule, MLSchema, Ruleset } from '@markuplint/ml-core';
 export type APIOptions = {
-	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;
+    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];
-	config: [filePath: string, config: ConfigSet, message?: string];
-	exclude: [filePath: string, setting: string, message?: string];
-	parser: [filePath: string, parser: string, message?: string];
-	ruleset: [filePath: string, ruleset: Ruleset, message?: string];
-	schemas: [filePath: string, schemas: MLSchema, message?: string];
-	rules: [filePath: string, rules: readonly Readonly<AnyMLRule>[], message?: string];
-	i18n: [filePath: string, locale: LocaleSet, message?: string];
-	code: [filePath: string, sourceCode: string, message?: string];
-	lint: [
-		filePath: string,
-		sourceCode: string,
-		violations: readonly Violation[],
-		fixedCode: string,
-		debug: readonly string[] | null,
-		message?: string,
-	];
-	'lint-error': [filePath: string, sourceCode: string, error: Readonly<Error>];
-	'config-errors': [filePath: string, errors: readonly Readonly<Error>[]];
+    log: [phase: string, message: string];
+    config: [filePath: string, config: ConfigSet, message?: string];
+    exclude: [filePath: string, setting: string, message?: string];
+    parser: [filePath: string, parser: string, message?: string];
+    ruleset: [filePath: string, ruleset: Ruleset, message?: string];
+    schemas: [filePath: string, schemas: MLSchema, message?: string];
+    rules: [filePath: string, rules: readonly Readonly<AnyMLRule>[], message?: string];
+    i18n: [filePath: string, locale: LocaleSet, message?: string];
+    code: [filePath: string, sourceCode: string, message?: string];
+    lint: [
+        filePath: string,
+        sourceCode: string,
+        violations: readonly Violation[],
+        fixedCode: string,
+        debug: readonly string[] | null,
+        message?: string
+    ];
+    'lint-error': [filePath: string, sourceCode: string, error: Readonly<Error>];
+    'config-errors': [filePath: string, errors: readonly Readonly<Error>[]];
 };

package/lib/api/v1.d.ts

@@ -6,46 +6,46 @@ import type { MLRule } from '@markuplint/ml-core';
  * @returns
  */
 export declare function lint_v1(options: {
-	/**
-	 * 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[]>;
+    /**
+     * 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,66 +1,65 @@
 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", "GitHub" 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--allow-warnings                       Return status code 0 even if there are warnings.\n\t--allow-empty-input                    Return status code 1 even if there are no input files.\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\", \"GitHub\" 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--allow-warnings                       Return status code 0 even if there are warnings.\n\t--allow-empty-input                    Return status code 1 even if there are no input files.\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;
-	};
-	allowWarnings: {
-		type: 'boolean';
-		default: false;
-	};
-	allowEmptyInput: {
-		type: 'boolean';
-		default: true;
-	};
-	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;
+    };
+    allowWarnings: {
+        type: "boolean";
+        default: false;
+    };
+    allowEmptyInput: {
+        type: "boolean";
+        default: true;
+    };
+    verbose: {
+        type: "boolean";
+        default: false;
+    };
+    init: {
+        type: "boolean";
+        default: false;
+    };
+    createRule: {
+        type: "boolean";
+        default: false;
+    };
+    search: {
+        type: "string";
+    };
 }>;
 export type CLIOptions = ReadonlyDeep<typeof cli.flags>;

package/lib/cli/command.d.ts

@@ -1,8 +1,4 @@
 import type { CLIOptions } from './bootstrap';
 import type { APIOptions } from '../api/types';
 import type { Target } from '@markuplint/file-resolver';
-export declare function command(
-	files: readonly Readonly<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,8 +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: readonly Langs[],
-	mode: RuleSettingMode,
-	defaultRules: DefaultRules,
-): Config;
+export declare function createConfig(langs: readonly Langs[], mode: RuleSettingMode, defaultRules: DefaultRules): Config;

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

@@ -1,3 +1,3 @@
 export declare function getDefaultRules(version: string): Promise<{
-	[x: string]: import('./types').Rule;
+    [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: 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 = readonly Category[] | 'recommended' | 'none';
 export type DefaultRules = Readonly<Record<string, Rule>>;
 export type Rule = {
-	readonly category: Category;
-	readonly defaultValue: boolean | string | number;
+    readonly category: Category;
+    readonly defaultValue: boolean | string | number;
 };

package/lib/cli/prompt.d.ts

@@ -1,23 +1,18 @@
 type SelectQuestion<T> = {
-	readonly message: string;
-	readonly choices: readonly {
-		readonly name: string;
-		readonly 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?: 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 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/global-settings.d.ts

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

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

@@ -1,51 +1,33 @@
 import type { Target } from '@markuplint/file-resolver';
 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?: readonly Readonly<AnyMLRule>[],
-	locale?: string,
-	fix?: boolean,
-): Promise<{
-	violations: readonly 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 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 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?: readonly Readonly<AnyMLRule>[],
-	locale?: string,
-	fix?: boolean,
-): Promise<{
-	violations: readonly import('@markuplint/ml-config').Violation[];
-	fixedCode: string | undefined;
+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 extends PlainData = undefined> {
-	selector?: string;
-	regexSelector?: RegexSelector;
-	categories?: string[];
-	roles?: string[];
-	obsolete?: boolean;
-	rule?: Rule<T, O>;
+    selector?: string;
+    regexSelector?: RegexSelector;
+    categories?: string[];
+    roles?: string[];
+    obsolete?: 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>;
+    selector?: string;
+    regexSelector?: RegexSelector;
+    inheritance?: boolean;
+    rule?: Rule<T, O>;
 }

package/lib/types.d.ts

@@ -1,26 +1,26 @@
 import type { Config, PlainData, RuleConfigValue, Violation } from '@markuplint/ml-config';
 import type { Document, Ruleset } from '@markuplint/ml-core';
 export interface MLResultInfo {
-	readonly violations: readonly Violation[];
-	readonly filePath: string;
-	readonly sourceCode: string;
-	readonly 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<RuleConfigValue, PlainData> | 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[];
+    };
 }

package/lib/util.d.ts

@@ -2,12 +2,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,6 +1,6 @@
 {
 	"name": "markuplint",
-	"version": "3.9.1",
+	"version": "3.10.0",
 	"description": "An HTML linter for all markup developers",
 	"author": "Yusuke Hirao",
 	"license": "MIT",
@@ -20,22 +20,22 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@markuplint/create-rule-helper": "3.9.1",
-		"@markuplint/file-resolver": "3.9.0",
-		"@markuplint/html-parser": "3.7.0",
-		"@markuplint/html-spec": "3.8.0",
+		"@markuplint/create-rule-helper": "3.10.0",
+		"@markuplint/file-resolver": "3.10.0",
+		"@markuplint/html-parser": "3.8.0",
+		"@markuplint/html-spec": "3.9.0",
 		"@markuplint/i18n": "3.8.0",
 		"@markuplint/ml-ast": "3.1.0",
-		"@markuplint/ml-config": "3.8.0",
-		"@markuplint/ml-core": "3.9.0",
-		"@markuplint/ml-spec": "3.8.0",
-		"@markuplint/rules": "3.9.0",
+		"@markuplint/ml-config": "3.9.0",
+		"@markuplint/ml-core": "3.10.0",
+		"@markuplint/ml-spec": "3.9.0",
+		"@markuplint/rules": "3.10.0",
 		"@markuplint/shared": "3.6.0",
 		"@types/cli-color": "^2.0.2",
 		"@types/debug": "^4.1.7",
 		"@types/has-yarn": "^1.0.1",
 		"@types/meow": "^6.0.0",
-		"@types/uuid": "^9.0.0",
+		"@types/uuid": "^9.0.1",
 		"chokidar": "^3.5.3",
 		"cli-color": "^2.0.3",
 		"debug": "^4.3.4",
@@ -50,9 +50,9 @@
 		"os-locale": "5",
 		"strict-event-emitter": "^0.5.0",
 		"strip-ansi": "6",
-		"tslib": "^2.4.1",
-		"type-fest": "^3.8.0",
+		"tslib": "^2.5.0",
+		"type-fest": "^3.10.0",
 		"uuid": "^9.0.0"
 	},
-	"gitHead": "463a60d5d85e6412c3b9744a0b682f6da0eb1c39"
+	"gitHead": "af370797bfc887e5a5a2ff57fbaa8392ac98ead2"
 }