markuplint 3.15.0 → 4.0.0-alpha.10

package/lib/cli/init/create-config.js

@@ -1,10 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createConfig = exports.langs = void 0;
 const extRExp = {
     jsx: '\\.[jt]sx?$',
     vue: '\\.vue$',
     svelte: '\\.svelte$',
+    sveltekit: '\\.html$',
     astro: '\\.astro$',
     pug: '\\.pug$',
     php: '\\.php$',
@@ -15,10 +13,11 @@ const extRExp = {
     nunjucks: '\\.nunjucks$',
     liquid: '\\.liquid$',
 };
-exports.langs = {
+export const langs = {
     jsx: 'React (JSX)',
     vue: 'Vue',
     svelte: 'Svelte',
+    sveltekit: 'SvelteKit',
     astro: 'Astro',
     pug: 'Pug',
     php: 'PHP',
@@ -29,8 +28,7 @@ exports.langs = {
     nunjucks: 'Nunjucks',
     liquid: 'liquid (Shopify)',
 };
-function createConfig(langs, mode, defaultRules) {
-    var _a;
+export function createConfig(langs, mode, defaultRules) {
     let config = {};
     const parser = { ...config.parser };
     for (const lang of langs) {
@@ -38,8 +36,15 @@ function createConfig(langs, mode, defaultRules) {
         if (!ext) {
             continue;
         }
-        // @ts-ignore
-        parser[ext] = `@markuplint/${lang}-parser`;
+        switch (lang) {
+            case 'sveltekit': {
+                parser[ext] = '@markuplint/svelte-parser/kit';
+                break;
+            }
+            default: {
+                parser[ext] = `@markuplint/${lang}-parser`;
+            }
+        }
         if (lang === 'vue') {
             config = {
                 ...config,
@@ -71,13 +76,12 @@ function createConfig(langs, mode, defaultRules) {
                 continue;
             }
             if (mode.includes(rule.category)) {
-                // @ts-ignore
                 rules[ruleName] = rule.defaultValue;
             }
         }
     }
     else if (mode === 'recommended') {
-        config.extends = [...((_a = config.extends) !== null && _a !== void 0 ? _a : []), 'markuplint:recommended'];
+        config.extends = [...(config.extends ?? []), 'markuplint:recommended'];
     }
     else {
         const ruleNames = Object.keys(defaultRules);
@@ -86,7 +90,6 @@ function createConfig(langs, mode, defaultRules) {
             if (!rule) {
                 continue;
             }
-            // @ts-ignore
             rules[ruleName] = rule.defaultValue;
         }
     }
@@ -95,4 +98,3 @@ function createConfig(langs, mode, defaultRules) {
     }
     return config;
 }
-exports.createConfig = createConfig;

package/lib/cli/init/get-default-rules.d.ts

@@ -1,3 +1,3 @@
-export declare function getDefaultRules(version: string): Promise<{
-	[x: string]: import('./types').Rule;
-}>;
+export declare function getDefaultRules(): {
+    [x: string]: import("./types.js").Rule;
+};

package/lib/cli/init/get-default-rules.js

@@ -1,57 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultRules = void 0;
-const tslib_1 = require("tslib");
-const gray_matter_1 = tslib_1.__importDefault(require("gray-matter"));
-const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
-const RULES_SCHEMA_URL = 'https://raw.githubusercontent.com/markuplint/markuplint/[VERSION]/packages/@markuplint/rules/schema.json';
-const RULES_README_URL = 'https://raw.githubusercontent.com/markuplint/markuplint/[VERSION]/packages/@markuplint/rules/src/[NAME]/README.md';
-async function getDefaultRules(version) {
-    const json = await safeFetch(RULES_SCHEMA_URL, version);
+import builtinRules from '@markuplint/rules';
+export function getDefaultRules() {
     const rules = {};
-    await Promise.all(Object.entries(json.definitions.rules.properties).map(async ([name, rule]) => {
-        var _a, _b, _c, _d;
-        const json = await safeFetch(rule.$ref.replace('/main/', '/[VERSION]/'), version);
-        let severity = (_c = (_b = (_a = (Array.isArray(json.oneOf) ? json.oneOf : []).find((val) => val.properties)) === null || _a === void 0 ? void 0 : _a.properties) === null || _b === void 0 ? void 0 : _b.severity) === null || _c === void 0 ? void 0 : _c.default;
-        let category = json._category;
-        if (severity == null || category == null) {
-            const data = await getCatAndSeverityFromLegacy(version, name);
-            severity = data.severity;
-            category = data.category;
+    for (const [ruleName, rule] of Object.entries(builtinRules)) {
+        const defaultSeverity = rule.defaultSeverity;
+        const defaultValue = defaultSeverity === 'warning' ? false : rule.defaultValue ?? true;
+        const category = rule.meta?.category;
+        if (category) {
+            rules[ruleName] = {
+                defaultValue,
+                category,
+            };
         }
-        const defaultValue = severity === 'warning' ? false : (_d = json.definitions.value.default) !== null && _d !== void 0 ? _d : true;
-        rules[name] = {
-            defaultValue,
-            category,
-        };
-    }));
-    return rules;
-}
-exports.getDefaultRules = getDefaultRules;
-async function safeFetch(baseUrl, version, type = 'json') {
-    const url = baseUrl.replace('[VERSION]', `v${version}`);
-    const res = await (0, node_fetch_1.default)(url);
-    if (!res.ok) {
-        return safeFetch(baseUrl, '3.0.0', type);
-    }
-    if (type === 'json') {
-        return (await res.json());
     }
-    const md = await res.text();
-    const { data } = (0, gray_matter_1.default)(md);
-    return data;
-}
-/**
- * Fallback fetching until 3.0.x
- *
- * @param version
- * @param name
- * @returns
- */
-async function getCatAndSeverityFromLegacy(version, name) {
-    const data = await safeFetch(RULES_README_URL.replace('[NAME]', name), version, 'md');
-    return {
-        category: data.category,
-        severity: data.severity,
-    };
+    return rules;
 }

package/lib/cli/init/index.js

@@ -1,16 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialize = void 0;
-const tslib_1 = require("tslib");
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const util_1 = tslib_1.__importDefault(require("util"));
-const util_2 = require("../../util");
-const prompt_1 = require("../prompt");
-const create_config_1 = require("./create-config");
-const get_default_rules_1 = require("./get-default-rules");
-const install_module_1 = require("./install-module");
-const writeFile = util_1.default.promisify(fs_1.default.writeFile);
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { installModule, multiSelect, confirm, confirmSequence, header } from '@markuplint/cli-utils';
+import { createConfig, langs } from './create-config.js';
+import { getDefaultRules } from './get-default-rules.js';
+import { selectModules } from './select-modules.js';
 const ruleCategories = {
     validation: {
         message: 'Are you going to conformance check according to HTML standard?',
@@ -28,19 +21,20 @@ const ruleCategories = {
         message: 'Are you going to check for the code styles?',
     },
 };
-async function initialize() {
-    (0, util_2.write)((0, util_2.head)('Initialization'));
-    util_2.write.break();
-    const selectedLangs = await (0, prompt_1.multiSelect)({
+export async function initialize() {
+    process.stdout.write(header('Initialization'));
+    process.stdout.write('\n');
+    process.stdout.write('\n');
+    const selectedLangs = await multiSelect({
         message: 'Which do you use template engines?',
-        choices: Object.entries(create_config_1.langs).map(([key, name]) => ({ name, value: key })),
+        choices: Object.entries(langs).map(([key, name]) => ({ name, value: key })),
     });
-    const autoInstall = await (0, prompt_1.confirm)('May I install them automatically?');
-    const customize = await (0, prompt_1.confirm)('Do you customize rules?');
+    const autoInstall = await confirm('May I install them automatically?');
+    const customize = await confirm('Do you customize rules?');
     let ruleSettingMode = 'none';
     if (customize) {
         const categories = Object.keys(ruleCategories);
-        const selectedCategories = await (0, prompt_1.confirmSequence)(categories.map(catName => {
+        const selectedCategories = await confirmSequence(categories.map(catName => {
             const cat = ruleCategories[catName];
             return {
                 message: cat.message,
@@ -51,33 +45,30 @@ async function initialize() {
             .map(([name, enabled]) => (enabled ? name : ''))
             .filter((name) => !!name);
     }
-    else if (await (0, prompt_1.confirm)('Does it import the recommended config?')) {
+    else if (await confirm('Does it import the recommended config?')) {
         ruleSettingMode = 'recommended';
     }
     let defaultRules = {};
     if (ruleSettingMode !== 'recommended') {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const rulesVersion = require('../../../package.json').version;
-        defaultRules = await (0, get_default_rules_1.getDefaultRules)(rulesVersion);
+        defaultRules = getDefaultRules();
     }
-    const config = (0, create_config_1.createConfig)(selectedLangs, ruleSettingMode, defaultRules);
-    const filePath = path_1.default.resolve(process.cwd(), '.markuplintrc');
-    await writeFile(filePath, JSON.stringify(config, null, 2), { encoding: 'utf-8' });
-    (0, util_2.write)(`✨Created: ${filePath}`);
+    const config = createConfig(selectedLangs, ruleSettingMode, defaultRules);
+    const filePath = path.resolve(process.cwd(), '.markuplintrc');
+    await fs.writeFile(filePath, JSON.stringify(config, null, 2), { encoding: 'utf8' });
+    process.stdout.write(`✨Created: ${filePath}\n`);
     if (autoInstall) {
-        (0, util_2.write)('Install automatically');
-        const modules = (0, install_module_1.selectModules)(selectedLangs);
-        const result = await (0, install_module_1.installModule)(modules, true).catch(e => new Error(e));
+        process.stdout.write('Install automatically\n');
+        const modules = selectModules(selectedLangs);
+        const result = await installModule(modules, true).catch(error_ => new Error(error_));
         if (result instanceof Error) {
-            util_2.error.exit();
-            return;
+            // eslint-disable-next-line unicorn/no-process-exit
+            process.exit(1);
         }
         if (result.alreadyExists) {
-            (0, util_2.write)('Modules are installed already.');
+            process.stdout.write('Modules are installed already.\n');
         }
         else {
-            (0, util_2.write)('✨ Success');
+            process.stdout.write('✨ Success\n');
         }
     }
 }
-exports.initialize = initialize;

package/lib/cli/init/select-modules.d.ts

@@ -0,0 +1,2 @@
+import type { Langs } from './types.js';
+export declare function selectModules(selectedLangs: readonly Langs[]): string[];

package/lib/cli/init/select-modules.js

@@ -0,0 +1,10 @@
+export function selectModules(selectedLangs) {
+    const modules = ['markuplint', ...selectedLangs.map(lang => `@markuplint/${lang}-parser`)];
+    if (selectedLangs.includes('vue')) {
+        modules.push('@markuplint/vue-spec');
+    }
+    if (selectedLangs.includes('jsx')) {
+        modules.push('@markuplint/react-spec');
+    }
+    return modules;
+}

package/lib/cli/init/types.d.ts

@@ -1,20 +1,9 @@
-export type Langs =
-	| 'jsx'
-	| 'vue'
-	| 'svelte'
-	| 'astro'
-	| 'pug'
-	| 'php'
-	| 'smarty'
-	| 'erb'
-	| 'ejs'
-	| 'mustache'
-	| 'nunjucks'
-	| 'liquid';
+import type { RuleConfigValue } from '@markuplint/ml-config';
+export type Langs = 'jsx' | 'vue' | 'svelte' | 'sveltekit' | 'astro' | 'pug' | 'php' | 'smarty' | 'erb' | 'ejs' | 'mustache' | 'nunjucks' | 'liquid';
 export type Category = 'validation' | 'a11y' | 'naming-convention' | 'style' | 'maintainability';
 export type RuleSettingMode = readonly Category[] | 'recommended' | 'none';
 export type DefaultRules = Readonly<Record<string, Rule>>;
 export type Rule = {
-	readonly category: Category;
-	readonly defaultValue: boolean | string | number;
+    readonly category: Category;
+    readonly defaultValue: RuleConfigValue;
 };

package/lib/cli/init/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/cli/output.d.ts

@@ -1,3 +1,3 @@
-import type { CLIOptions } from './bootstrap';
-import type { MLResultInfo } from '../types';
+import type { CLIOptions } from './bootstrap.js';
+import type { MLResultInfo } from '../types.js';
 export declare function output(results: MLResultInfo, options: CLIOptions): void;

package/lib/cli/output.js

@@ -1,34 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.output = void 0;
-const tslib_1 = require("tslib");
-const strip_ansi_1 = tslib_1.__importDefault(require("strip-ansi"));
-const reporter_1 = require("../reporter");
-function output(results, options) {
-    var _a;
-    const format = (_a = options.format) !== null && _a !== void 0 ? _a : 'Standard';
+import stripAnsi from 'strip-ansi';
+import { simpleReporter, standardReporter, githubReporter } from '../reporter/index.js';
+export function output(results, options) {
+    const format = options.format ?? 'Standard';
     let out;
     switch (format.toLowerCase()) {
         case 'json': {
             return;
         }
         case 'simple': {
-            out = (0, reporter_1.simpleReporter)(results, options);
+            out = simpleReporter(results, options);
             break;
         }
         case 'github': {
-            out = (0, reporter_1.githubReporter)(results);
+            out = githubReporter(results);
             break;
         }
         default: {
-            out = (0, reporter_1.standardReporter)(results, options);
+            out = standardReporter(results, options);
         }
     }
     if (out.length === 0) {
         return;
     }
     let msg = `${out.join('\n')}\n`;
-    msg = options.color ? msg : (0, strip_ansi_1.default)(msg);
+    msg = options.color ? msg : stripAnsi(msg);
     // If it has errors, Write to `stderr` and failure and exit.
     if (results.violations.length > 0) {
         process.stderr.write(msg);
@@ -37,4 +32,3 @@ function output(results, options) {
     }
     process.stdout.write(msg);
 }
-exports.output = output;

package/lib/cli/search/index.d.ts

@@ -1,2 +1,2 @@
-import type { CLIOptions } from '../bootstrap';
-export default function (files: readonly string[], options: CLIOptions, selectors: string): Promise<void>;
+import type { CLIOptions } from '../bootstrap.js';
+export declare function search(files: readonly string[], options: CLIOptions, selectors: string): Promise<void>;

package/lib/cli/search/index.js

@@ -1,25 +1,22 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ml_core_1 = require("@markuplint/ml-core");
-const command_1 = require("../command");
-async function default_1(files, options, selectors) {
+import { createRule, MLRule } from '@markuplint/ml-core';
+import { command } from '../command.js';
+export async function search(files, options, selectors) {
     const name = '__CLI_SEARCH__';
     const locations = [];
-    await (0, command_1.command)(files, {
+    await command(files, {
         ...options,
         problemOnly: true,
         importPresetRules: false,
     }, {
         rules: [
-            new ml_core_1.MLRule({
+            new MLRule({
                 name,
-                ...(0, ml_core_1.createRule)({
+                ...createRule({
                     verify({ document }) {
                         const nodes = document.querySelectorAll(selectors);
-                        locations.push(...Array.from(nodes).map(node => {
-                            var _a;
+                        locations.push(...[...nodes].map(node => {
                             return {
-                                file: (_a = document.filename) !== null && _a !== void 0 ? _a : '_NO_FILE_',
+                                file: document.filename ?? '_NO_FILE_',
                                 line: node.startLine,
                                 col: node.startCol,
                             };
@@ -34,8 +31,7 @@ async function default_1(files, options, selectors) {
             },
         },
     });
-    locations.forEach(loc => {
+    for (const loc of locations) {
         process.stdout.write(`${loc.file}:${loc.line}:${loc.col}\n`);
-    });
+    }
 }
-exports.default = default_1;

package/lib/debug.js

@@ -1,15 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.verbosely = exports.log = void 0;
-const tslib_1 = require("tslib");
-const ml_core_1 = require("@markuplint/ml-core");
-const debug_1 = tslib_1.__importDefault(require("debug"));
-exports.log = (0, debug_1.default)('markuplint-cli');
-function verbosely() {
-    if (!exports.log.enabled) {
-        debug_1.default.enable(`${exports.log.namespace}*`);
-        (0, exports.log)(`Debug enable: ${exports.log.namespace}`);
+import { enableDebug } from '@markuplint/ml-core';
+import debug from 'debug';
+export const log = debug('markuplint-cli');
+export function verbosely() {
+    if (!log.enabled) {
+        const namespace = `${log.namespace}*,ml-*`;
+        debug.enable(namespace);
+        log(`[Debug] Enable: "${namespace}"`);
     }
-    (0, ml_core_1.enableDebug)();
+    enableDebug();
 }
-exports.verbosely = verbosely;

package/lib/get-json-module.d.ts

@@ -0,0 +1 @@
+export declare function getJsonModule<T extends {}>(modulePath: string): T | null;

package/lib/get-json-module.js

@@ -0,0 +1,10 @@
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+export function getJsonModule(modulePath) {
+    try {
+        return require(modulePath);
+    }
+    catch {
+        return null;
+    }
+}

package/lib/global-settings.d.ts

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

package/lib/global-settings.js

@@ -1,15 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGlobal = exports.setGlobal = void 0;
 let globalSettings = {};
-function setGlobal(settings) {
+export function setGlobal(settings) {
     globalSettings = {
         ...globalSettings,
         ...settings,
     };
 }
-exports.setGlobal = setGlobal;
-function getGlobal() {
+export function getGlobal() {
     return globalSettings;
 }
-exports.getGlobal = getGlobal;

package/lib/i18n.js

@@ -1,26 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.i18n = void 0;
-const tslib_1 = require("tslib");
-const os_locale_1 = tslib_1.__importDefault(require("os-locale"));
+import { osLocale } from 'os-locale';
+import { getJsonModule } from './get-json-module.js';
 let cachedLocale = null;
 async function getLocale() {
     if (!cachedLocale) {
-        cachedLocale = await (0, os_locale_1.default)({ spawn: true });
+        cachedLocale = await osLocale({ spawn: true });
     }
     return cachedLocale;
 }
-async function i18n(locale) {
-    var _a, _b;
-    locale = (_a = locale !== null && locale !== void 0 ? locale : (await getLocale())) !== null && _a !== void 0 ? _a : 'en';
-    const langCode = (_b = locale.split('-')[0]) !== null && _b !== void 0 ? _b : locale;
-    const loadLocaleSet = await Promise.resolve(`${`@markuplint/i18n/locales/${langCode}`}`).then(s => tslib_1.__importStar(require(s))).catch(() => null);
-    const localeSet = loadLocaleSet !== null && loadLocaleSet !== void 0 ? loadLocaleSet : 
-    // @ts-ignore
-    (await Promise.resolve().then(() => tslib_1.__importStar(require('@markuplint/i18n/locales/en'))));
+export async function i18n(locale) {
+    locale = locale ?? (await getLocale()) ?? 'en';
+    const langCode = locale.split('-')[0] ?? locale;
+    const loadLocaleSet = getJsonModule(`@markuplint/i18n/locales/${langCode}.json`);
+    const localeSet = loadLocaleSet ?? getJsonModule('@markuplint/i18n/locales/en.json');
     return {
         ...localeSet,
         locale: loadLocaleSet ? langCode : 'en',
     };
 }
-exports.i18n = i18n;

package/lib/index.d.ts

@@ -1,8 +1,10 @@
-export { MLEngine } from './api';
-export * from './i18n';
-export * from './testing-tool';
-export * from './types';
+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';
+export { version } from './version.js';
 /**
  * @deprecated
  */
-export * from './v1';
+export * from './v1.js';

package/lib/index.js

@@ -1,13 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MLEngine = void 0;
-const tslib_1 = require("tslib");
-var api_1 = require("./api");
-Object.defineProperty(exports, "MLEngine", { enumerable: true, get: function () { return api_1.MLEngine; } });
-tslib_1.__exportStar(require("./i18n"), exports);
-tslib_1.__exportStar(require("./testing-tool"), exports);
-tslib_1.__exportStar(require("./types"), exports);
+export { MLEngine } from './api/index.js';
+export * from './i18n.js';
+export * from './testing-tool/index.js';
+export * from './types.js';
+export { version } from './version.js';
 /**
  * @deprecated
  */
-tslib_1.__exportStar(require("./v1"), exports);
+export * from './v1.js';

package/lib/reporter/github-reporter.d.ts

@@ -1,2 +1,2 @@
-import type { MLResultInfo } from '../types';
+import type { MLResultInfo } from '../types.js';
 export declare function githubReporter(results: MLResultInfo): string[];

package/lib/reporter/github-reporter.js

@@ -1,23 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.githubReporter = void 0;
-const util_1 = require("../util");
-function githubReporter(results) {
+import { messageToString } from '@markuplint/cli-utils';
+export function githubReporter(results) {
     const out = [];
     for (const violation of results.violations) {
         const command = severityToCommand(violation.severity);
-        const meg = (0, util_1.messageToString)(violation.message, violation.reason);
+        const meg = messageToString(violation.message, violation.reason);
         out.push(`::${command} file=${results.filePath},line=${violation.line},col=${violation.col}::${meg} (${violation.ruleId})`);
     }
     return out;
 }
-exports.githubReporter = githubReporter;
 function severityToCommand(severity) {
     switch (severity) {
-        case 'info':
+        case 'info': {
             return 'notice';
+        }
         case 'error':
-        case 'warning':
+        case 'warning': {
             return severity;
+        }
     }
 }

package/lib/reporter/index.d.ts

@@ -1,3 +1,3 @@
-export * from './standard-reporter';
-export * from './simple-reporter';
-export * from './github-reporter';
+export * from './standard-reporter.js';
+export * from './simple-reporter.js';
+export * from './github-reporter.js';

package/lib/reporter/index.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./standard-reporter"), exports);
-tslib_1.__exportStar(require("./simple-reporter"), exports);
-tslib_1.__exportStar(require("./github-reporter"), exports);
+export * from './standard-reporter.js';
+export * from './simple-reporter.js';
+export * from './github-reporter.js';

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

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