markuplint 2.0.0-rc.1 → 2.0.0-rc.6

package/README.md

@@ -30,18 +30,25 @@ Usage
 	$ <stdout> | markuplint
 
 Options
-	--config-file,  -c FILE_PATH  Ruleset file path.
-	--fix,                        Fix HTML.
-	--format,       -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
-	--no-color,                   Output no color.
-	--problem-only, -p            Output only problems, without passeds.
-	--verbose                     Output with detailed information.
-
-	--help,         -h            Show help.
-	--version,      -v            Show version.
+	--config,                -c FILE_PATH  A configuration file path.
+	--fix,                                 Fix HTML.
+	--format,                -f FORMAT     Output format. Support "JSON", "Simple" 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.
+	--verbose                              Output with detailed information.
+
+	--init                                 Initialize settings interactively.
+	--create-rule                          Add the scaffold of a custom rule.
+
+	--help,                  -h            Show help.
+	--version,               -v            Show version.
 
 Examples
-	$ markuplint verifyee.html --ruleset path/to/.markuplintrc
+	$ markuplint verifyee.html --config path/to/.markuplintrc
 	$ cat verifyee.html | markuplint
 ```
 

package/lib/api/ml-engine.js

@@ -113,6 +113,10 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
         fileLog('Resolved Config: %O', configSet.config);
         fileLog('Resolved Plugins: %O', configSet.plugins);
         fileLog('Resolve Errors: %O', configSet.errs);
+        if (!(await (0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").isFile())) {
+            this.emit('log', 'file-no-exists', `The file doesn't exist or it is not a file: ${(0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").path}`);
+            return null;
+        }
         // Exclude
         const excludeFiles = configSet.config.excludeFiles || [];
         for (const excludeFile of excludeFiles) {
@@ -122,9 +126,9 @@ class MLEngine extends strict_event_emitter_1.StrictEventEmitter {
             }
         }
         const { parser, parserOptions, matched } = await this.resolveParser(configSet);
-        // Ext Matching
-        if (((_a = (0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_options, "f")) === null || _a === void 0 ? void 0 : _a.extMatch) && !matched && !(0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").path.match(/\.html?$/i)) {
-            this.emit('log', 'extension-matching', `${(0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").path}`);
+        const checkingExt = !((_a = (0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_options, "f")) === null || _a === void 0 ? void 0 : _a.ignoreExt);
+        if (checkingExt && !matched) {
+            this.emit('log', 'ext-unmatched', `Avoided linting because a file is unmatched by the extension: ${(0, tslib_1.__classPrivateFieldGet)(this, _MLEngine_file, "f").path}`);
             return null;
         }
         const ruleset = this.resolveRuleset(configSet);

package/lib/api/types.d.ts

@@ -10,7 +10,7 @@ export declare type APIOptions = {
     noSearchConfig?: boolean;
     locale?: string;
     fix?: boolean;
-    extMatch?: boolean;
+    ignoreExt?: boolean;
     rules?: AnyMLRule[];
     importPresetRules?: boolean;
     /**

package/lib/api/v1.d.ts

@@ -48,13 +48,4 @@ export declare function lint_v1(options: {
      * Locale
      */
     locale?: string;
-    /**
-     * Confirm the extension of the target file to the regexp of parser plugins.
-     * It doesn't run the linting if it doesn't match.
-     * If you don't set a parser plugin and the target file is HTML, It confirms the regexp as `/\.html?$/i`.
-     * Default is false.
-     *
-     * @default false
-     */
-    extMatch?: boolean;
 }): Promise<import("..").MLResultInfo[]>;

package/lib/api/v1.js

@@ -40,7 +40,6 @@ async function lint_v1(options) {
         noSearchConfig: !options.files,
         rules: options.rules,
         autoLoad: (_a = options.rulesAutoResolve) !== null && _a !== void 0 ? _a : true,
-        extMatch: options.extMatch,
         locale: options.locale,
     });
     return result;

package/lib/cli/bootstrap.d.ts

@@ -1,25 +1,32 @@
 import meow from 'meow';
-export declare const help = "\nUsage\n\t$ markuplint <HTML file pathes (glob format)>\n\t$ <stdout> | markuplint\n\nOptions\n\t--config-file,  -c FILE_PATH  Ruleset file path.\n\t--fix,                        Fix HTML.\n\t--format,       -f FORMAT     Output format. Support \"JSON\", \"Simple\" and \"Standard\". Default: \"Standard\".\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\n\t--help,         -h            Show help.\n\t--version,      -v            Show version.\n\nExamples\n\t$ markuplint verifyee.html --ruleset path/to/.markuplintrc\n\t$ cat verifyee.html | markuplint\n";
+export declare const help = "\nUsage\n\t$ markuplint <HTML file pathes (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\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<{
-    init: {
-        type: "boolean";
-        default: false;
+    config: {
+        type: "string";
+        alias: string;
     };
-    createRule: {
+    fix: {
         type: "boolean";
         default: false;
     };
-    configFile: {
+    format: {
         type: "string";
         alias: string;
     };
-    fix: {
+    searchConfig: {
+        type: "boolean";
+        default: true;
+    };
+    ignoreExt: {
         type: "boolean";
         default: false;
     };
-    format: {
+    importPresetRules: {
+        type: "boolean";
+        default: true;
+    };
+    locale: {
         type: "string";
-        alias: string;
     };
     color: {
         type: "boolean";
@@ -34,5 +41,13 @@ export declare const cli: meow.Result<{
         type: "boolean";
         default: false;
     };
+    init: {
+        type: "boolean";
+        default: false;
+    };
+    createRule: {
+        type: "boolean";
+        default: false;
+    };
 }>;
 export declare type CLIOptions = typeof cli.flags;

package/lib/cli/bootstrap.js

@@ -9,34 +9,30 @@ Usage
 	$ <stdout> | markuplint
 
 Options
-	--config-file,  -c FILE_PATH  Ruleset file path.
-	--fix,                        Fix HTML.
-	--format,       -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
-	--no-color,                   Output no color.
-	--problem-only, -p            Output only problems, without passeds.
-	--verbose                     Output with detailed information.
+	--config,                -c FILE_PATH  A configuration file path.
+	--fix,                                 Fix HTML.
+	--format,                -f FORMAT     Output format. Support "JSON", "Simple" 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.
+	--verbose                              Output with detailed information.
 
-	--init                        Initialize settings interactively.
-	--create-rule                 Add the scaffold of a custom rule.
+	--init                                 Initialize settings interactively.
+	--create-rule                          Add the scaffold of a custom rule.
 
-	--help,         -h            Show help.
-	--version,      -v            Show version.
+	--help,                  -h            Show help.
+	--version,               -v            Show version.
 
 Examples
-	$ markuplint verifyee.html --ruleset path/to/.markuplintrc
+	$ markuplint verifyee.html --config path/to/.markuplintrc
 	$ cat verifyee.html | markuplint
 `;
 exports.cli = (0, meow_1.default)(exports.help, {
     flags: {
-        init: {
-            type: 'boolean',
-            default: false,
-        },
-        createRule: {
-            type: 'boolean',
-            default: false,
-        },
-        configFile: {
+        config: {
             type: 'string',
             alias: 'c',
         },
@@ -48,6 +44,21 @@ exports.cli = (0, meow_1.default)(exports.help, {
             type: 'string',
             alias: 'f',
         },
+        searchConfig: {
+            type: 'boolean',
+            default: true,
+        },
+        ignoreExt: {
+            type: 'boolean',
+            default: false,
+        },
+        importPresetRules: {
+            type: 'boolean',
+            default: true,
+        },
+        locale: {
+            type: 'string',
+        },
         color: {
             type: 'boolean',
             default: true,
@@ -61,5 +72,13 @@ exports.cli = (0, meow_1.default)(exports.help, {
             type: 'boolean',
             default: false,
         },
+        init: {
+            type: 'boolean',
+            default: false,
+        },
+        createRule: {
+            type: 'boolean',
+            default: false,
+        },
     },
 });

package/lib/cli/command.d.ts

@@ -1,3 +1,3 @@
 import type { CLIOptions } from './bootstrap';
 import type { Target } from '@markuplint/file-resolver';
-export declare function command(files: Target[], options: CLIOptions): Promise<void>;
+export declare function command(files: Target[], options: CLIOptions): Promise<boolean>;

package/lib/cli/command.js

@@ -10,19 +10,36 @@ const debug_1 = require("../debug");
 const output_1 = require("./output");
 async function command(files, options) {
     const fix = options.fix;
-    const configFile = options.configFile && path_1.default.join(process.cwd(), options.configFile);
+    const configFile = options.config && path_1.default.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);
     }
+    let hasError = false;
     for (const file of fileList) {
-        const engine = new api_1.MLEngine(file, { configFile });
+        const engine = new api_1.MLEngine(file, {
+            configFile,
+            fix,
+            locale,
+            noSearchConfig: !searchConfig,
+            ignoreExt,
+            importPresetRules,
+            debug: verbose,
+        });
         const result = await engine.exec();
         if (!result) {
             continue;
         }
+        if (!hasError && result.violations.length) {
+            hasError = true;
+        }
         if (fix) {
             (0, debug_1.log)('Overwrite file: %s', result.filePath);
             await fs_1.promises.writeFile(result.filePath, result.fixedCode, { encoding: 'utf8' });
@@ -33,5 +50,6 @@ async function command(files, options) {
             await (0, output_1.output)(result, options);
         }
     }
+    return hasError;
 }
 exports.command = command;

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

@@ -4,9 +4,12 @@ exports.createRule = void 0;
 const tslib_1 = require("tslib");
 const create_rule_helper_1 = require("@markuplint/create-rule-helper");
 const cli_color_1 = (0, 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();
     const purpose = await (0, prompt_1.select)({
         message: 'What purpose do you create the rule for?',
         choices: [
@@ -49,5 +52,5 @@ 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);
-    process.stdout.write(_marker + _title(icon, title) + _file(path) + '\n');
+    (0, util_1.write)(_marker + _title(icon, title) + _file(path));
 }

package/lib/cli/head.d.ts

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

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/index.js

@@ -33,21 +33,21 @@ const init_1 = require("./init");
     }
     const files = bootstrap_1.cli.input;
     if (files.length) {
-        await (0, command_1.command)(files, bootstrap_1.cli.flags).catch(err => {
+        const hasError = await (0, command_1.command)(files, bootstrap_1.cli.flags).catch(err => {
             throw err;
             // process.exit(1);
         });
-        process.exit(0);
+        process.exit(hasError ? 1 : 0);
     }
     if (usePipe()) {
         (0, get_stdin_1.default)()
             .then(async (stdin) => {
             if (stdin) {
-                await (0, command_1.command)([{ sourceCode: stdin }], bootstrap_1.cli.flags).catch(err => {
+                const hasError = await (0, command_1.command)([{ sourceCode: stdin }], bootstrap_1.cli.flags).catch(err => {
                     process.stderr.write(err + '\n');
                     process.exit(1);
                 });
-                process.exit(0);
+                process.exit(hasError ? 1 : 0);
             }
             // result is empty
             bootstrap_1.cli.showHelp(1);

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);