markuplint 2.0.0 → 2.1.0

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.d.ts

@@ -1,53 +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 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 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 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>;
+    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>;
+    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.d.ts

@@ -1,27 +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;
+    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[];
-	};
+    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.d.ts

@@ -4,12 +4,12 @@ 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 };
+    var _a: () => boolean;
+    export { _a as break };
 }
 export declare function error(message: string): void;
 export declare namespace error {
-	var exit: () => never;
+    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;

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",
+	"version": "2.1.0",
 	"description": "A Linter for All Markup Languages.",
 	"author": "Yusuke Hirao",
 	"license": "MIT",
@@ -28,13 +28,13 @@
 		"@markuplint/create-rule-helper": "2.0.0",
 		"@markuplint/file-resolver": "2.0.0",
 		"@markuplint/html-parser": "2.0.0",
-		"@markuplint/html-spec": "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.0.0",
+		"@markuplint/rules": "^2.1.0",
 		"chokidar": "^3.5.3",
 		"cli-color": "^2.0.1",
 		"debug": "^4.3.3",
@@ -50,5 +50,5 @@
 		"tslib": "^2.3.1",
 		"uuid": "^8.3.2"
 	},
-	"gitHead": "de81fc514acdf472f87184e3499e9364258f9b66"
+	"gitHead": "37c0b6e00b612ce8d31549ce6b99c2f20ac242c7"
 }

package/lib/cli/head.d.ts

@@ -1 +0,0 @@
-export declare const head: string;

package/lib/cli/head.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.head = void 0;
-const tslib_1 = require("tslib");
-const cli_color_1 = (0, tslib_1.__importDefault)(require("cli-color"));
-const strip_ansi_1 = (0, tslib_1.__importDefault)(require("strip-ansi"));
-const logo = `<${cli_color_1.default.xterm(39)('✔')}>`;
-const markuplint = `markup${cli_color_1.default.xterm(39)('lint')}`;
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const version = require('../../package.json').version;
-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 = (0, strip_ansi_1.default)(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');
-};
-exports.head = box([`${logo} ${markuplint}`, cli_color_1.default.blackBright(`v${version}`), '', cli_color_1.default.bold('Initialization')], {
-    center: true,
-});

package/lib/reporter/utils.d.ts

@@ -1,6 +0,0 @@
-export declare const markuplint: 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/reporter/utils.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.messageToString = exports.invisibleSpace = exports.space = exports.w = exports.p = exports.markuplint = void 0;
-const tslib_1 = require("tslib");
-const cli_color_1 = (0, tslib_1.__importDefault)(require("cli-color"));
-// @ts-ignore
-const eastasianwidth_1 = (0, tslib_1.__importDefault)(require("eastasianwidth"));
-exports.markuplint = `markup${cli_color_1.default.xterm(39)('lint')}`;
-const eaw = eastasianwidth_1.default;
-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}${_}`;
-}
-exports.p = p;
-function w(s) {
-    return s.replace(/./g, _ => '0'.repeat(eaw.characterLength(_))).length;
-}
-exports.w = w;
-function space(str) {
-    return str
-        .replace(/\s+/g, $0 => {
-        return cli_color_1.default.xterm(8)($0);
-    })
-        .replace(/ /g, $0 => '•')
-        .replace(/\t/g, $0 => '→   ');
-}
-exports.space = space;
-function invisibleSpace(str) {
-    return str.replace(/\t/g, $0 => '    ').replace(/./g, $0 => ' ');
-}
-exports.invisibleSpace = invisibleSpace;
-function messageToString(message, reason) {
-    if (!reason) {
-        return message;
-    }
-    return `${message} / ${reason}`;
-}
-exports.messageToString = messageToString;