markuplint 3.15.0 → 4.0.0-alpha.10

package/lib/api/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

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("../types.js").MLResultInfo[]>;

package/lib/api/v1.js

@@ -1,27 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.lint_v1 = void 0;
-const shared_1 = require("@markuplint/shared");
-const lint_1 = require("./lint");
+import { toNoEmptyStringArrayFromStringOrArray } from '@markuplint/shared';
+import { lint } from './lint.js';
 /**
  * @deprecated
  * @param options
  * @returns
  */
-async function lint_v1(options) {
-    var _a;
-    const filePathList = (0, shared_1.toNoEmptyStringArrayFromStringOrArray)(options.files);
-    const codes = (0, shared_1.toNoEmptyStringArrayFromStringOrArray)(options.sourceCodes);
+export async function lint_v1(options) {
+    const filePathList = toNoEmptyStringArrayFromStringOrArray(options.files);
+    const codes = toNoEmptyStringArrayFromStringOrArray(options.sourceCodes);
     const files = [
         ...filePathList,
-        ...codes.map((code, i) => {
-            var _a, _b;
-            return ({
-                sourceCode: code,
-                name: Array.isArray(options.names) ? (_a = options.names) === null || _a === void 0 ? void 0 : _a[i] : options.names,
-                workspace: (_b = options.workspace) === null || _b === void 0 ? void 0 : _b[i],
-            });
-        }),
+        ...codes.map((code, i) => ({
+            sourceCode: code,
+            name: Array.isArray(options.names) ? options.names?.[i] : options.names,
+            workspace: options.workspace?.[i],
+        })),
     ];
     let config;
     let configFile;
@@ -31,14 +24,13 @@ async function lint_v1(options) {
     else if (options.config) {
         config = options.config;
     }
-    const result = await (0, lint_1.lint)(files, {
+    const result = await lint(files, {
         config,
         configFile,
         noSearchConfig: filePathList.length === 0,
         rules: options.rules,
-        autoLoad: (_a = options.rulesAutoResolve) !== null && _a !== void 0 ? _a : true,
+        autoLoad: options.rulesAutoResolve ?? true,
         locale: options.locale,
     });
     return result;
 }
-exports.lint_v1 = lint_v1;

package/lib/cli/bootstrap.d.ts

@@ -1,66 +1,68 @@
 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 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';
-	};
+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\t--include-node-modules                 Include files in node_modules directory. Default: false.\n\n\t--init                                 Initialize settings interactively.\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: import("meow").Result<{
+    config: {
+        type: "string";
+        shortFlag: string;
+    };
+    fix: {
+        type: "boolean";
+        default: false;
+    };
+    format: {
+        type: "string";
+        shortFlag: 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";
+        shortFlag: 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";
+    };
+    includeNodeModules: {
+        type: "boolean";
+        default: false;
+    };
 }>;
 export type CLIOptions = ReadonlyDeep<typeof cli.flags>;

package/lib/cli/bootstrap.js

@@ -1,9 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cli = exports.help = void 0;
-const tslib_1 = require("tslib");
-const meow_1 = tslib_1.__importDefault(require("meow"));
-exports.help = `
+import meow from 'meow';
+export const help = `
 Usage
 	$ markuplint <HTML file paths (glob format)>
 	$ <stdout> | markuplint
@@ -21,9 +17,9 @@ Options
 	--allow-warnings                       Return status code 0 even if there are warnings.
 	--allow-empty-input                    Return status code 1 even if there are no input files.
 	--verbose                              Output with detailed information.
+	--include-node-modules                 Include files in node_modules directory. Default: false.
 
 	--init                                 Initialize settings interactively.
-	--create-rule                          Add the scaffold of a custom rule.
 	--search                               Search lines of codes that include the target element by selectors.
 
 	--help,                  -h            Show help.
@@ -33,11 +29,12 @@ Examples
 	$ markuplint verifyee.html --config path/to/.markuplintrc
 	$ cat verifyee.html | markuplint
 `;
-exports.cli = (0, meow_1.default)(exports.help, {
+export const cli = meow(help, {
+    importMeta: import.meta,
     flags: {
         config: {
             type: 'string',
-            alias: 'c',
+            shortFlag: 'c',
         },
         fix: {
             type: 'boolean',
@@ -45,7 +42,7 @@ exports.cli = (0, meow_1.default)(exports.help, {
         },
         format: {
             type: 'string',
-            alias: 'f',
+            shortFlag: 'f',
         },
         searchConfig: {
             type: 'boolean',
@@ -68,7 +65,7 @@ exports.cli = (0, meow_1.default)(exports.help, {
         },
         problemOnly: {
             type: 'boolean',
-            alias: 'p',
+            shortFlag: 'p',
             default: false,
         },
         allowWarnings: {
@@ -95,5 +92,9 @@ exports.cli = (0, meow_1.default)(exports.help, {
         search: {
             type: 'string',
         },
+        includeNodeModules: {
+            type: 'boolean',
+            default: false,
+        },
     },
 });

package/lib/cli/command.d.ts

@@ -1,8 +1,4 @@
-import type { CLIOptions } from './bootstrap';
-import type { APIOptions } from '../api/types';
+import type { CLIOptions } from './bootstrap.js';
+import type { APIOptions } from '../api/types.js';
 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/command.js

@@ -1,38 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.command = void 0;
-const tslib_1 = require("tslib");
-const fs_1 = require("fs");
-const path_1 = tslib_1.__importDefault(require("path"));
-const file_resolver_1 = require("@markuplint/file-resolver");
-const api_1 = require("../api");
-const debug_1 = require("../debug");
-const output_1 = require("./output");
-async function command(files, options, apiOptions) {
-    var _a;
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+import { resolveFiles } from '@markuplint/file-resolver';
+import { MLEngine } from '../api/index.js';
+import { log } from '../debug.js';
+import { output } from './output.js';
+export async function command(files, options, apiOptions) {
     const fix = options.fix;
-    const configFile = options.config && path_1.default.join(process.cwd(), options.config);
+    const configFile = options.config && path.join(process.cwd(), options.config);
     const locale = options.locale;
     const searchConfig = options.searchConfig;
     const ignoreExt = options.ignoreExt;
     const importPresetRules = options.importPresetRules;
     const verbose = options.verbose;
-    const fileList = await (0, file_resolver_1.resolveFiles)(files);
+    const ignoreGlob = options.includeNodeModules ? undefined : 'node_modules/**';
+    const fileList = await resolveFiles(files, ignoreGlob);
     if (fileList.length === 0 && !options.allowEmptyInput) {
         process.stderr.write('Markuplint: No target files.\n');
         // Error
         return true;
     }
-    if (debug_1.log.enabled) {
-        (0, debug_1.log)('File list: %O', fileList.map(f => f.path));
-        (0, debug_1.log)('Config: %s', configFile !== null && configFile !== void 0 ? configFile : 'N/A');
-        (0, debug_1.log)('Fix option: %s', fix);
+    if (log.enabled) {
+        log('File list: %O', fileList.map(f => f.path));
+        log('Config: %s', configFile ?? 'N/A');
+        log('Fix option: %s', fix);
     }
-    const format = (_a = options.format) === null || _a === void 0 ? void 0 : _a.toLowerCase().trim();
+    const format = options.format?.toLowerCase().trim();
     let hasError = false;
     const jsonOutput = [];
     for (const file of fileList) {
-        const engine = new api_1.MLEngine(file, {
+        const engine = new MLEngine(file, {
             configFile,
             fix,
             locale,
@@ -52,21 +48,18 @@ async function command(files, options, apiOptions) {
             hasError = true;
         }
         if (fix) {
-            (0, debug_1.log)('Overwrite file: %s', result.filePath);
-            await fs_1.promises.writeFile(result.filePath, result.fixedCode, { encoding: 'utf8' });
-            process.stdout.write(`markuplint: Fix "${result.filePath}"\n`);
+            log('Overwrite file: %s', result.filePath);
+            await fs.writeFile(result.filePath, result.fixedCode, { encoding: 'utf8' });
         }
-        else {
-            if (format === 'json') {
-                jsonOutput.push(...result.violations.map(v => ({
-                    ...v,
-                    filePath: result.filePath,
-                })));
-                continue;
-            }
-            (0, debug_1.log)('Output reports');
-            (0, output_1.output)(result, options);
+        if (format === 'json') {
+            jsonOutput.push(...result.violations.map(v => ({
+                ...v,
+                filePath: result.filePath,
+            })));
+            continue;
         }
+        log('Output reports');
+        output(result, options);
     }
     if (format === 'json') {
         process.stdout.write(JSON.stringify(jsonOutput, null, 2) + '\n');
@@ -74,4 +67,3 @@ async function command(files, options, apiOptions) {
     }
     return hasError;
 }
-exports.command = command;

package/lib/cli/index.js

@@ -1,78 +1,66 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const get_stdin_1 = tslib_1.__importDefault(require("get-stdin"));
-const debug_1 = require("../debug");
-const bootstrap_1 = require("./bootstrap");
-const command_1 = require("./command");
-const create_rule_1 = require("./create-rule");
-const init_1 = require("./init");
-const search_1 = tslib_1.__importDefault(require("./search"));
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
-(async () => {
-    if (bootstrap_1.cli.flags.v) {
-        bootstrap_1.cli.showVersion(); // And exit successfully.
-    }
-    if (bootstrap_1.cli.flags.h) {
-        bootstrap_1.cli.showHelp(0); // And exit successfully.
-    }
-    if (bootstrap_1.cli.flags.verbose) {
-        (0, debug_1.verbosely)();
-    }
-    if (bootstrap_1.cli.flags.init) {
-        await (0, init_1.initialize)().catch(err => {
-            process.stderr.write(err + '\n');
-            process.exit(1);
-        });
-        return;
-    }
-    if (bootstrap_1.cli.flags.createRule) {
-        await (0, create_rule_1.createRule)().catch(err => {
-            process.stderr.write(err + '\n');
-            process.exit(1);
-        });
-        return;
-    }
-    const files = bootstrap_1.cli.input;
-    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');
-                process.exit(1);
-            });
-            return;
-        }
-        const hasError = await (0, command_1.command)(files, bootstrap_1.cli.flags).catch(err => {
-            throw err;
-        });
-        process.exit(hasError ? 1 : 0);
-    }
-    if (usePipe()) {
-        (0, get_stdin_1.default)()
-            .then(async (stdin) => {
-            if (stdin) {
-                const hasError = await (0, command_1.command)([{ sourceCode: stdin }], {
-                    ...bootstrap_1.cli.flags,
-                    ignoreExt: true,
-                }).catch(err => {
-                    process.stderr.write(err + '\n');
-                    process.exit(1);
-                });
-                process.exit(hasError ? 1 : 0);
-            }
-            // result is empty
-            bootstrap_1.cli.showHelp(1);
-        })
-            .catch(reason => {
-            // eslint-disable-next-line no-console
-            console.warn(reason);
+import getStdin from 'get-stdin';
+import { verbosely } from '../debug.js';
+import { cli } from './bootstrap.js';
+import { command } from './command.js';
+import { initialize } from './init/index.js';
+import { search } from './search/index.js';
+/* eslint-disable unicorn/no-process-exit */
+if (cli.flags.v) {
+    cli.showVersion(); // And exit successfully.
+}
+if (cli.flags.h) {
+    cli.showHelp(0); // And exit successfully.
+}
+if (cli.flags.verbose) {
+    verbosely();
+}
+if (cli.flags.init) {
+    await initialize().catch(error => {
+        process.stderr.write(error + '\n');
+        process.exit(1);
+    });
+    process.exit(0);
+}
+if (cli.flags.createRule) {
+    process.stderr.write("Use to run 'npx @markuplint/create-rule' instead of 'markuplint --create-rule'.\n");
+    process.exit(1);
+}
+const files = cli.input;
+if (files.length > 0) {
+    if (cli.flags.search) {
+        await search(files, cli.flags, cli.flags.search).catch(error => {
+            process.stderr.write(error + '\n');
             process.exit(1);
         });
+        process.exit(0);
     }
-    else {
-        bootstrap_1.cli.showHelp(1);
+    const hasError = await command(files, cli.flags).catch(error => {
+        throw error;
+    });
+    process.exit(hasError ? 1 : 0);
+}
+if (usePipe()) {
+    const stdin = await getStdin().catch(error => {
+        // eslint-disable-next-line no-console
+        console.warn(error);
+        process.exit(1);
+    });
+    if (!stdin) {
+        // result is empty
+        cli.showHelp(1);
     }
-})();
+    const hasError = await command([{ sourceCode: stdin }], {
+        ...cli.flags,
+        ignoreExt: true,
+    }).catch(error => {
+        process.stderr.write(error + '\n');
+        process.exit(1);
+    });
+    process.exit(hasError ? 1 : 0);
+}
+// No arguments
+cli.showHelp(1);
+/* eslint-enable unicorn/no-process-exit */
 function usePipe() {
     return !process.stdin.isTTY && process.stdout.isTTY;
 }

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

@@ -1,8 +1,4 @@
-import type { DefaultRules, Langs, RuleSettingMode } from './types';
+import type { DefaultRules, Langs, RuleSettingMode } from './types.js';
 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;