markuplint 2.0.0-rc.6 → 2.1.1

package/lib/cli/prompt.d.mts

@@ -0,0 +1,18 @@
+declare type SelectQuestion<T> = {
+    message: string;
+    choices: {
+        name: string;
+        value: T;
+    }[];
+};
+export declare function select<T>(question: SelectQuestion<T>): Promise<T>;
+export declare function multiSelect<T>(question: SelectQuestion<T>): Promise<T[]>;
+export declare function input<T extends string = string>(question: string, validation?: RegExp): Promise<T>;
+export declare function confirm(question: string, options?: {
+    initial?: boolean;
+}): Promise<boolean>;
+export declare function confirmSequence<T extends string = string>(questions: {
+    message: string;
+    name: T;
+}[]): Promise<Record<T, boolean>>;
+export {};

package/lib/cli/prompt.mjs

@@ -0,0 +1,68 @@
+import c from 'cli-color';
+import enquirer from 'enquirer';
+const { prompt } = enquirer;
+export async function select(question) {
+    const res = await prompt({
+        ...question,
+        name: '__Q__',
+        type: 'select',
+        result(resName) {
+            // @ts-ignore
+            return this.options.choices.find(c => c.name === resName)?.value;
+        },
+    });
+    // @ts-ignore
+    return res['__Q__'];
+}
+export async function multiSelect(question) {
+    const res = await prompt({
+        ...question,
+        name: '__Q__',
+        type: 'multiselect',
+        result(names) {
+            // @ts-ignore
+            const map = this.map(names);
+            // @ts-ignore
+            const values = names.map(name => map[name]);
+            return values;
+        },
+    });
+    // @ts-ignore
+    return res['__Q__'];
+}
+export async function input(question, validation) {
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+        const _res = await prompt({
+            message: question,
+            name: '__Q__',
+            type: 'input',
+        });
+        // @ts-ignore
+        const res = _res['__Q__'];
+        if (validation && !validation.test(res)) {
+            process.stdout.write(c.yellow('Oops! The name that you type is an invalid format.\n'));
+            continue;
+        }
+        return res;
+    }
+}
+export async function confirm(question, options) {
+    const res = await prompt({
+        message: question,
+        name: '__Q__',
+        type: 'confirm',
+        initial: !!options?.initial,
+    });
+    // @ts-ignore
+    return !!res['__Q__'];
+}
+export async function confirmSequence(questions) {
+    const res = await prompt(questions.map(question => {
+        return {
+            ...question,
+            type: 'confirm',
+        };
+    }));
+    return res;
+}

package/lib/debug.d.mts

@@ -0,0 +1,3 @@
+import debug from 'debug';
+export declare const log: debug.Debugger;
+export declare function verbosely(): void;

package/lib/debug.mjs

@@ -0,0 +1,10 @@
+import { enableDebug } from '@markuplint/ml-core';
+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}`);
+    }
+    enableDebug();
+}

package/lib/global-settings.d.mts

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

package/lib/global-settings.mjs

@@ -0,0 +1,10 @@
+let globalSettings = {};
+export function setGlobal(settings) {
+    globalSettings = {
+        ...globalSettings,
+        ...settings,
+    };
+}
+export function getGlobal() {
+    return globalSettings;
+}

package/lib/i18n.d.mts

@@ -0,0 +1,6 @@
+export declare function i18n(locale?: string): Promise<{
+    locale: string;
+    listFormat?: import("packages/@markuplint/i18n/src/types.js").ListFormat | undefined;
+    keywords?: import("packages/@markuplint/i18n/src/types.js").LocalesKeywords | undefined;
+    sentences?: import("packages/@markuplint/i18n/src/types.js").LocalesKeywords | undefined;
+}>;

package/lib/i18n.mjs

@@ -0,0 +1,19 @@
+import { osLocale } from 'os-locale';
+let cachedLocale = null;
+async function getLocale() {
+    if (!cachedLocale) {
+        cachedLocale = await osLocale({ spawn: true });
+    }
+    return cachedLocale;
+}
+export async function i18n(locale) {
+    locale = locale || (await getLocale()) || 'en';
+    const langCode = locale.split('-')[0];
+    const localeSet = langCode
+        ? await import(`@markuplint/i18n/locales/${langCode}`).catch(() => null)
+        : null;
+    return {
+        locale: langCode,
+        ...localeSet,
+    };
+}

package/lib/index.d.mts

@@ -0,0 +1,8 @@
+export { MLEngine } from './api/index.mjs';
+export * from './i18n.mjs';
+export * from './testing-tool/index.mjs';
+export * from './types.mjs';
+/**
+ * @deprecated
+ */
+export * from './v1.mjs';

package/lib/index.mjs

@@ -0,0 +1,8 @@
+export { MLEngine } from './api/index.mjs';
+export * from './i18n.mjs';
+export * from './testing-tool/index.mjs';
+export * from './types.mjs';
+/**
+ * @deprecated
+ */
+export * from './v1.mjs';

package/lib/reporter/index.d.mts

@@ -0,0 +1,2 @@
+export * from './standard-reporter.mjs';
+export * from './simple-reporter.mjs';

package/lib/reporter/index.mjs

@@ -0,0 +1,2 @@
+export * from './standard-reporter.mjs';
+export * from './simple-reporter.mjs';

package/lib/reporter/simple-reporter.d.mts

@@ -0,0 +1,3 @@
+import type { CLIOptions } from '../cli/bootstrap.mjs';
+import type { MLResultInfo } from '../types.mjs';
+export declare function simpleReporter(results: MLResultInfo, options: CLIOptions): string[];

package/lib/reporter/simple-reporter.mjs

@@ -0,0 +1,30 @@
+import c from 'cli-color';
+import { markuplint, messageToString, p, w } from '../util.mjs';
+const loggerError = c.red;
+const loggerWarning = c.xterm(208);
+export function simpleReporter(results, options) {
+    const sizes = {
+        line: 0,
+        col: 0,
+        meg: 0,
+    };
+    for (const violation of results.violations) {
+        sizes.line = Math.max(sizes.line, violation.line.toString(10).length);
+        sizes.col = Math.max(sizes.col, violation.col.toString(10).length);
+        const meg = messageToString(violation.message, violation.reason);
+        sizes.meg = Math.max(sizes.meg, w(meg));
+    }
+    const out = [];
+    if (results.violations.length) {
+        out.push(`<${markuplint}> ${c.underline(results.filePath)}: ${loggerError('✗')}`);
+        for (const violation of results.violations) {
+            const s = violation.severity === 'error' ? loggerError('✖') : loggerWarning('⚠️');
+            const meg = messageToString(violation.message, violation.reason);
+            out.push(`  ${c.cyan(`${p(violation.line, sizes.line, true)}:${p(violation.col, sizes.col)}`)} ${s}  ${p(meg, sizes.meg)} ${c.xterm(8)(violation.ruleId)} `);
+        }
+    }
+    else if (!options.problemOnly) {
+        out.push(`<${markuplint}> ${c.underline(results.filePath)}: ${c.green('✓')}`);
+    }
+    return out;
+}

package/lib/reporter/standard-reporter.d.mts

@@ -0,0 +1,3 @@
+import type { CLIOptions } from '../cli/bootstrap.mjs';
+import type { MLResultInfo } from '../types.mjs';
+export declare function standardReporter(results: MLResultInfo, options: CLIOptions): string[];

package/lib/reporter/standard-reporter.mjs

@@ -0,0 +1,43 @@
+import c from 'cli-color';
+import { invisibleSpace, markuplint, messageToString, p, space, w } from '../util.mjs';
+const loggerError = c.red;
+const loggerWarning = c.xterm(208);
+export function standardReporter(results, options) {
+    const sizes = {
+        line: 0,
+        col: 0,
+        meg: 0,
+    };
+    for (const violation of results.violations) {
+        sizes.line = Math.max(sizes.line, violation.line.toString(10).length);
+        sizes.col = Math.max(sizes.col, violation.col.toString(10).length);
+        const meg = messageToString(violation.message, violation.reason);
+        sizes.meg = Math.max(sizes.meg, w(meg));
+    }
+    const out = [];
+    if (results.violations.length) {
+        const lines = results.sourceCode.split(/\r?\n/g);
+        for (const violation of results.violations) {
+            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 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}`)}`)}`);
+            if (violation.line - 1 > 0) {
+                out.push(`  ${c.cyan(p(violation.line - 1, sizes.col, true))}: ${space(prev)}`);
+            }
+            out.push(`  ${c.cyan(p(violation.line, sizes.col, true))}: ${space(before)}${c.bgRed(violation.raw)}${space(after)}`);
+            if (!options.color) {
+                out.push(`         ${invisibleSpace(before)}${'^'.repeat(violation.raw.length)}${invisibleSpace(after)}`);
+            }
+            out.push(`  ${c.cyan(p(violation.line + 1, sizes.col, true))}: ${space(next)}`);
+        }
+    }
+    else if (!options.problemOnly) {
+        out.push(`<${markuplint}> ${c.green('passed')} ${c.underline(results.filePath)}`);
+    }
+    return out;
+}

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

@@ -0,0 +1,35 @@
+import type { Target } from '@markuplint/file-resolver';
+import type { Config, RuleConfigValue, Rule, RegexSelector } from '@markuplint/ml-config';
+import type { AnyMLRule, RuleSeed } from '@markuplint/ml-core';
+export declare function mlTest(sourceCode: string, config: Config, rules?: AnyMLRule[], locale?: string, fix?: boolean): Promise<{
+    violations: import("@markuplint/ml-config").Violation[];
+    fixedCode: string;
+}>;
+export declare function mlRuleTest<T extends RuleConfigValue, O = null>(rule: RuleSeed<T, O>, sourceCode: string, config?: Omit<Config, 'rules' | 'nodeRules' | 'childNodeRules'> & {
+    rule?: Rule<T, O>;
+    nodeRule?: NodeRule<T, O>[];
+    childNodeRule?: ChildNodeRule<T, O>[];
+}, fix?: boolean, locale?: string): Promise<{
+    violations: import("@markuplint/ml-config").Violation[];
+    fixedCode: string;
+}>;
+export declare function mlTestFile(target: Target, config?: Config, rules?: AnyMLRule[], locale?: string, fix?: boolean): Promise<{
+    violations: import("@markuplint/ml-config").Violation[];
+    fixedCode: string;
+}>;
+export interface NodeRule<T extends RuleConfigValue, O = void> {
+    tagName?: string;
+    selector?: string;
+    regexSelector?: RegexSelector;
+    categories?: string[];
+    roles?: string[];
+    obsolete?: boolean;
+    rule?: Rule<T, O>;
+}
+export interface ChildNodeRule<T extends RuleConfigValue, O = void> {
+    tagName?: string;
+    selector?: string;
+    regexSelector?: RegexSelector;
+    inheritance?: boolean;
+    rule?: Rule<T, O>;
+}

package/lib/testing-tool/index.mjs

@@ -0,0 +1,83 @@
+import { MLRule } from '@markuplint/ml-core';
+import { lint } from '../api/index.mjs';
+import { getGlobal } from '../global-settings.mjs';
+export async function mlTest(sourceCode, config, rules, locale = 'en', fix = false) {
+    const global = getGlobal();
+    const results = await lint([{ sourceCode }], {
+        config,
+        rules,
+        locale: locale ?? global.locale,
+        fix,
+        ignoreExt: true,
+        autoLoad: true,
+        importPresetRules: !rules,
+    });
+    const result = results[0];
+    return {
+        violations: result?.violations ?? [],
+        fixedCode: result?.fixedCode ?? sourceCode,
+    };
+}
+export async function mlRuleTest(rule, sourceCode, 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
+                ? {
+                    '<current-rule>': true,
+                }
+                : undefined,
+        nodeRules: config.nodeRule !== undefined
+            ? config.nodeRule.map(nodeConfig => ({
+                ...nodeConfig,
+                rules: nodeConfig.rule !== undefined
+                    ? {
+                        '<current-rule>': nodeConfig.rule,
+                    }
+                    : undefined,
+            }))
+            : undefined,
+        childNodeRules: config.childNodeRule !== undefined
+            ? config.childNodeRule.map(childNodeConfig => ({
+                ...childNodeConfig,
+                rules: childNodeConfig.rule !== undefined
+                    ? {
+                        '<current-rule>': childNodeConfig.rule,
+                    }
+                    : undefined,
+            }))
+            : undefined,
+    };
+    const res = await mlTest(sourceCode, _config, [
+        new MLRule({
+            name: '<current-rule>',
+            ...rule,
+        }),
+    ], locale, fix);
+    res.violations.map(v => {
+        // @ts-ignore
+        delete v.ruleId;
+    });
+    return res;
+}
+export async function mlTestFile(target, config, rules, locale, fix = false) {
+    const global = getGlobal();
+    const results = await lint([target], {
+        config,
+        rules,
+        locale: locale ?? global.locale,
+        fix,
+        ignoreExt: true,
+        noSearchConfig: !!config,
+        autoLoad: true,
+        importPresetRules: !rules,
+    });
+    const result = results[0];
+    return {
+        violations: result?.violations ?? [],
+        fixedCode: result?.fixedCode ?? result?.sourceCode,
+    };
+}

package/lib/types.d.mts

@@ -0,0 +1,27 @@
+import type { Config, Violation } from '@markuplint/ml-config';
+import type { Document, Ruleset } from '@markuplint/ml-core';
+export interface MLResultInfo {
+    violations: Violation[];
+    filePath: string;
+    sourceCode: string;
+    fixedCode: string;
+}
+/**
+ * @deprecated
+ */
+export interface MLResultInfo_v1 {
+    results: Violation[];
+    filePath: string;
+    sourceCode: string;
+    fixedCode: string;
+    document: Document<any, unknown> | null;
+    parser: string;
+    locale?: string;
+    ruleset: Ruleset;
+    configSet: {
+        config: Config;
+        files: string[];
+        error: string[];
+    };
+}
+export declare type Nullable<T> = T | null | undefined;

package/lib/types.mjs

@@ -0,0 +1 @@
+export {};

package/lib/util.d.mts

@@ -0,0 +1,19 @@
+import type { Nullable } from './types.mjs';
+export declare function nonNullableFilter<T>(item: Nullable<T>): item is T;
+export declare function uuid(): string;
+export declare const markuplint: string;
+export declare function write(message: string): void;
+export declare namespace write {
+    var _a: () => boolean;
+    export { _a as break };
+}
+export declare function error(message: string): void;
+export declare namespace error {
+    var exit: () => never;
+}
+export declare const head: (method: string, noColor?: boolean | undefined) => string;
+export declare function p(s: number | string, pad: number, start?: boolean): string;
+export declare function w(s: string): number;
+export declare function space(str: string): string;
+export declare function invisibleSpace(str: string): string;
+export declare function messageToString(message: string, reason?: string): string;

package/lib/util.mjs

@@ -0,0 +1,73 @@
+import { createRequire } from 'module';
+import c from 'cli-color';
+// @ts-ignore
+import eastasianwidth from 'eastasianwidth';
+import stripAnsi from 'strip-ansi';
+import { v4 } from 'uuid';
+const require = createRequire(import.meta.url);
+export function nonNullableFilter(item) {
+    return !!item;
+}
+export function uuid() {
+    return v4();
+}
+const logo = `<${c.xterm(39)('✔')}>`;
+const version = require('../package.json').version;
+const eaw = eastasianwidth;
+const box = (lines, { width = 40, padding = 1, center = false, noColor = false }) => {
+    const bt = `┌${'─'.repeat(width - 2)}┐`;
+    const pd = `│${' '.repeat(width - 2)}│`;
+    const bb = `└${'─'.repeat(width - 2)}┘`;
+    const texts = lines.map(line => {
+        const nc = stripAnsi(line);
+        const length = nc.length;
+        const pad = width - 2 - 1 - length;
+        const pad2 = Math.floor(pad / 2);
+        const padD = pad % 2;
+        const padl = center ? pad2 : 0;
+        const padr = center ? pad2 + padD : pad;
+        const text = noColor ? nc : line;
+        return `│ ${' '.repeat(padl)}${text}${' '.repeat(padr)}│`;
+    });
+    const result = [bt, pd, ...texts, pd, bb];
+    return result.join('\n');
+};
+export const markuplint = `markup${c.xterm(39)('lint')}`;
+export function write(message) {
+    process.stdout.write(message + '\n');
+}
+write.break = () => process.stdout.write('\n');
+export function error(message) {
+    process.stderr.write(message + '\n');
+}
+error.exit = () => process.exit(1);
+export const head = (method, noColor) => box([`${logo} ${markuplint}`, c.blackBright(`v${version}`), '', c.bold(method)], {
+    center: true,
+    noColor,
+});
+export function p(s, pad, start = false) {
+    const l = w(`${s}`.trim());
+    const d = pad - l;
+    const _ = ' '.repeat(d < 0 ? 0 : d);
+    return start ? `${_}${s}` : `${s}${_}`;
+}
+export function w(s) {
+    return s.replace(/./g, _ => '0'.repeat(eaw.characterLength(_))).length;
+}
+export function space(str) {
+    return str
+        .replace(/\s+/g, $0 => {
+        return c.xterm(8)($0);
+    })
+        .replace(/ /g, $0 => '•')
+        .replace(/\t/g, $0 => '→   ');
+}
+export function invisibleSpace(str) {
+    return str.replace(/\t/g, $0 => '    ').replace(/./g, $0 => ' ');
+}
+export function messageToString(message, reason) {
+    if (!reason) {
+        return message;
+    }
+    return `${message} / ${reason}`;
+}

package/lib/v1.d.mts

@@ -0,0 +1,4 @@
+/**
+ * @deprecated
+ */
+export { lint_v1 as exec } from './api/v1.mjs';

package/lib/v1.mjs

@@ -0,0 +1,4 @@
+/**
+ * @deprecated
+ */
+export { lint_v1 as exec } from './api/v1.mjs';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "markuplint",
-	"version": "2.0.0-rc.6",
+	"version": "2.1.1",
 	"description": "A Linter for All Markup Languages.",
 	"author": "Yusuke Hirao",
 	"license": "MIT",
@@ -25,19 +25,19 @@
 		"execa": "^5.1.1"
 	},
 	"dependencies": {
-		"@markuplint/create-rule-helper": "2.0.0-rc.6",
-		"@markuplint/file-resolver": "2.0.0-rc.6",
-		"@markuplint/html-parser": "2.0.0-rc.6",
-		"@markuplint/html-spec": "2.0.0-rc.6",
-		"@markuplint/i18n": "2.0.0-rc.5",
-		"@markuplint/ml-ast": "2.0.0-rc.6",
-		"@markuplint/ml-config": "2.0.0-rc.5",
-		"@markuplint/ml-core": "2.0.0-rc.6",
-		"@markuplint/ml-spec": "2.0.0-rc.6",
-		"@markuplint/rules": "2.0.0-rc.6",
-		"chokidar": "^3.5.2",
+		"@markuplint/create-rule-helper": "2.0.0",
+		"@markuplint/file-resolver": "2.0.0",
+		"@markuplint/html-parser": "2.0.0",
+		"@markuplint/html-spec": "^2.1.0",
+		"@markuplint/i18n": "2.0.0",
+		"@markuplint/ml-ast": "2.0.0",
+		"@markuplint/ml-config": "2.0.0",
+		"@markuplint/ml-core": "2.0.0",
+		"@markuplint/ml-spec": "2.0.0",
+		"@markuplint/rules": "^2.1.1",
+		"chokidar": "^3.5.3",
 		"cli-color": "^2.0.1",
-		"debug": "^4.3.2",
+		"debug": "^4.3.3",
 		"detect-installed": "^2.0.4",
 		"eastasianwidth": "^0.2.0",
 		"enquirer": "^2.3.6",
@@ -50,5 +50,5 @@
 		"tslib": "^2.3.1",
 		"uuid": "^8.3.2"
 	},
-	"gitHead": "7c93367a86f935f6b94780b1fa14f3293f900b87"
+	"gitHead": "4c735ccf6107a4aef999f8e1674527dc18e9e63c"
 }