markuplint 3.0.0-dev.24 → 3.0.0-dev.290

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
@@ -9,43 +9,43 @@ export declare function lint_v1(options: {
     /**
      * Glob pattern
      */
-    files?: string | string[];
+    readonly files?: string | readonly string[];
     /**
      * Target source code of evaluation
      */
-    sourceCodes?: string | string[];
+    readonly sourceCodes?: string | readonly string[];
     /**
      * File names when `sourceCodes`
      */
-    names?: string | string[];
+    readonly names?: string | readonly string[];
     /**
      * Workspace path when `sourceCodes`
      */
-    workspace?: string;
+    readonly workspace?: string;
     /**
      * Configure file or object
      */
-    config?: string | Config;
+    readonly config?: string | Config;
     /**
      * The config applied when not resolved from files or set it explicitly.
      */
-    defaultConfig?: Config;
+    readonly defaultConfig?: Config;
     /**
      * Rules (default: `@markuplint/rules`)
      */
-    rules?: MLRule<RuleConfigValue, unknown>[];
+    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
      */
-    rulesAutoResolve?: boolean;
+    readonly rulesAutoResolve?: boolean;
     /**
      * Auto fix
      */
-    fix?: boolean;
+    readonly fix?: boolean;
     /**
      * Locale
      */
-    locale?: string;
-}): Promise<import("..").MLResultInfo[]>;
+    readonly locale?: string;
+}): Promise<import("../types.js").MLResultInfo[]>;

package/lib/api/v1.js

@@ -1,30 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.lint_v1 = void 0;
-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 = options.files ? (Array.isArray(options.files) ? options.files : [options.files]) : [];
-    const codes = options.sourceCodes
-        ? Array.isArray(options.sourceCodes)
-            ? options.sourceCodes
-            : [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;
@@ -34,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: !options.files,
+        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,9 +1,9 @@
-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 cli: meow.Result<{
+import type { ReadonlyDeep } from 'type-fest';
+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: import("meow").Result<{
     config: {
         type: "string";
-        alias: string;
+        shortFlag: string;
     };
     fix: {
         type: "boolean";
@@ -11,7 +11,7 @@ export declare const cli: meow.Result<{
     };
     format: {
         type: "string";
-        alias: string;
+        shortFlag: string;
     };
     searchConfig: {
         type: "boolean";
@@ -34,9 +34,17 @@ export declare const cli: meow.Result<{
     };
     problemOnly: {
         type: "boolean";
-        alias: string;
+        shortFlag: string;
         default: false;
     };
+    allowWarnings: {
+        type: "boolean";
+        default: false;
+    };
+    allowEmptyInput: {
+        type: "boolean";
+        default: true;
+    };
     verbose: {
         type: "boolean";
         default: false;
@@ -53,4 +61,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

@@ -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
@@ -11,13 +7,15 @@ 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.
 	--locale                               Locale of the message of violation. Default is an OS setting.
 	--no-color,                            Output no color.
 	--problem-only,          -p            Output only problems, without passeds.
+	--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.
 
 	--init                                 Initialize settings interactively.
@@ -31,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',
@@ -43,7 +42,7 @@ exports.cli = (0, meow_1.default)(exports.help, {
         },
         format: {
             type: 'string',
-            alias: 'f',
+            shortFlag: 'f',
         },
         searchConfig: {
             type: 'boolean',
@@ -66,9 +65,18 @@ exports.cli = (0, meow_1.default)(exports.help, {
         },
         problemOnly: {
             type: 'boolean',
-            alias: 'p',
+            shortFlag: 'p',
             default: false,
         },
+        allowWarnings: {
+            type: 'boolean',
+            // TODO: It will be changed to `true` in the next major version.
+            default: false,
+        },
+        allowEmptyInput: {
+            type: 'boolean',
+            default: true,
+        },
         verbose: {
             type: 'boolean',
             default: false,

package/lib/cli/command.d.ts

@@ -1,4 +1,4 @@
-import type { APIOptions } from '../api/types';
-import type { CLIOptions } from './bootstrap';
+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: 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,33 +1,33 @@
-"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);
-    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)('Fix option: %s', fix);
+    const fileList = await resolveFiles(files);
+    if (fileList.length === 0 && !options.allowEmptyInput) {
+        process.stderr.write('Markuplint: No target files.\n');
+        // Error
+        return true;
     }
-    const format = (_a = options.format) === null || _a === void 0 ? void 0 : _a.toLowerCase().trim();
+    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 = 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,
@@ -41,12 +41,14 @@ async function command(files, options, apiOptions) {
         if (!result) {
             continue;
         }
-        if (!hasError && result.violations.length) {
+        const errorCount = result.violations.filter(v => v.severity === 'error').length;
+        const warningCount = result.violations.filter(v => v.severity === 'warning').length;
+        if (!hasError && (errorCount > 0 || (warningCount > 0 && !options.allowWarnings))) {
             hasError = true;
         }
         if (fix) {
-            (0, debug_1.log)('Overwrite file: %s', result.filePath);
-            await fs_1.promises.writeFile(result.filePath, result.fixedCode, { encoding: 'utf8' });
+            log('Overwrite file: %s', result.filePath);
+            await fs.writeFile(result.filePath, result.fixedCode, { encoding: 'utf8' });
             process.stdout.write(`markuplint: Fix "${result.filePath}"\n`);
         }
         else {
@@ -57,8 +59,8 @@ async function command(files, options, apiOptions) {
                 })));
                 continue;
             }
-            (0, debug_1.log)('Output reports');
-            (0, output_1.output)(result, options);
+            log('Output reports');
+            output(result, options);
         }
     }
     if (format === 'json') {
@@ -67,4 +69,3 @@ async function command(files, options, apiOptions) {
     }
     return hasError;
 }
-exports.command = command;

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

@@ -1,65 +1,79 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRule = void 0;
-const tslib_1 = require("tslib");
-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");
-async function createRule() {
-    (0, util_1.write)((0, util_1.head)('Create a rule'));
-    util_1.write.break();
+import { resolve } from 'node:path';
+import { isMarkuplintRepo, createRuleHelper } from '@markuplint/create-rule-helper';
+import c from 'cli-color';
+import { write, head } from '../../util.js';
+import { installModule } from '../init/install-module.js';
+import { input, select, confirm } from '../prompt.js';
+const icons = {
+    README: '📝',
+    index: '📜',
+    schema: '⚙️ ',
+    package: '🎁',
+    tsconfig: '💎',
+};
+export async function createRule() {
+    write(head('Create a rule'));
+    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)()) {
+    if (await isMarkuplintRepo()) {
         firstChoices.push({ name: 'Contribute the new rule to markuplint core rules', value: 'CONTRIBUTE_TO_CORE' });
     }
-    const purpose = await (0, prompt_1.select)({
+    const purpose = await select({
         message: 'What purpose do you create the rule for?',
         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 input(dirQuestion, /^[a-z][a-z0-9]*(?:-[a-z][a-z0-9]*)*$/i);
+    const ruleName = await 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 input('Description:'),
+            category: await 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 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)({
+        : await select({
             message: 'Which language will you implement?',
             choices: [
                 { name: 'TypeScript', value: 'TYPESCRIPT' },
                 { name: 'JavaScript', value: 'JAVASCRIPT' },
             ],
         });
-    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.rules) {
-        output(name, '🛡 ', 'rules', result.rules);
+    const needTest = purpose === 'CONTRIBUTE_TO_CORE' ? true : await confirm('Do you need the test?', { initial: true });
+    const result = await createRuleHelper({ purpose, pluginName, ruleName, lang, needTest, core });
+    for (const file of result.files) {
+        output(pluginName || 'core', file.test ? '🖍 ' : icons[file.name] ?? '🛡 ', file.fileName, resolve(file.destDir, file.fileName + file.ext));
     }
-    if (result.rulesTest) {
-        output(name, '🖍 ', 'rules.spec', result.rulesTest);
+    if (result.dependencies.length > 0) {
+        await installModule(result.dependencies);
     }
-    if (result.schemaJson) {
-        output(name, '⚙️ ', 'schema.json', result.schemaJson);
-    }
-    if (result.packageJson) {
-        output(name, '🎁', 'package.json', result.packageJson);
-        if (result.tsConfig) {
-            output(name, '💎', 'tsconfig.json', result.tsConfig);
-        }
-        await (0, install_module_1.installModule)(result.dependencies);
-        await (0, install_module_1.installModule)(result.devDependencies, true);
+    if (result.devDependencies.length > 0) {
+        await installModule(result.devDependencies, true);
     }
 }
-exports.createRule = createRule;
 function output(name, icon, title, path) {
-    const _marker = cli_color_1.default.xterm(39)('✔') + ' ';
-    const _title = (icon, title) => `${icon} ` + cli_color_1.default.bold(`${name}/${title}`);
-    const _file = (path) => ' ' + cli_color_1.default.cyanBright(path);
-    (0, util_1.write)(_marker + _title(icon, title) + _file(path));
+    const _marker = c.xterm(39)('✔') + ' ';
+    const _title = (icon, title) => `${icon} ` + c.bold(`${name}/${title}`);
+    const _file = (path) => ' ' + c.cyanBright(path);
+    write(_marker + _title(icon, title) + _file(path));
 }

package/lib/cli/index.js

@@ -1,59 +1,55 @@
-"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"));
+import getStdin from 'get-stdin';
+import { verbosely } from '../debug.js';
+import { cli } from './bootstrap.js';
+import { command } from './command.js';
+import { createRule } from './create-rule/index.js';
+import { initialize } from './init/index.js';
+import search from './search/index.js';
 // eslint-disable-next-line @typescript-eslint/no-floating-promises
 (async () => {
-    if (bootstrap_1.cli.flags.v) {
-        bootstrap_1.cli.showVersion(); // And exit successfully.
+    if (cli.flags.v) {
+        cli.showVersion(); // And exit successfully.
     }
-    if (bootstrap_1.cli.flags.h) {
-        bootstrap_1.cli.showHelp(0); // And exit successfully.
+    if (cli.flags.h) {
+        cli.showHelp(0); // And exit successfully.
     }
-    if (bootstrap_1.cli.flags.verbose) {
-        (0, debug_1.verbosely)();
+    if (cli.flags.verbose) {
+        verbosely();
     }
-    if (bootstrap_1.cli.flags.init) {
-        await (0, init_1.initialize)().catch(err => {
+    if (cli.flags.init) {
+        await 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 => {
+    if (cli.flags.createRule) {
+        await createRule().catch(err => {
             process.stderr.write(err + '\n');
             process.exit(1);
         });
         return;
     }
-    const files = bootstrap_1.cli.input;
-    if (files.length) {
-        if (bootstrap_1.cli.flags.search) {
-            await (0, search_1.default)(files, bootstrap_1.cli.flags, bootstrap_1.cli.flags.search).catch(err => {
+    const files = cli.input;
+    if (files.length > 0) {
+        if (cli.flags.search) {
+            await search(files, cli.flags, 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 => {
+        const hasError = await command(files, cli.flags).catch(err => {
             throw err;
-            // process.exit(1);
         });
         process.exit(hasError ? 1 : 0);
     }
     if (usePipe()) {
-        (0, get_stdin_1.default)()
+        getStdin()
             .then(async (stdin) => {
             if (stdin) {
-                const hasError = await (0, command_1.command)([{ sourceCode: stdin }], {
-                    ...bootstrap_1.cli.flags,
+                const hasError = await command([{ sourceCode: stdin }], {
+                    ...cli.flags,
                     ignoreExt: true,
                 }).catch(err => {
                     process.stderr.write(err + '\n');
@@ -62,7 +58,7 @@ const search_1 = tslib_1.__importDefault(require("./search"));
                 process.exit(hasError ? 1 : 0);
             }
             // result is empty
-            bootstrap_1.cli.showHelp(1);
+            cli.showHelp(1);
         })
             .catch(reason => {
             // eslint-disable-next-line no-console
@@ -71,7 +67,7 @@ const search_1 = tslib_1.__importDefault(require("./search"));
         });
     }
     else {
-        bootstrap_1.cli.showHelp(1);
+        cli.showHelp(1);
     }
 })();
 function usePipe() {

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

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