markuplint 3.0.0-dev.54 → 3.0.0-dev.96

package/README.md

@@ -121,6 +121,7 @@ Need [Sponsors❤️‍🔥](https://github.com/sponsors/markuplint)
 
 [<img width="36" src="https://avatars.githubusercontent.com/u/91733847" alt="Tokitake" />](https://github.com/Tokitake)
 [<img width="36" src="https://avatars.githubusercontent.com/u/1996642" alt="yamanoku" />](https://github.com/yamanoku)
+[<img width="36" src="https://avatars.githubusercontent.com/u/6581173" alt="miita" />](https://github.com/mikimhk)
 
 ## Thanks
 

package/lib/cli/init/create-config.d.ts

@@ -0,0 +1,4 @@
+import type { DefaultRules, Langs, RuleSettingMode } from './types';
+import type { Config } from '@markuplint/ml-config';
+export declare const langs: Record<Langs, string>;
+export declare function createConfig(langs: Langs[], mode: RuleSettingMode, defaultRules: DefaultRules): Config;

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

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConfig = exports.langs = void 0;
+const ml_config_1 = require("@markuplint/ml-config");
+const extRExp = {
+    jsx: '\\.[jt]sx?$',
+    vue: '\\.vue$',
+    svelte: '\\.svelte$',
+    astro: '\\.astro$',
+    pug: '\\.pug$',
+    php: '\\.php$',
+    smarty: '\\.tpl$',
+    erb: '\\.erb$',
+    ejs: '\\.ejs$',
+    mustache: '\\.(mustache|hbs)$',
+    nunjucks: '\\.nunjucks$',
+    liquid: '\\.liquid$',
+};
+exports.langs = {
+    jsx: 'React (JSX)',
+    vue: 'Vue',
+    svelte: 'Svelte',
+    astro: 'Astro',
+    pug: 'Pug',
+    php: 'PHP',
+    smarty: 'Smarty',
+    erb: 'eRuby',
+    ejs: 'EJS',
+    mustache: 'Mustache/Handlebars',
+    nunjucks: 'Nunjucks',
+    liquid: 'liquid (Shopify)',
+};
+function createConfig(langs, mode, defaultRules) {
+    let config = {};
+    for (const lang of langs) {
+        config.parser = config.parser || {};
+        const ext = extRExp[lang];
+        if (!ext) {
+            continue;
+        }
+        config.parser[ext] = `@markuplint/${lang}-parser`;
+        if (lang === 'vue') {
+            config = (0, ml_config_1.mergeConfig)(config, {
+                specs: {
+                    '\\.vue$': '@markuplint/vue-spec',
+                },
+            });
+        }
+        if (lang === 'jsx') {
+            config = (0, ml_config_1.mergeConfig)(config, {
+                specs: {
+                    '\\.[jt]sx?$': '@markuplint/react-spec',
+                },
+            });
+        }
+    }
+    if (Array.isArray(mode)) {
+        const ruleNames = Object.keys(defaultRules);
+        for (const ruleName of ruleNames) {
+            const rule = defaultRules[ruleName];
+            if (!rule) {
+                continue;
+            }
+            if (mode.includes(rule.category)) {
+                if (!config.rules) {
+                    config.rules = {};
+                }
+                config.rules[ruleName] = rule.defaultValue;
+            }
+        }
+    }
+    else if (mode === '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.defaultValue;
+        }
+    }
+    return config;
+}
+exports.createConfig = createConfig;

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

@@ -0,0 +1,2 @@
+import type { DefaultRules } from './types';
+export declare function getDefaultRules(version: string): Promise<DefaultRules>;

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

@@ -0,0 +1,57 @@
+"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);
+    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;
+        }
+        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,
+    };
+}

package/lib/cli/init/index.js

@@ -5,9 +5,10 @@ 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 ml_config_1 = require("@markuplint/ml-config");
 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);
 const ruleCategories = {
@@ -15,242 +16,57 @@ const ruleCategories = {
         message: 'Are you going to conformance check according to HTML standard?',
     },
     a11y: {
-        message: 'Are you going to do with accessibility better practices?',
+        message: 'Do you want high accessibility?',
     },
     'naming-convention': {
         message: 'Are you going to set the convention about naming?',
     },
+    maintainability: {
+        message: 'Do you want high maintainability?',
+    },
     style: {
         message: 'Are you going to check for the code styles?',
     },
 };
-const defaultRules = {
-    'attr-duplication': {
-        category: 'validation',
-        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: 'style',
-        default: true,
-    },
-    'class-naming': {
-        category: 'naming-convention',
-        default: false,
-        recommendedValue: '/.+/',
-    },
-    'deprecated-attr': {
-        category: 'validation',
-        default: true,
-    },
-    'deprecated-element': {
-        category: 'validation',
-        default: true,
-    },
-    'disallowed-element': {
-        category: 'validation',
-        default: false,
-    },
-    doctype: {
-        category: 'validation',
-        default: true,
-    },
-    'end-tag': {
-        category: 'style',
-        default: true,
-    },
-    'id-duplication': {
-        category: 'validation',
-        default: true,
-    },
-    'ineffective-attr': {
-        category: 'validation',
-        default: true,
-    },
-    'invalid-attr': {
-        category: 'validation',
-        default: true,
-    },
-    'label-has-control': {
-        category: 'a11y',
-        default: false,
-    },
-    'landmark-roles': {
-        category: 'a11y',
-        default: true,
-    },
-    'no-boolean-attr-value': {
-        category: 'style',
-        default: true,
-    },
-    'no-default-value': {
-        category: 'style',
-        default: true,
-    },
-    'no-empty-palpable-content': {
-        category: 'validation',
-        default: false,
-    },
-    'no-hard-code-id': {
-        category: 'style',
-        default: true,
-    },
-    'no-refer-to-non-existent-id': {
-        category: 'a11y',
-        default: true,
-    },
-    'no-use-event-handler-attr': {
-        category: 'style',
-        default: true,
-    },
-    'permitted-contents': {
-        category: 'validation',
-        default: true,
-    },
-    'required-attr': {
-        category: 'validation',
-        default: true,
-    },
-    'required-element': {
-        category: 'validation',
-        default: true,
-    },
-    'required-h1': {
-        category: 'a11y',
-        default: true,
-    },
-    'use-list': {
-        category: 'a11y',
-        default: false,
-    },
-    'wai-aria': {
-        category: 'a11y',
-        default: true,
-    },
-};
-const extRExp = {
-    jsx: '\\.[jt]sx?$',
-    vue: '\\.vue$',
-    svelte: '\\.svelte$',
-    astro: '\\.astro',
-    pug: '\\.pug$',
-    php: '\\.php$',
-    erb: '\\.erb$',
-    ejs: '\\.ejs$',
-    mustache: '\\.(mustache|handlebars)$',
-    nunjucks: '\\.nunjucks$',
-    liquid: '\\.liquid$',
-};
 async function initialize() {
-    let config = {};
     (0, util_2.write)((0, util_2.head)('Initialization'));
     util_2.write.break();
-    const langs = await (0, prompt_1.multiSelect)({
+    const selectedLangs = 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: 'Smarty', value: 'smarty' },
-            { name: 'eRuby', value: 'erb' },
-            { name: 'EJS', value: 'ejs' },
-            { name: 'Mustache/Handlebars', value: 'mustache' },
-            { name: 'Nunjucks', value: 'nunjucks' },
-            { name: 'liquid (Shopify)', value: 'liquid' },
-        ],
+        choices: Object.entries(create_config_1.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?');
-    for (const lang of langs) {
-        config.parser = config.parser || {};
-        // @ts-ignore
-        const ext = extRExp[lang];
-        if (!ext) {
-            continue;
-        }
-        config.parser[ext] = `@markuplint/${lang}-parser`;
-        if (lang === 'vue') {
-            config = (0, ml_config_1.mergeConfig)(config, {
-                specs: {
-                    '\\.vue$': '@markuplint/vue-spec',
-                },
-            });
-        }
-        if (lang === 'jsx') {
-            config = (0, ml_config_1.mergeConfig)(config, {
-                specs: {
-                    '\\.[jt]sx?$': '@markuplint/react-spec',
-                },
-            });
-        }
-    }
+    let ruleSettingMode = 'none';
     if (customize) {
-        const ruleNames = Object.keys(defaultRules);
         const categories = Object.keys(ruleCategories);
-        const res = await (0, prompt_1.confirmSequence)(categories.map(catName => {
+        const selectedCategories = await (0, prompt_1.confirmSequence)(categories.map(catName => {
             const cat = ruleCategories[catName];
             return {
                 message: cat.message,
                 name: catName,
             };
         }));
-        for (const ruleName of ruleNames) {
-            const rule = defaultRules[ruleName];
-            if (!rule) {
-                continue;
-            }
-            if (res[rule.category]) {
-                if (!config.rules) {
-                    config.rules = {};
-                }
-                config.rules[ruleName] = rule.recommendedValue || true;
-            }
-        }
+        ruleSettingMode = Object.entries(selectedCategories)
+            .map(([name, enabled]) => (enabled ? name : ''))
+            .filter((name) => !!name);
     }
-    else {
-        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;
-            }
-        }
+    else if (await (0, prompt_1.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);
     }
+    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}`);
     if (autoInstall) {
         (0, util_2.write)('Install automatically');
-        const modules = ['markuplint', ...langs.map(lang => `@markuplint/${lang}-parser`)];
-        if (langs.includes('vue')) {
-            modules.push('@markuplint/vue-spec');
-        }
-        if (langs.includes('jsx')) {
-            modules.push('@markuplint/react-spec');
-        }
+        const modules = (0, install_module_1.selectModules)(selectedLangs);
         const result = await (0, install_module_1.installModule)(modules, true).catch(e => new Error(e));
         if (result instanceof Error) {
             util_2.error.exit();

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

@@ -1,5 +1,7 @@
+import type { Langs } from './types';
 export type InstallModuleResult = {
     success: boolean;
     alreadyExists: boolean;
 };
+export declare function selectModules(selectedLangs: Langs[]): string[];
 export declare function installModule(module: string[], dev?: boolean): Promise<InstallModuleResult>;

package/lib/cli/init/install-module.js

@@ -1,12 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.installModule = void 0;
+exports.installModule = exports.selectModules = void 0;
 const tslib_1 = require("tslib");
 const child_process_1 = require("child_process");
 const cli_color_1 = tslib_1.__importDefault(require("cli-color"));
 // @ts-ignore
 const detect_installed_1 = tslib_1.__importDefault(require("detect-installed"));
 const has_yarn_1 = tslib_1.__importDefault(require("has-yarn"));
+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;
+}
+exports.selectModules = selectModules;
 async function installModule(module, dev = false) {
     module = module.map(m => m.trim());
     const uninstallMods = [];

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

@@ -0,0 +1,8 @@
+export type Langs = 'jsx' | 'vue' | 'svelte' | 'astro' | 'pug' | 'php' | 'smarty' | 'erb' | 'ejs' | 'mustache' | 'nunjucks' | 'liquid';
+export type Category = 'validation' | 'a11y' | 'naming-convention' | 'style' | 'maintainability';
+export type RuleSettingMode = Category[] | 'recommended' | 'none';
+export type DefaultRules = Record<string, Rule>;
+export type Rule = {
+    category: Category;
+    defaultValue: boolean | string | number;
+};

package/lib/cli/init/types.js

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

package/lib/i18n.js

@@ -14,12 +14,13 @@ async function getLocale() {
 async function i18n(locale) {
     locale = locale || (await getLocale()) || 'en';
     const langCode = locale.split('-')[0];
-    const localeSet = langCode
-        ? await (_a = `@markuplint/i18n/locales/${langCode}`, Promise.resolve().then(() => tslib_1.__importStar(require(_a)))).catch(() => null)
-        : null;
+    const loadLocaleSet = await (_a = `@markuplint/i18n/locales/${langCode}`, Promise.resolve().then(() => tslib_1.__importStar(require(_a)))).catch(() => null);
+    const localeSet = loadLocaleSet ||
+        // @ts-ignore
+        (await Promise.resolve().then(() => tslib_1.__importStar(require('@markuplint/i18n/locales/en'))));
     return {
-        locale: langCode,
         ...localeSet,
+        locale: loadLocaleSet ? langCode : 'en',
     };
 }
 exports.i18n = i18n;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "markuplint",
-	"version": "3.0.0-dev.54+329808d5",
+	"version": "3.0.0-dev.96+3b9f1720",
 	"description": "A linter for all markup developers",
 	"author": "Yusuke Hirao",
 	"license": "MIT",
@@ -8,6 +8,9 @@
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
+	"typedoc": {
+		"entryPoint": "./src/index.ts"
+	},
 	"bin": {
 		"markuplint": "bin/markuplint"
 	},
@@ -25,16 +28,16 @@
 		"execa": "5"
 	},
 	"dependencies": {
-		"@markuplint/create-rule-helper": "3.0.0-dev.54+329808d5",
-		"@markuplint/file-resolver": "3.0.0-dev.54+329808d5",
-		"@markuplint/html-parser": "3.0.0-dev.54+329808d5",
-		"@markuplint/html-spec": "3.0.0-dev.54+329808d5",
-		"@markuplint/i18n": "3.0.0-dev.54+329808d5",
-		"@markuplint/ml-ast": "3.0.0-dev.54+329808d5",
-		"@markuplint/ml-config": "3.0.0-dev.54+329808d5",
-		"@markuplint/ml-core": "3.0.0-dev.54+329808d5",
-		"@markuplint/ml-spec": "3.0.0-dev.54+329808d5",
-		"@markuplint/rules": "3.0.0-dev.54+329808d5",
+		"@markuplint/create-rule-helper": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/file-resolver": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/html-parser": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/html-spec": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/i18n": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/ml-ast": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/ml-config": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/ml-core": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/ml-spec": "3.0.0-dev.96+3b9f1720",
+		"@markuplint/rules": "3.0.0-dev.96+3b9f1720",
 		"chokidar": "^3.5.3",
 		"cli-color": "^2.0.3",
 		"debug": "^4.3.4",
@@ -42,13 +45,15 @@
 		"eastasianwidth": "^0.2.0",
 		"enquirer": "^2.3.6",
 		"get-stdin": "8",
+		"gray-matter": "^4.0.3",
 		"has-yarn": "2",
 		"meow": "9",
+		"node-fetch": "2",
 		"os-locale": "5",
 		"strict-event-emitter": "^0.2.8",
 		"strip-ansi": "6",
 		"tslib": "^2.4.1",
 		"uuid": "^9.0.0"
 	},
-	"gitHead": "329808d50ff8875e24031f692a0504d00b72c4f8"
+	"gitHead": "3b9f17205d7754b29edf790bdbbf5e4931ba27a2"
 }