markuplint 3.0.0-canary.3 → 3.0.0-dev.176

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
 
@@ -47,7 +47,7 @@ Add a command to the `scripts` option on `package.json`:
 ```json
 {
   "scripts": {
-    "html:lint": "markuplint **/*.html"
+    "lint:html": "markuplint **/*.html"
   }
 }
 ```
@@ -57,9 +57,9 @@ If you want to change the target path, you can change it for your project.
 Execute the script:
 
 ```
-$ npm run html:lint
+$ npm run lint:html
 # or
-$ yarn html:lint
+$ yarn lint:html
 ```
 
 ### Command line options
@@ -74,7 +74,7 @@ Usage
 Options
 	--config,                -c FILE_PATH  A configuration file path.
 	--fix,                                 Fix HTML.
-	--format,                -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
+	--format,                -f FORMAT     Output format. Support "JSON", "Simple", "GitHub" and "Standard". Default: "Standard".
 	--no-search-config                     No search a configure file automatically.
 	--ignore-ext                           Evaluate files that are received even though the type of extension.
 	--no-import-preset-rules               No import preset rules.
@@ -119,7 +119,9 @@ Need [Sponsors❤️‍🔥](https://github.com/sponsors/markuplint)
 
 ### Personal Supporters
 
-[<img width="36" src="https://avatars.githubusercontent.com/u/91733847?v=4" alt="Tokitake" />](https://github.com/Tokitake)
+[<img width="36" src="https://avatars.githubusercontent.com/u/91733847" alt="Tokitake" />](https://github.com/Tokitake)
+[<img width="36" src="https://avatars.githubusercontent.com/u/1996642" alt="yamanoku" />](https://github.com/yamanoku)
+[<img width="36" src="https://avatars.githubusercontent.com/u/6581173" alt="miita" />](https://github.com/mikimhk)
 
 ## Thanks
 

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';
+import { Emitter } 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;
+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;
 }
 export {};

package/lib/api/ml-engine.js

@@ -10,7 +10,8 @@ const debug_1 = require("../debug");
 const i18n_1 = require("../i18n");
 const log = debug_1.log.extend('ml-engine');
 const fileLog = log.extend('file');
-class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
+const configLog = log.extend('config');
+class MLEngine extends strict_event_emitter_1.Emitter {
     static async toMLFile(target) {
         const files = await (0, file_resolver_1.resolveFiles)([target]);
         return files[0];
@@ -78,7 +79,7 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
                 fixedCode,
             };
         }
-        const debugMap = ('debugMap' in core.document && core.document.debugMap()) || null;
+        const debugMap = 'debugMap' in core.document ? core.document.debugMap() : null;
         this.emit('lint', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, sourceCode, violations, fixedCode, debugMap);
         log('exec: end');
         return {
@@ -149,7 +150,7 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
         await this.exec();
     }
     async provide(cache = true) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         const configSet = await this.resolveConfig(cache);
         fileLog('Fetched Config files: %O', configSet.files);
         fileLog('Resolved Config: %O', configSet.config);
@@ -161,7 +162,7 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
             return null;
         }
         // Exclude
-        const excludeFiles = configSet.config.excludeFiles || [];
+        const excludeFiles = (_a = configSet.config.excludeFiles) !== null && _a !== void 0 ? _a : [];
         for (const excludeFile of excludeFiles) {
             if (tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").matches(excludeFile)) {
                 this.emit('exclude', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, excludeFile);
@@ -170,7 +171,7 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
             }
         }
         const { parser, parserOptions, matched } = await this.resolveParser(configSet);
-        const checkingExt = !((_a = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _a === void 0 ? void 0 : _a.ignoreExt);
+        const checkingExt = !((_b = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _b === void 0 ? void 0 : _b.ignoreExt);
         if (checkingExt && !matched) {
             this.emit('log', 'ext-unmatched', `Avoided linting because a file is unmatched by the extension: ${tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path}`);
             fileLog('Avoided linting because a file is unmatched by the extension: %s', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path);
@@ -180,7 +181,7 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
         fileLog('Resolved ruleset: %O', ruleset);
         const schemas = await this.resolveSchemas(configSet);
         if (fileLog.enabled) {
-            if (schemas[0].cites.length) {
+            if (schemas[0].cites.length > 0) {
                 const [, ...additionalSpecs] = schemas;
                 fileLog('Resolved schemas: HTML Standard');
                 for (const additionalSpec of additionalSpecs) {
@@ -193,14 +194,14 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
         }
         const rules = await this.resolveRules(configSet.plugins, ruleset);
         fileLog('Resolved rules: %O', rules);
-        const locale = await (0, i18n_1.i18n)((_b = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _b === void 0 ? void 0 : _b.locale);
+        const locale = await (0, i18n_1.i18n)((_c = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _c === void 0 ? void 0 : _c.locale);
         if (fileLog.enabled) {
             fileLog('Loaded %d rules: %O', rules.length, rules.map(r => r.name));
         }
         return {
             parser,
             parserOptions,
-            pretenders: (_c = configSet.config.pretenders) !== null && _c !== void 0 ? _c : [],
+            pretenders: (_d = configSet.config.pretenders) !== null && _d !== void 0 ? _d : [],
             ruleset,
             schemas,
             rules,
@@ -209,23 +210,37 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
         };
     }
     async resolveConfig(cache) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const defaultConfigKey = ((_a = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _a === void 0 ? void 0 : _a.defaultConfig) && tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").set((_b = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _b === void 0 ? void 0 : _b.defaultConfig);
+        configLog('defaultConfigKey: %s', defaultConfigKey !== null && defaultConfigKey !== void 0 ? defaultConfigKey : 'N/A');
+        this.emit('log', 'defaultConfigKey', defaultConfigKey !== null && defaultConfigKey !== void 0 ? defaultConfigKey : 'N/A');
         const configFilePathsFromTarget = ((_c = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _c === void 0 ? void 0 : _c.noSearchConfig)
             ? defaultConfigKey !== null && defaultConfigKey !== void 0 ? defaultConfigKey : null
-            : (await tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").search(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f"))) || defaultConfigKey;
-        this.emit('log', 'configFilePathsFromTarget', configFilePathsFromTarget || 'null');
-        const configKey = ((_d = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _d === void 0 ? void 0 : _d.config) && tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").set(tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f").config);
-        this.emit('log', 'configKey', configKey || 'null');
-        const configSet = await tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").resolve(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f"), [configFilePathsFromTarget, (_e = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _e === void 0 ? void 0 : _e.configFile, configKey], cache);
+            : (_d = (await tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").search(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f")))) !== null && _d !== void 0 ? _d : defaultConfigKey;
+        configLog('configFilePathsFromTarget: %s', configFilePathsFromTarget !== null && configFilePathsFromTarget !== void 0 ? configFilePathsFromTarget : 'N/A');
+        this.emit('log', 'configFilePathsFromTarget', configFilePathsFromTarget !== null && configFilePathsFromTarget !== void 0 ? configFilePathsFromTarget : 'N/A');
+        const configKey = ((_e = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _e === void 0 ? void 0 : _e.config) && tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").set(tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f").config);
+        configLog('option.config: %s', configKey !== null && configKey !== void 0 ? configKey : 'N/A');
+        this.emit('log', 'option.config', configFilePathsFromTarget !== null && configFilePathsFromTarget !== void 0 ? configFilePathsFromTarget : 'N/A');
+        let defaultRecommended = null;
+        if (!defaultConfigKey && !configFilePathsFromTarget && !configKey) {
+            // No configured
+            // Default: set recommended
+            defaultRecommended = tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").set({ extends: ['markuplint:recommended'] });
+        }
+        configLog('defaultRecommended: %s', defaultRecommended !== null && defaultRecommended !== void 0 ? defaultRecommended : 'N/A');
+        this.emit('log', 'defaultRecommended', defaultRecommended !== null && defaultRecommended !== void 0 ? defaultRecommended : 'N/A');
+        const configSet = await tslib_1.__classPrivateFieldGet(this, _MLEngine_configProvider, "f").resolve(tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f"), [configFilePathsFromTarget, (_f = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _f === void 0 ? void 0 : _f.configFile, configKey, defaultRecommended], cache);
         this.emit('config', tslib_1.__classPrivateFieldGet(this, _MLEngine_file, "f").path, configSet);
-        if ((_f = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _f === void 0 ? void 0 : _f.watch) {
+        if ((_g = tslib_1.__classPrivateFieldGet(this, _MLEngine_options, "f")) === null || _g === void 0 ? void 0 : _g.watch) {
             // It doesn't watch the main HTML file because it may is watched and managed by a language server or text editor or more.
             tslib_1.__classPrivateFieldGet(this, _MLEngine_watcher, "f").add(Array.from(configSet.files));
         }
         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);
@@ -240,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,44 +1,40 @@
 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];
+	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

@@ -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/api/v1.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lint_v1 = void 0;
+const shared_1 = require("@markuplint/shared");
 const lint_1 = require("./lint");
 /**
  * @deprecated
@@ -9,12 +10,8 @@ const lint_1 = require("./lint");
  */
 async function lint_v1(options) {
     var _a;
-    const filePathList = options.files ? (Array.isArray(options.files) ? options.files : [options.files]) : [];
-    const codes = options.sourceCodes
-        ? Array.isArray(options.sourceCodes)
-            ? options.sourceCodes
-            : [options.sourceCodes]
-        : [];
+    const filePathList = (0, shared_1.toNoEmptyStringArrayFromStringOrArray)(options.files);
+    const codes = (0, shared_1.toNoEmptyStringArrayFromStringOrArray)(options.sourceCodes);
     const files = [
         ...filePathList,
         ...codes.map((code, i) => {
@@ -37,7 +34,7 @@ async function lint_v1(options) {
     const result = await (0, lint_1.lint)(files, {
         config,
         configFile,
-        noSearchConfig: !options.files,
+        noSearchConfig: filePathList.length === 0,
         rules: options.rules,
         autoLoad: (_a = options.rulesAutoResolve) !== null && _a !== void 0 ? _a : true,
         locale: options.locale,

package/lib/cli/bootstrap.d.ts

@@ -1,5 +1,6 @@
+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\", \"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--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";
@@ -53,4 +54,4 @@ export declare const cli: meow.Result<{
         type: "string";
     };
 }>;
-export type CLIOptions = typeof cli.flags;
+export type CLIOptions = ReadonlyDeep<typeof cli.flags>;

package/lib/cli/bootstrap.js

@@ -11,7 +11,7 @@ Usage
 Options
 	--config,                -c FILE_PATH  A configuration file path.
 	--fix,                                 Fix HTML.
-	--format,                -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
+	--format,                -f FORMAT     Output format. Support "JSON", "Simple", "GitHub" and "Standard". Default: "Standard".
 	--no-search-config                     No search a configure file automatically.
 	--ignore-ext                           Evaluate files that are received even though the type of extension.
 	--no-import-preset-rules               No import preset rules.

package/lib/cli/command.d.ts

@@ -1,4 +1,8 @@
-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/command.js

@@ -20,7 +20,7 @@ async function command(files, options, apiOptions) {
     const fileList = await (0, file_resolver_1.resolveFiles)(files);
     if (debug_1.log.enabled) {
         (0, debug_1.log)('File list: %O', fileList.map(f => f.path));
-        (0, debug_1.log)('Config: %s', configFile || 'N/A');
+        (0, debug_1.log)('Config: %s', configFile !== null && configFile !== void 0 ? configFile : 'N/A');
         (0, debug_1.log)('Fix option: %s', fix);
     }
     const format = (_a = options.format) === null || _a === void 0 ? void 0 : _a.toLowerCase().trim();
@@ -41,7 +41,7 @@ async function command(files, options, apiOptions) {
         if (!result) {
             continue;
         }
-        if (!hasError && result.violations.length) {
+        if (!hasError && result.violations.length > 0) {
             hasError = true;
         }
         if (fix) {

package/lib/cli/create-rule/index.js

@@ -2,23 +2,59 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRule = void 0;
 const tslib_1 = require("tslib");
+const node_path_1 = require("node:path");
 const create_rule_helper_1 = require("@markuplint/create-rule-helper");
 const cli_color_1 = tslib_1.__importDefault(require("cli-color"));
 const util_1 = require("../../util");
 const install_module_1 = require("../init/install-module");
 const prompt_1 = require("../prompt");
+const icons = {
+    README: '📝',
+    index: '📜',
+    schema: '⚙️ ',
+    package: '🎁',
+    tsconfig: '💎',
+};
 async function createRule() {
+    var _a;
     (0, util_1.write)((0, util_1.head)('Create a rule'));
     util_1.write.break();
+    const firstChoices = [
+        { name: 'Add the rule to this project', value: 'ADD_TO_PROJECT' },
+        { name: 'Create the rule and publish it as a package', value: 'PUBLISH_AS_PACKAGE' },
+    ];
+    if (await (0, create_rule_helper_1.isMarkuplintRepo)()) {
+        firstChoices.push({ name: 'Contribute the new rule to markuplint core rules', value: 'CONTRIBUTE_TO_CORE' });
+    }
     const purpose = await (0, prompt_1.select)({
         message: 'What purpose do you create the rule for?',
-        choices: [
-            { name: 'Add the rule to this project', value: 'ADD_TO_PROJECT' },
-            { name: 'Create the rule and publish it as a package', value: 'PUBLISH_AS_PACKAGE' },
-            { name: 'Contribute the new rule to markuplint core rules', value: 'CONTRIBUTE_TO_CORE' },
-        ],
+        choices: firstChoices,
     });
-    const name = await (0, prompt_1.input)('What is the name?', /^[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*$/i);
+    const dirQuestion = purpose === 'ADD_TO_PROJECT' ? 'What is the directory name?' : 'What is the plugin name?';
+    const pluginName = purpose === 'CONTRIBUTE_TO_CORE' ? '' : await (0, prompt_1.input)(dirQuestion, /^[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*$/i);
+    const ruleName = await (0, prompt_1.input)('What is the rule name?', /^[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*$/i);
+    const core = purpose === 'CONTRIBUTE_TO_CORE'
+        ? {
+            description: await (0, prompt_1.input)('Description:'),
+            category: await (0, prompt_1.select)({
+                message: 'Category:',
+                choices: [
+                    { name: 'Conformance checking', value: 'validation' },
+                    { name: 'Accessibility', value: 'a11y' },
+                    { name: 'Naming Convention', value: 'naming-convention' },
+                    { name: 'Maintainability', value: 'maintainability' },
+                    { name: 'Style', value: 'style' },
+                ],
+            }),
+            severity: await (0, prompt_1.select)({
+                message: 'Severity:',
+                choices: [
+                    { name: 'error', value: 'error' },
+                    { name: 'warning', value: 'warning' },
+                ],
+            }),
+        }
+        : undefined;
     const lang = purpose === 'CONTRIBUTE_TO_CORE'
         ? 'TYPESCRIPT'
         : await (0, prompt_1.select)({
@@ -29,21 +65,14 @@ async function createRule() {
             ],
         });
     const needTest = purpose === 'CONTRIBUTE_TO_CORE' ? true : await (0, prompt_1.confirm)('Do you need the test?', { initial: true });
-    const result = await (0, create_rule_helper_1.createRuleHelper)({ purpose, name, lang, needTest });
-    output(name, '📝', 'README.md', result.readme);
-    output(name, '📜', 'index', result.main);
-    if (result.test) {
-        output(name, '🖍 ', 'index.spec', result.test);
-    }
-    if (result.schemaJson) {
-        output(name, '⚙️ ', 'schema.json', result.schemaJson);
+    const result = await (0, create_rule_helper_1.createRuleHelper)({ purpose, pluginName, ruleName, lang, needTest, core });
+    for (const file of result.files) {
+        output(pluginName || 'core', file.test ? '🖍 ' : (_a = icons[file.name]) !== null && _a !== void 0 ? _a : '🛡 ', file.fileName, (0, node_path_1.resolve)(file.destDir, file.fileName + file.ext));
     }
-    if (result.packageJson) {
-        output(name, '🎁 ', 'package.json', result.packageJson);
-        if (result.tsConfig) {
-            output(name, '💎 ', 'tsconfig.json', result.tsConfig);
-        }
+    if (result.dependencies.length > 0) {
         await (0, install_module_1.installModule)(result.dependencies);
+    }
+    if (result.devDependencies.length > 0) {
         await (0, install_module_1.installModule)(result.devDependencies, true);
     }
 }

package/lib/cli/index.js

@@ -34,7 +34,7 @@ const search_1 = tslib_1.__importDefault(require("./search"));
         return;
     }
     const files = bootstrap_1.cli.input;
-    if (files.length) {
+    if (files.length > 0) {
         if (bootstrap_1.cli.flags.search) {
             await (0, search_1.default)(files, bootstrap_1.cli.flags, bootstrap_1.cli.flags.search).catch(err => {
                 process.stderr.write(err + '\n');

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

@@ -0,0 +1,8 @@
+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;