markuplint 4.0.0-alpha.2 → 4.0.0-dev.28

package/lib/api/ml-engine.js

@@ -1,5 +1,15 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
 var _MLEngine_configProvider, _MLEngine_core, _MLEngine_file, _MLEngine_options, _MLEngine_watcher;
-import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
 import { ConfigProvider, resolveFiles, resolveParser, resolveRules, resolveSpecs } from '@markuplint/file-resolver';
 import { MLCore, convertRuleset } from '@markuplint/ml-core';
 import { FSWatcher } from 'chokidar';
@@ -11,6 +21,10 @@ const fileLog = log.extend('file');
 const configLog = log.extend('config');
 class MLEngine extends Emitter {
     static async fromCode(sourceCode, options) {
+        if (options?.debug) {
+            verbosely();
+        }
+        log('[fromCode] Creates: %O', options);
         const file = await MLEngine.toMLFile({
             sourceCode,
             name: options?.name,
@@ -19,7 +33,9 @@ class MLEngine extends Emitter {
         if (!file) {
             throw new Error('Never reach error');
         }
-        return new MLEngine(file, options);
+        log('[fromCode] Created file: %s', file.path);
+        const engine = new MLEngine(file, options);
+        return engine;
     }
     static async toMLFile(target) {
         const files = await resolveFiles([target]);
@@ -32,13 +48,14 @@ class MLEngine extends Emitter {
         _MLEngine_file.set(this, void 0);
         _MLEngine_options.set(this, void 0);
         _MLEngine_watcher.set(this, new FSWatcher());
+        if (__classPrivateFieldGet(this, _MLEngine_options, "f")?.debug) {
+            verbosely();
+        }
         __classPrivateFieldSet(this, _MLEngine_file, file, "f");
         __classPrivateFieldSet(this, _MLEngine_options, options, "f");
         __classPrivateFieldSet(this, _MLEngine_configProvider, new ConfigProvider(), "f");
         this.watchMode(!!__classPrivateFieldGet(this, _MLEngine_options, "f")?.watch);
-        if (__classPrivateFieldGet(this, _MLEngine_options, "f")?.debug) {
-            verbosely();
-        }
+        log('[MLEngine] Initialized: %s', __classPrivateFieldGet(this, _MLEngine_file, "f").path);
     }
     get document() {
         if (__classPrivateFieldGet(this, _MLEngine_core, "f")?.document instanceof Error) {
@@ -57,11 +74,11 @@ class MLEngine extends Emitter {
             log('exec: cancel (unsetuped yet)');
             return null;
         }
-        const violations = await core.verify(__classPrivateFieldGet(this, _MLEngine_options, "f")?.fix).catch(e => {
-            if (e instanceof Error) {
-                return e;
+        const violations = await core.verify(__classPrivateFieldGet(this, _MLEngine_options, "f")?.fix).catch(error => {
+            if (error instanceof Error) {
+                return error;
             }
-            throw e;
+            throw error;
         });
         const sourceCode = await __classPrivateFieldGet(this, _MLEngine_file, "f").getCode();
         const fixedCode = core.document.toString();
@@ -225,12 +242,16 @@ class MLEngine extends Emitter {
         };
     }
     async resolveConfig(cache) {
+        this.emit('log', 'resolveConfig', JSON.stringify(__classPrivateFieldGet(this, _MLEngine_configProvider, "f"), null, 2));
+        configLog('configProvider: %s', __classPrivateFieldGet(this, _MLEngine_configProvider, "f"));
         const defaultConfigKey = __classPrivateFieldGet(this, _MLEngine_options, "f")?.defaultConfig && __classPrivateFieldGet(this, _MLEngine_configProvider, "f").set(__classPrivateFieldGet(this, _MLEngine_options, "f")?.defaultConfig);
         configLog('defaultConfigKey: %s', defaultConfigKey ?? 'N/A');
         this.emit('log', 'defaultConfigKey', defaultConfigKey ?? 'N/A');
+        const targetConfig = await __classPrivateFieldGet(this, _MLEngine_configProvider, "f").search(__classPrivateFieldGet(this, _MLEngine_file, "f"));
+        this.emit('log', 'targetConfig', targetConfig ?? 'N/A');
         const configFilePathsFromTarget = __classPrivateFieldGet(this, _MLEngine_options, "f")?.noSearchConfig
             ? defaultConfigKey ?? null
-            : (await __classPrivateFieldGet(this, _MLEngine_configProvider, "f").search(__classPrivateFieldGet(this, _MLEngine_file, "f"))) ?? defaultConfigKey;
+            : targetConfig ?? defaultConfigKey;
         configLog('configFilePathsFromTarget: %s', configFilePathsFromTarget ?? 'N/A');
         this.emit('log', 'configFilePathsFromTarget', configFilePathsFromTarget ?? 'N/A');
         const configKey = __classPrivateFieldGet(this, _MLEngine_options, "f")?.config && __classPrivateFieldGet(this, _MLEngine_configProvider, "f").set(__classPrivateFieldGet(this, _MLEngine_options, "f").config);
@@ -248,7 +269,7 @@ class MLEngine extends Emitter {
         this.emit('config', __classPrivateFieldGet(this, _MLEngine_file, "f").path, configSet);
         if (__classPrivateFieldGet(this, _MLEngine_options, "f")?.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.
-            __classPrivateFieldGet(this, _MLEngine_watcher, "f").add(Array.from(configSet.files));
+            __classPrivateFieldGet(this, _MLEngine_watcher, "f").add([...configSet.files]);
         }
         return configSet;
     }

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

@@ -26,8 +26,8 @@ export async function createRule() {
         choices: firstChoices,
     });
     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 pluginName = purpose === 'CONTRIBUTE_TO_CORE' ? '' : await input(dirQuestion, /^[a-z][\da-z]*(?:-[a-z][\da-z]*)*$/i);
+    const ruleName = await input('What is the rule name?', /^[a-z][\da-z]*(?:-[a-z][\da-z]*)*$/i);
     const core = purpose === 'CONTRIBUTE_TO_CORE'
         ? {
             description: await input('Description:'),

package/lib/cli/index.js

@@ -5,71 +5,66 @@ 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 (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(err => {
-            process.stderr.write(err + '\n');
-            process.exit(1);
-        });
-        return;
-    }
-    if (cli.flags.createRule) {
-        await createRule().catch(err => {
-            process.stderr.write(err + '\n');
-            process.exit(1);
-        });
-        return;
-    }
-    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 command(files, cli.flags).catch(err => {
-            throw err;
-        });
-        process.exit(hasError ? 1 : 0);
-    }
-    if (usePipe()) {
-        getStdin()
-            .then(async (stdin) => {
-            if (stdin) {
-                const hasError = await command([{ sourceCode: stdin }], {
-                    ...cli.flags,
-                    ignoreExt: true,
-                }).catch(err => {
-                    process.stderr.write(err + '\n');
-                    process.exit(1);
-                });
-                process.exit(hasError ? 1 : 0);
-            }
-            // result is empty
-            cli.showHelp(1);
-        })
-            .catch(reason => {
-            // eslint-disable-next-line no-console
-            console.warn(reason);
+/* 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) {
+    await createRule().catch(error => {
+        process.stderr.write(error + '\n');
+        process.exit(1);
+    });
+    process.exit(0);
+}
+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 {
+    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/index.js

@@ -59,12 +59,12 @@ export async function initialize() {
     }
     const config = createConfig(selectedLangs, ruleSettingMode, defaultRules);
     const filePath = path.resolve(process.cwd(), '.markuplintrc');
-    await writeFile(filePath, JSON.stringify(config, null, 2), { encoding: 'utf-8' });
+    await writeFile(filePath, JSON.stringify(config, null, 2), { encoding: 'utf8' });
     write(`✨Created: ${filePath}`);
     if (autoInstall) {
         write('Install automatically');
         const modules = selectModules(selectedLangs);
-        const result = await installModule(modules, true).catch(e => new Error(e));
+        const result = await installModule(modules, true).catch(error_ => new Error(error_));
         if (result instanceof Error) {
             error.exit();
             return;

package/lib/cli/init/install-module.js

@@ -24,7 +24,7 @@ export async function installModule(module, dev = false) {
             }
         }
     }
-    catch (_) {
+    catch {
         // void
     }
     if (uninstallMods.length === 0) {
@@ -67,8 +67,8 @@ function isInstalled(module) {
                 resolve(exists);
             });
         }
-        catch (err) {
-            reject(err);
+        catch (error) {
+            reject(error);
         }
     });
 }

package/lib/cli/search/index.js

@@ -14,7 +14,7 @@ export default async function (files, options, selectors) {
                 ...createRule({
                     verify({ document }) {
                         const nodes = document.querySelectorAll(selectors);
-                        locations.push(...Array.from(nodes).map(node => {
+                        locations.push(...[...nodes].map(node => {
                             return {
                                 file: document.filename ?? '_NO_FILE_',
                                 line: node.startLine,
@@ -31,7 +31,7 @@ export default async function (files, options, selectors) {
             },
         },
     });
-    locations.forEach(loc => {
+    for (const loc of locations) {
         process.stdout.write(`${loc.file}:${loc.line}:${loc.col}\n`);
-    });
+    }
 }

package/lib/debug.js

@@ -3,8 +3,9 @@ import debug from 'debug';
 export const log = debug('markuplint-cli');
 export function verbosely() {
     if (!log.enabled) {
-        debug.enable(`${log.namespace}*`);
-        log(`Debug enable: ${log.namespace}`);
+        const namespace = `${log.namespace}*,ml-*`;
+        debug.enable(namespace);
+        log(`[Debug] Enable: "${namespace}"`);
     }
     enableDebug();
 }

package/lib/get-json-module.js

@@ -4,7 +4,7 @@ export function getJsonModule(modulePath) {
     try {
         return require(modulePath);
     }
-    catch (_) {
+    catch {
         return null;
     }
 }

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 export { MLEngine, FromCodeOptions } from './api/index.js';
+export { MLEngineEventMap } from './api/types.js';
 export * from './i18n.js';
 export * from './testing-tool/index.js';
 export * from './types.js';

package/lib/reporter/github-reporter.js

@@ -10,10 +10,12 @@ export function githubReporter(results) {
 }
 function severityToCommand(severity) {
     switch (severity) {
-        case 'info':
+        case 'info': {
             return 'notice';
+        }
         case 'error':
-        case 'warning':
+        case 'warning': {
             return severity;
+        }
     }
 }

package/lib/reporter/standard-reporter.js

@@ -21,8 +21,8 @@ export function standardReporter(results, options) {
             const prev = lines[violation.line - 2] ?? '';
             const line = lines[violation.line - 1] ?? '';
             const next = lines[violation.line - 0] ?? '';
-            const before = line.substring(0, violation.col - 1);
-            const after = line.substring(violation.col - 1 + violation.raw.length);
+            const before = line.slice(0, Math.max(0, violation.col - 1));
+            const after = line.slice(Math.max(0, violation.col - 1 + violation.raw.length));
             const logger = violation.severity === 'error' ? loggerError : loggerWarning;
             const meg = messageToString(violation.message, violation.reason);
             out.push(`<${markuplint}> ${logger(`${violation.severity}: ${meg} (${violation.ruleId}) ${c.underline(`${results.filePath}:${violation.line}:${violation.col}`)}`)}`);

package/lib/testing-tool/index.js

@@ -18,38 +18,40 @@ export async function mlTest(sourceCode, config, rules, locale = 'en', fix = fal
         fixedCode: result?.fixedCode ?? sourceCode,
     };
 }
-export async function mlRuleTest(rule, sourceCode, config = { rule: true }, fix = false, locale = 'en') {
+export async function mlRuleTest(rule, sourceCode, 
+// eslint-disable-next-line unicorn/no-object-as-default-parameter
+config = { rule: true }, fix = false, locale = 'en') {
     const _config = {
         ...config,
-        rules: config.rule !== undefined
-            ? {
-                '<current-rule>': config.rule,
-            }
-            : config.rule === undefined && config.nodeRule === undefined && config.childNodeRule === undefined
+        rules: config.rule === undefined
+            ? config.rule === undefined && config.nodeRule === undefined && config.childNodeRule === undefined
                 ? {
                     '<current-rule>': true,
                 }
-                : undefined,
-        nodeRules: config.nodeRule !== undefined
-            ? config.nodeRule.map(nodeConfig => ({
+                : undefined
+            : {
+                '<current-rule>': config.rule,
+            },
+        nodeRules: config.nodeRule === undefined
+            ? undefined
+            : config.nodeRule.map(nodeConfig => ({
                 ...nodeConfig,
-                rules: nodeConfig.rule !== undefined
-                    ? {
+                rules: nodeConfig.rule === undefined
+                    ? undefined
+                    : {
                         '<current-rule>': nodeConfig.rule,
-                    }
-                    : undefined,
-            }))
-            : undefined,
-        childNodeRules: config.childNodeRule !== undefined
-            ? config.childNodeRule.map(childNodeConfig => ({
+                    },
+            })),
+        childNodeRules: config.childNodeRule === undefined
+            ? undefined
+            : config.childNodeRule.map(childNodeConfig => ({
                 ...childNodeConfig,
-                rules: childNodeConfig.rule !== undefined
-                    ? {
+                rules: childNodeConfig.rule === undefined
+                    ? undefined
+                    : {
                         '<current-rule>': childNodeConfig.rule,
-                    }
-                    : undefined,
-            }))
-            : undefined,
+                    },
+            })),
     };
     const res = await mlTest(sourceCode, _config, [
         new MLRule({

package/lib/util.js

@@ -43,6 +43,7 @@ write.break = () => process.stdout.write('\n');
 export function error(message) {
     process.stderr.write(message + '\n');
 }
+// eslint-disable-next-line unicorn/no-process-exit
 error.exit = () => process.exit(1);
 export const head = (method, noColor) => box([`${logo} ${markuplint}`, c.blackBright(`v${version}`), '', c.bold(method)], {
     center: true,
@@ -55,18 +56,18 @@ export function p(s, pad, start = false) {
     return start ? `${_}${s}` : `${s}${_}`;
 }
 export function w(s) {
-    return s.replace(/./g, _ => '0'.repeat(eaw.characterLength(_))).length;
+    return s.replaceAll(/./g, _ => '0'.repeat(eaw.characterLength(_))).length;
 }
 export function space(str) {
     return str
-        .replace(/\s+/g, $0 => {
+        .replaceAll(/\s+/g, $0 => {
         return c.xterm(8)($0);
     })
-        .replace(/ /g, $0 => '•')
-        .replace(/\t/g, $0 => '→   ');
+        .replaceAll(' ', $0 => '•')
+        .replaceAll('\t', $0 => '→   ');
 }
 export function invisibleSpace(str) {
-    return str.replace(/\t/g, $0 => '    ').replace(/./g, $0 => ' ');
+    return str.replaceAll('\t', $0 => '    ').replaceAll(/./g, $0 => ' ');
 }
 export function messageToString(message, reason) {
     if (!reason) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "markuplint",
-	"version": "4.0.0-alpha.2",
+	"version": "4.0.0-dev.28+0131de5e",
 	"description": "An HTML linter for all markup developers",
 	"author": "Yusuke Hirao",
 	"license": "MIT",
@@ -24,26 +24,21 @@
 		"dev": "tsc --build --watch",
 		"clean": "tsc --build --clean"
 	},
-	"devDependencies": {
-		"execa": "^8.0.1"
-	},
 	"dependencies": {
-		"@markuplint/create-rule-helper": "4.0.0-alpha.2",
-		"@markuplint/file-resolver": "4.0.0-alpha.2",
-		"@markuplint/html-parser": "4.0.0-alpha.2",
-		"@markuplint/html-spec": "4.0.0-alpha.2",
-		"@markuplint/i18n": "4.0.0-alpha.2",
-		"@markuplint/ml-ast": "4.0.0-alpha.2",
-		"@markuplint/ml-config": "4.0.0-alpha.2",
-		"@markuplint/ml-core": "4.0.0-alpha.2",
-		"@markuplint/ml-spec": "4.0.0-alpha.2",
-		"@markuplint/rules": "4.0.0-alpha.2",
-		"@markuplint/shared": "4.0.0-alpha.2",
-		"@types/cli-color": "^2.0.3",
-		"@types/debug": "^4.1.9",
-		"@types/has-yarn": "^1.0.1",
-		"@types/meow": "^6.0.0",
-		"@types/uuid": "^9.0.4",
+		"@markuplint/create-rule-helper": "4.0.0-dev.28+0131de5e",
+		"@markuplint/file-resolver": "4.0.0-dev.28+0131de5e",
+		"@markuplint/html-parser": "4.0.0-dev.28+0131de5e",
+		"@markuplint/html-spec": "4.0.0-dev.28+0131de5e",
+		"@markuplint/i18n": "4.0.0-dev.28+0131de5e",
+		"@markuplint/ml-ast": "4.0.0-dev.28+0131de5e",
+		"@markuplint/ml-config": "4.0.0-dev.28+0131de5e",
+		"@markuplint/ml-core": "4.0.0-dev.28+0131de5e",
+		"@markuplint/ml-spec": "4.0.0-dev.28+0131de5e",
+		"@markuplint/rules": "4.0.0-dev.28+0131de5e",
+		"@markuplint/shared": "4.0.0-dev.28+0131de5e",
+		"@types/cli-color": "^2.0.4",
+		"@types/debug": "^4.1.10",
+		"@types/uuid": "^9.0.6",
 		"chokidar": "^3.5.3",
 		"cli-color": "^2.0.3",
 		"debug": "^4.3.4",
@@ -58,9 +53,8 @@
 		"os-locale": "^6.0.2",
 		"strict-event-emitter": "^0.5.1",
 		"strip-ansi": "^7.1.0",
-		"tslib": "^2.6.2",
-		"type-fest": "^4.3.1",
+		"type-fest": "^4.5.0",
 		"uuid": "^9.0.1"
 	},
-	"gitHead": "51ad52c760435641f9bff8685707d8178b0787eb"
+	"gitHead": "0131de5ea9dd6d3fd5472d7b414b66644c758881"
 }