markuplint 2.0.0-rc.2 → 2.0.0

package/lib/cli/head.js

@@ -0,0 +1,31 @@
+"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/cli/init/index.js

@@ -6,6 +6,7 @@ const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const util_1 = (0, tslib_1.__importDefault)(require("util"));
 const ml_config_1 = require("@markuplint/ml-config");
+const util_2 = require("../../util");
 const prompt_1 = require("../prompt");
 const install_module_1 = require("./install-module");
 const writeFile = util_1.default.promisify(fs_1.default.writeFile);
@@ -28,10 +29,43 @@ const defaultRules = {
         category: 'validation',
         default: true,
     },
+    'attr-equal-space-after': {
+        category: 'style',
+        default: true,
+    },
+    'attr-equal-space-before': {
+        category: 'style',
+        default: true,
+    },
+    'attr-spacing': {
+        category: 'style',
+        default: true,
+    },
+    'attr-value-quotes': {
+        category: 'style',
+        default: true,
+    },
+    'case-sensitive-attr-name': {
+        category: 'style',
+        default: true,
+    },
+    'case-sensitive-attr-value': {
+        category: 'style',
+        default: true,
+    },
+    'case-sensitive-tag-name': {
+        category: 'style',
+        default: true,
+    },
     'character-reference': {
         category: 'validation',
         default: true,
     },
+    'class-naming': {
+        category: 'naming-convention',
+        default: false,
+        recommendedValue: '/.+/',
+    },
     'deprecated-attr': {
         category: 'validation',
         default: true,
@@ -40,19 +74,28 @@ const defaultRules = {
         category: 'validation',
         default: true,
     },
+    'disallowed-element': {
+        category: 'validation',
+        default: false,
+    },
     doctype: {
         category: 'validation',
         default: true,
     },
-    'id-duplication': {
-        category: 'validation',
+    'end-tag': {
+        category: 'style',
         default: true,
     },
-    'permitted-contents': {
+    'id-duplication': {
         category: 'validation',
         default: true,
     },
-    'required-attr': {
+    indentation: {
+        category: 'style',
+        default: false,
+        recommendedValue: 2,
+    },
+    'ineffective-attr': {
         category: 'validation',
         default: true,
     },
@@ -64,52 +107,52 @@ const defaultRules = {
         category: 'a11y',
         default: true,
     },
-    'required-h1': {
-        category: 'a11y',
+    'no-boolean-attr-value': {
+        category: 'style',
         default: true,
     },
-    'wai-aria': {
-        category: 'a11y',
+    'no-default-value': {
+        category: 'style',
         default: true,
     },
-    'class-naming': {
-        category: 'naming-convention',
-        default: false,
-        recommendedValue: '/.+/',
-    },
-    'attr-equal-space-after': {
+    'no-hard-code-id': {
         category: 'style',
         default: true,
     },
-    'attr-equal-space-before': {
-        category: 'style',
+    'no-refer-to-non-existent-id': {
+        category: 'a11y',
         default: true,
     },
-    'attr-spacing': {
+    'no-use-event-handler-attr': {
         category: 'style',
         default: true,
     },
-    'attr-value-quotes': {
-        category: 'style',
+    'permitted-contents': {
+        category: 'validation',
         default: true,
     },
-    'case-sensitive-attr-name': {
-        category: 'style',
+    'required-attr': {
+        category: 'validation',
         default: true,
     },
-    'case-sensitive-tag-name': {
-        category: 'style',
+    'required-element': {
+        category: 'validation',
         default: true,
     },
-    indentation: {
-        category: 'style',
-        default: false,
-        recommendedValue: 2,
+    'required-h1': {
+        category: 'a11y',
+        default: true,
+    },
+    'wai-aria': {
+        category: 'a11y',
+        default: true,
     },
 };
 const extRExp = {
+    jsx: '\\.[jt]sx?$',
     vue: '\\.vue$',
     svelte: '\\.svelte$',
+    astro: '\\.astro',
     pug: '\\.pug$',
     php: '\\.php$',
     erb: '\\.erb$',
@@ -120,14 +163,15 @@ const extRExp = {
 };
 async function initialize() {
     let config = {};
-    write('markuplit initialization');
-    write.break();
+    (0, util_2.write)((0, util_2.head)('Initialization'));
+    util_2.write.break();
     const langs = await (0, prompt_1.multiSelect)({
         message: 'Which do you use template engines?',
         choices: [
             { name: 'React (JSX)', value: 'jsx' },
             { name: 'Vue', value: 'vue' },
             { name: 'Svelte', value: 'svelte' },
+            { name: 'Astro', value: 'astro' },
             { name: 'Pug', value: 'pug' },
             { name: 'PHP', value: 'php' },
             { name: 'eRuby', value: 'erb' },
@@ -139,13 +183,8 @@ async function initialize() {
     });
     const autoInstall = await (0, prompt_1.confirm)('May I install them automatically?');
     const customize = await (0, prompt_1.confirm)('Do you customize rules?');
-    if (langs && langs.length) {
-        config.parser = {};
-    }
     for (const lang of langs) {
-        if (!config.parser) {
-            continue;
-        }
+        config.parser = config.parser || {};
         // @ts-ignore
         const ext = extRExp[lang];
         if (!ext) {
@@ -155,14 +194,14 @@ async function initialize() {
         if (lang === 'vue') {
             config = (0, ml_config_1.mergeConfig)(config, {
                 specs: {
-                    '/\\.vue$/i': '@markuplint/vue-spec',
+                    '\\.vue$': '@markuplint/vue-spec',
                 },
             });
         }
         if (lang === 'jsx') {
             config = (0, ml_config_1.mergeConfig)(config, {
                 specs: {
-                    '/\\.[jt]sx?$/i': '@markuplint/react-spec',
+                    '\\.[jt]sx?$': '@markuplint/react-spec',
                 },
             });
         }
@@ -191,18 +230,24 @@ async function initialize() {
         }
     }
     else {
-        config.rules = {};
-        const ruleNames = Object.keys(defaultRules);
-        for (const ruleName of ruleNames) {
-            const rule = defaultRules[ruleName];
-            config.rules[ruleName] = rule.default;
+        const recommended = await (0, prompt_1.confirm)('Does it import the recommended config?');
+        if (recommended) {
+            config.extends = [...(config.extends || []), 'markuplint:recommended'];
+        }
+        else {
+            config.rules = {};
+            const ruleNames = Object.keys(defaultRules);
+            for (const ruleName of ruleNames) {
+                const rule = defaultRules[ruleName];
+                config.rules[ruleName] = rule.default;
+            }
         }
     }
     const filePath = path_1.default.resolve(process.cwd(), '.markuplintrc');
     await writeFile(filePath, JSON.stringify(config, null, 2), { encoding: 'utf-8' });
-    write(`✨Created: ${filePath}`);
+    (0, util_2.write)(`✨Created: ${filePath}`);
     if (autoInstall) {
-        write('Install automatically');
+        (0, util_2.write)('Install automatically');
         const modules = ['markuplint', ...langs.map(lang => `@markuplint/${lang}-parser`)];
         if (langs.includes('vue')) {
             modules.push('@markuplint/vue-spec');
@@ -212,23 +257,15 @@ async function initialize() {
         }
         const result = await (0, install_module_1.installModule)(modules, true).catch(e => new Error(e));
         if (result instanceof Error) {
-            error.exit();
+            util_2.error.exit();
             return;
         }
         if (result.alreadyExists) {
-            write('Modules are installed already.');
+            (0, util_2.write)('Modules are installed already.');
         }
         else {
-            write('✨ Success');
+            (0, util_2.write)('✨ Success');
         }
     }
 }
 exports.initialize = initialize;
-function write(message) {
-    process.stdout.write(message + '\n');
-}
-write.break = () => process.stdout.write('\n');
-function error(message) {
-    process.stderr.write(message + '\n');
-}
-error.exit = () => process.exit(1);

package/lib/cli/init/install-module.d.ts

@@ -1,5 +1,5 @@
 export declare type InstallModuleResult = {
-    success: boolean;
-    alreadyExists: boolean;
+	success: boolean;
+	alreadyExists: boolean;
 };
 export declare function installModule(module: string[], dev?: boolean): Promise<InstallModuleResult>;

package/lib/cli/prompt.d.ts

@@ -1,18 +1,23 @@
 declare type SelectQuestion<T> = {
-    message: string;
-    choices: {
-        name: string;
-        value: 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 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/global-settings.d.ts

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

package/lib/i18n.d.ts

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

package/lib/reporter/simple-reporter.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.simpleReporter = void 0;
 const tslib_1 = require("tslib");
 const cli_color_1 = (0, tslib_1.__importDefault)(require("cli-color"));
-const utils_1 = require("./utils");
+const util_1 = require("../util");
 const loggerError = cli_color_1.default.red;
 const loggerWarning = cli_color_1.default.xterm(208);
 function simpleReporter(results, options) {
@@ -15,20 +15,20 @@ function simpleReporter(results, options) {
     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 = (0, utils_1.messageToString)(violation.message, violation.reason);
-        sizes.meg = Math.max(sizes.meg, (0, utils_1.w)(meg));
+        const meg = (0, util_1.messageToString)(violation.message, violation.reason);
+        sizes.meg = Math.max(sizes.meg, (0, util_1.w)(meg));
     }
     const out = [];
     if (results.violations.length) {
-        out.push(`<${utils_1.markuplint}> ${cli_color_1.default.underline(results.filePath)}: ${loggerError('✗')}`);
+        out.push(`<${util_1.markuplint}> ${cli_color_1.default.underline(results.filePath)}: ${loggerError('✗')}`);
         for (const violation of results.violations) {
             const s = violation.severity === 'error' ? loggerError('✖') : loggerWarning('⚠️');
-            const meg = (0, utils_1.messageToString)(violation.message, violation.reason);
-            out.push(`  ${cli_color_1.default.cyan(`${(0, utils_1.p)(violation.line, sizes.line, true)}:${(0, utils_1.p)(violation.col, sizes.col)}`)} ${s}  ${(0, utils_1.p)(meg, sizes.meg)} ${cli_color_1.default.xterm(8)(violation.ruleId)} `);
+            const meg = (0, util_1.messageToString)(violation.message, violation.reason);
+            out.push(`  ${cli_color_1.default.cyan(`${(0, util_1.p)(violation.line, sizes.line, true)}:${(0, util_1.p)(violation.col, sizes.col)}`)} ${s}  ${(0, util_1.p)(meg, sizes.meg)} ${cli_color_1.default.xterm(8)(violation.ruleId)} `);
         }
     }
     else if (!options.problemOnly) {
-        out.push(`<${utils_1.markuplint}> ${cli_color_1.default.underline(results.filePath)}: ${cli_color_1.default.green('✓')}`);
+        out.push(`<${util_1.markuplint}> ${cli_color_1.default.underline(results.filePath)}: ${cli_color_1.default.green('✓')}`);
     }
     return out;
 }

package/lib/reporter/standard-reporter.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.standardReporter = void 0;
 const tslib_1 = require("tslib");
 const cli_color_1 = (0, tslib_1.__importDefault)(require("cli-color"));
-const utils_1 = require("./utils");
+const util_1 = require("../util");
 const loggerError = cli_color_1.default.red;
 const loggerWarning = cli_color_1.default.xterm(208);
 function standardReporter(results, options) {
@@ -15,8 +15,8 @@ function standardReporter(results, options) {
     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 = (0, utils_1.messageToString)(violation.message, violation.reason);
-        sizes.meg = Math.max(sizes.meg, (0, utils_1.w)(meg));
+        const meg = (0, util_1.messageToString)(violation.message, violation.reason);
+        sizes.meg = Math.max(sizes.meg, (0, util_1.w)(meg));
     }
     const out = [];
     if (results.violations.length) {
@@ -28,20 +28,20 @@ function standardReporter(results, options) {
             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 = (0, utils_1.messageToString)(violation.message, violation.reason);
-            out.push(`<${utils_1.markuplint}> ${logger(`${violation.severity}: ${meg} (${violation.ruleId}) ${cli_color_1.default.underline(`${results.filePath}:${violation.line}:${violation.col}`)}`)}`);
+            const meg = (0, util_1.messageToString)(violation.message, violation.reason);
+            out.push(`<${util_1.markuplint}> ${logger(`${violation.severity}: ${meg} (${violation.ruleId}) ${cli_color_1.default.underline(`${results.filePath}:${violation.line}:${violation.col}`)}`)}`);
             if (violation.line - 1 > 0) {
-                out.push(`  ${cli_color_1.default.cyan((0, utils_1.p)(violation.line - 1, sizes.col, true))}: ${(0, utils_1.space)(prev)}`);
+                out.push(`  ${cli_color_1.default.cyan((0, util_1.p)(violation.line - 1, sizes.col, true))}: ${(0, util_1.space)(prev)}`);
             }
-            out.push(`  ${cli_color_1.default.cyan((0, utils_1.p)(violation.line, sizes.col, true))}: ${(0, utils_1.space)(before)}${cli_color_1.default.bgRed(violation.raw)}${(0, utils_1.space)(after)}`);
+            out.push(`  ${cli_color_1.default.cyan((0, util_1.p)(violation.line, sizes.col, true))}: ${(0, util_1.space)(before)}${cli_color_1.default.bgRed(violation.raw)}${(0, util_1.space)(after)}`);
             if (!options.color) {
-                out.push(`         ${(0, utils_1.invisibleSpace)(before)}${'^'.repeat(violation.raw.length)}${(0, utils_1.invisibleSpace)(after)}`);
+                out.push(`         ${(0, util_1.invisibleSpace)(before)}${'^'.repeat(violation.raw.length)}${(0, util_1.invisibleSpace)(after)}`);
             }
-            out.push(`  ${cli_color_1.default.cyan((0, utils_1.p)(violation.line + 1, sizes.col, true))}: ${(0, utils_1.space)(next)}`);
+            out.push(`  ${cli_color_1.default.cyan((0, util_1.p)(violation.line + 1, sizes.col, true))}: ${(0, util_1.space)(next)}`);
         }
     }
     else if (!options.problemOnly) {
-        out.push(`<${utils_1.markuplint}> ${cli_color_1.default.green('passed')} ${cli_color_1.default.underline(results.filePath)}`);
+        out.push(`<${util_1.markuplint}> ${cli_color_1.default.green('passed')} ${cli_color_1.default.underline(results.filePath)}`);
     }
     return out;
 }

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

@@ -1,35 +1,53 @@
 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.js

@@ -12,6 +12,7 @@ async function mlTest(sourceCode, config, rules, locale = 'en', fix = false) {
         rules,
         locale: locale !== null && locale !== void 0 ? locale : global.locale,
         fix,
+        ignoreExt: true,
         autoLoad: true,
         importPresetRules: !rules,
     });
@@ -76,6 +77,7 @@ async function mlTestFile(target, config, rules, locale, fix = false) {
         rules,
         locale: locale !== null && locale !== void 0 ? locale : global.locale,
         fix,
+        ignoreExt: true,
         noSearchConfig: !!config,
         autoLoad: true,
         importPresetRules: !rules,

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

@@ -1,3 +1,19 @@
 import type { Nullable } from './types';
 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;